The Appointment Intent API is used to access, create, and modify the different appointment intent objects on your business' account.

On this page

Appointment Intent API Endpoints

Return to Top

These are the endpoints that are available under the /appointmentIntent path, which lists all the different notes you have added to clients and appointments to your business account.

Endpoint	Description
GET /appointmentIntent/{appointmentIntentId}	Returns the Appointment Intent object for the specified Appointment Intent ID.
GET /appointmentIntentList	Returns all Appointment Intents under your business' account.
GET /appointmentIntentList/{clientId}	Returns all Appointment Intents under your business' account that belong to the specified Client ID.
POST /appointmentIntent	Creates a new Appointment Intent object on your business' account. Request body/payload: Must pass an Appointment Intent object in the request body/payload. For these calls, you need to pass an Appointment Intent object with all required fields and any fields you want to set filled in the body of the payload. We have an example of an Appointment Intent object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
PUT /appointmentIntent/{appointmentIntentId}	Updates an existing Appointment Intent object on your business' account. Request body/payload: Must pass an Appointment Intent object in the request body/payload. For these calls, you need to pass an Appointment Intent object with all required fields and any fields you want to update filled in the body of the payload. We have an example of an Appointment Intent object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
DELETE /appointmentIntent/{appointmentIntentId}	Removes an Appointment Intent object from your business' account.

Appointment Intent API Parameters

Return to top

Parameter	Type	Endpoints to be used with	Description
active	boolean	GET /appointmentIntentList GET /appointmentIntentList/{clientId}	True or False value that limits the results to active appointment intents or not. If true (default), expired or inactive appointment intents will be excluded from the results.

Parameter

Type

Endpoints to be used with

Description

active

boolean

GET /appointmentIntentList

GET /appointmentIntentList/{clientId}

True or False value that limits the results to active appointment intents or not. If true (default), expired or inactive appointment intents will be excluded from the results.

Appointment Intent API Request Body/Payloads

Return to top

The objects below represent the minimum viable objects to pass that are needed to create or update an Appointment Intent object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.

POST /appointmentIntent

{
    "businessId": 43111,
    "clientId": 4761823,
    "description": "Test Description",
    "externalReferenceNumber": "Test1234",
    "startDate": 1670524480721,
    "endDate": 1670524480721,
	"expirationDate": 1670524480721,
	"booked": false
}

PUT /appointmentIntent

{
	"appointmentIntentId": 2,
    "businessId": 43111,
    "clientId": 4761823,
    "description": "Test Description",
    "externalReferenceNumber": "Test1234",
    "startDate": 1670524480721,
    "endDate": 1670524480721,
	"expirationDate": 1670524480721,
	"booked": false
}

Appointment Intent API Responses

Return to Top

GET /appointmentIntentList

[{
 	"appointmentIntentId": 2,
    "businessId": 43111,
    "clientId": 4761823,
    "description": "Test Description",
    "externalReferenceNumber": "Test1234",
    "startDate": 1670524480721,
    "endDate": 1670524480721,
	"expirationDate": 1670524480721,
	"active": true,
	"createdDate": 1541527537548,
    "createdUser": "JoeSchmo",
	"modifiedDate": null,
    "modifiedUser": null,
	"booked": false
}]

GET /appointmentIntentList/{clientId}

[{
 	"appointmentIntentId": 2,
    "businessId": 43111,
    "clientId": 4761823,
    "description": "Test Description",
    "externalReferenceNumber": "Test1234",
    "startDate": 1670524480721,
    "endDate": 1670524480721,
	"expirationDate": 1670524480721,
	"active": true,
	"createdDate": 1541527537548,
    "createdUser": "JoeSchmo",
	"modifiedDate": null,
    "modifiedUser": null,
	"booked": false
}]

POST /appointmentIntent

{
    "appointmentIntentId": 2,
    "businessId": 43111,
    "clientId": 4761823,
    "description": "Test Description",
    "externalReferenceNumber": "Test1234",
    "startDate": 1670524480721,
    "endDate": 1670524480721,
	"expirationDate": 1670524480721,
	"active": true,
	"createdDate": 1541527537548,
    "createdUser": "JoeSchmo",
	"modifiedDate": null,
    "modifiedUser": null,
	"booked": false
}

PUT /appointmentIntent

{
    "appointmentIntentId": 2,
    "businessId": 43111,
    "clientId": 4761823,
    "description": "Test Description",
    "externalReferenceNumber": "Test1234",
    "startDate": 1670524480721,
    "endDate": 1670524480721,
	"expirationDate": 1670524480721,
	"active": true,
	"createdDate": 1541527537548,
    "createdUser": "JoeSchmo",
	"modifiedDate": null,
    "modifiedUser": null,
	"booked": false
}

Appointment Intent Object Values

Return to Top

Property name	Type	Required	Description
appointmentIntentId	integer	Yes, on PUT calls	Provides unique numeric ID for the specified Appointment Intent.
businessId	integer	Yes	Provides unique numeric ID for the business the specified note belongs to.
clientId	integer	Yes	Provides unique numeric ID for the client that the specified Appointment Intent belongs to.
description	string		Provides a description of the Appointment Intent. Does display on the Client Scheduler.
externalReferenceNumber	string	Yes	Provides a reference to your external system. i.e. For a technical support meeting, this may be the technical request ticket id/number.
createdUser	string		Displays the username of user who created the specified Appointment Intent.
createdDate	integer		Displays as date the specified Appointment Intent was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
modifiedUser	string		Displays the username of user who last modified the specified Appointment Intent.
modifiedDate	integer		Displays as date the specified Appointment Intent was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
startDate	date	Yes	The date that the appointment intent can start being booked.
endDate	date	Yes	The last date that the appointment intent can be booked.
expirationDate	date		The date that the appointment intent expires and can no longer be booked.
active	boolean		Whether the appointment intent is active or not (also referred as "deleted")
booked	boolean		Whether the appointment intent has been booked or not.

Browser not supported