Appointment types

Before you can set up appointment reminders or messages, you must create an appointment type. Make the following calls to the Appointment Reminders API for appointment types:

Authentication

Note: Legacy APIs and the APIs outlined in the Attentive API section need separate tokens. Contact legacyapi@attentivemobile.com for a legacy API token.

You must include the following headers in your API call:

Headers

Header name Description Value Required
Authorization You must provide an access token. Contact legacyapi@attentivemobile.com for this token. Bearer <token> Required
Content-type The format of returned data. application/json Required

Create an appointment type

Make a call to this endpoint to create a new appointment.

URL

POST https://tactical-client-api.attentivemobile.com/events/types

Parameters

Parameter Description Example Type Required
uuid This is the unique identifier for the appointment type. This is automatically generated when you create an appointment. 1a2b3c4d5e6f7g8h9i0j string n/a
type This is the name of the company appointment. ONLINE_CONCERT string Required

Sample JSON request

curl 'https://tactical-client-api.attentivemobile.com/events/types \
-X POST \
-H 'Authorization: Bearer 1a2b3c4d5' \
-H 'Content-Type: application/json' \
-d '{"type": "ONLINE_CONCERT"}

Sample JSON response

A successful response contains a uuid to use to reference the specific appointment type.

{
    "uuid": "6c52d314-a3ca-4781-ba70-XXXXXXXXXXXX",
    "type": "ONLINE_CONCERT"
}

List an appointment type

Make a call to this endpoint to get the appointment type.

URL

GET https://tactical-client-api.attentivemobile.com/events/types/{uuid}

Parameters

Parameter Description Example Type Required
uuid This is the unique identifier for the appointment type. This is automatically generated when you create an appointment. 1a2b3c4d5e6f7g8h9i0j string Required
type This is the name of the company appointment. ONLINE_CONCERT string n/a

Sample JSON request

curl 'https://tactical-client-api.attentivemobile.com/events/types/6c52d314-a3ca-4781-ba70-XXXXXXXXXXXX \
-X GET \
-H 'Authorization: Bearer 1a2b3c4d5' \
-H 'Content-Type: application/json'

Sample JSON response

{
    "uuid": "6c52d314-a3ca-4781-ba70-XXXXXXXXXXXX",
    "type": "ONLINE_CONCERT"
}

Update an existing appointment type

Make a call to this endpoint to update an existing appointment.

URL

PUT https://tactical-client-api.attentivemobile.com/events/types/{uuid}

Parameters

Parameter Description Example Type Required
uuid This is the unique identifier for the appointment type. This is automatically generated when you create an appointment. 1a2b3c4d5e6f7g8h9i0j string Required
type This is the name of the company appointment. ONLINE_CONCERT string Required

Sample JSON request

curl 'https://tactical-client-api.attentivemobile.com/events/types/6c52d314-a3ca-4781-ba70-XXXXXXXXXXXX \
-X PUT \
-H 'Authorization: Bearer 1a2b3c4d5' \
-H 'Content-Type: application/json' \
-d '{"type": "WEBINAR"}

Sample JSON response

{
    "uuid": "6c52d314-a3ca-4781-ba70-XXXXXXXXXXXX",
    "type": "WEBINAR"
}

Status codes

The following table lists the returned HTTP status codes.

Code Description Notes
200 OK Request successful.
400 Bad request Data is improperly formatted.
401 Authorization error API key is incorrect.
404 Not Found Activity ID was not found for cancel, no-show, or update.
500 Internal Server Error This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.