Scheduling

appointmentReminder

5 endpoints. Start at search to collect IDs, then resolve them through get.

Read · 3

search get by id

Write · 2

create update

Read operations

search/appointmentReminder/searchTry it

search appointmentReminder

Provide a set of parameters which will return a list of ids. There is no limit to the number of IDs this will return. You can then supply these ids to the get endpoint in order to retrieve bulk data. Every parameter available supports a simple value OR a powerful query object that gives you access to all basic comparators.

Example

dateAdded={"operator":">","value":"2016-01-01"}

Example

dateAdded={"operator\":\"BETWEEN\",\"value\":[\"2016-05-12\",\"2016-05-13\"]}

Available operators

><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINS

Each of the search endpoints allows for an optional parameter 'includeData'. When sent, the API will additionally send the resolved objects for the first 1000 IDs.

Keep in mind when using 'includeData' that if there are more than 1000 items an additional property '{entity}IDsNoDataExported' will specify the items that are not included in the resolved data array.

Parameters

reminderIDinteger

Primary Key

reminderIDsinteger

Alias of reminderID

appointmentReminderIDsinteger

Alias of reminderID

officeIDsinteger

Office the reminder belongs to

appointmentIDinteger

appointmentID the reminder pertains to

textstring

Text of the reminder

dateSentstring

Time the reminder was sent

emailSentstring

Time email was sent

Returns

appointmentReminderIDsarray

No description in the upstream reference.

Request

/appointmentReminder/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/appointmentReminder/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'reminderID=1' \
  --data-urlencode 'reminderIDs=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

0:10000

1:10007

2:10014

3:10021

4:10028

5:10035

6:10042

7:10049

]

count:8

}

get/appointmentReminder/getTry it

get appointmentReminder

Get Bulk data for appointmentReminder. Accepts an array of reminderIDs. Returns a max of 1000 records.

Parameters

reminderIDsarray

No description in the upstream reference.

Returns

reminderIDinteger

Primary Key

officeIDinteger

Office the reminder belongs to

appointmentIDinteger

appointmentID the reminder pertains to

textstring

Text of the reminder

dateSentstring

Time the reminder was sent

emailSentstring

Time email was sent

voiceSentstring

Time voice message was sent

statusinteger

-1 = don't send reminder, 0 = not sent, 1 = sent, 9 = confirmed

Request

/appointmentReminder/get

curl -X POST 'https://{subdomain}.pestroutes.com/api/appointmentReminder/get' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'reminderIDs=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

]

count:2

}

by id/appointmentReminder/{id}Try it

Fetch by id appointmentReminder

Get appointmentReminder data for single ID -- please provide a specific record ID in the URL structure.

Parameters

No parameters beyond authentication.

Returns

reminderIDinteger

Primary Key

officeIDinteger

Office the reminder belongs to

appointmentIDinteger

appointmentID the reminder pertains to

textstring

Text of the reminder

dateSentstring

Time the reminder was sent

emailSentstring

Time email was sent

voiceSentstring

Time voice message was sent

statusinteger

-1 = don't send reminder, 0 = not sent, 1 = sent, 9 = confirmed

Request

/appointmentReminder/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/appointmentReminder/{id}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

reminderID:3136

officeID:2602

appointmentID:7501

text:"sample-text"

dateSent:"2026-05-26 00:00:00"

emailSent:"dana.reyes@example.com"

voiceSent:"sample-voiceSent"

status:2

response:"sample-response"

responseTime:"2026-02-19 00:00:00"

sendTo:"sample-sendTo"

emailAddress:"dana.reyes@example.com"

voiceNumber:"sample-voiceNumber"

dateUpdated:"2026-04-07 00:00:00"

}

Write operations

create/appointmentReminder/createTry it

create appointmentReminder

create a customer

Parameters

voiceSentstring

Time voice message was sent status - integer - required -1 = don't send reminder, 0 = not sent(not allowed), 1 = sent, 6 = confirmed by office, 9 = confirmed via SMS

responsestring

Response text received

responseTimestring

Time response was received

sendTostring

Phone number for SMS

emailAddressstring

Email address the reminder was sent to

voiceNumberstring

Phone number for voice

Returns

Returns a success acknowledgement.

Request

/appointmentReminder/create

curl -X POST 'https://{subdomain}.pestroutes.com/api/appointmentReminder/create' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'voiceSent=value' \
  --data-urlencode 'response=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

appointmentReminderID:4821

}

update/appointmentReminder/updateTry it

update appointmentReminder

Update appointmentReminder details

Parameters

appointmentIDinteger

appointmentID the reminder pertains to

textstring

Text of the reminder

dateSentstring

Time the reminder was sent

emailSentstring

Time email was sent

voiceSentstring

Time voice message was sent

statusinteger

-1 = don't send reminder, 0 = not sent(not allowed), 1 = sent, 6 = confirmed by office, 9 = confirmed via SMS

responsestring

Response text received

responseTimestring

Time response was received

Returns

Returns a success acknowledgement.

Request

/appointmentReminder/update

curl -X POST 'https://{subdomain}.pestroutes.com/api/appointmentReminder/update' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'appointmentID=1' \
  --data-urlencode 'text=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

appointmentReminderID:4821

}