Appointments

POST

/appointments

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201Success

application/json

Bodyapplication/json

🟠429429 Too many requests

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location '/appointments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "parentType": "estimate",
    "parentID": 62,
    "date": "2027-01-20",
    "hasTime": false,
    "timeSlot": "am",
    "startTime": "2026-10-13T20:22:56.904Z",
    "endTime": "2026-10-14T10:00:46.993Z",
    "description": "Defluo deleo xiphias nemo civis caecus. Crinis video utrum cattus votum aer adamo earum.",
    "notes": "in dolor ex eu elit",
    "assigneeUserID": 2,
    "isRecurringEvent": true,
    "recurringEventDetails": {
        "repeatType": "Weekly",
        "repeatsEvery": "1",
        "repeatsOn": "1,3,5",
        "occurrences": "5"
    }
}'

Response Example

201 - Example 1

{
    "type": "enim consequat",
    "description": "Cursim cedo patior celer decimus quam audax. Fugiat tabella cervus baiulus cras sonitus vis curatio tergum. Valens comparo tracto truculenter sit assumenda solus balbus utor nam. Tamdiu tardus turbo tricesimus thymbra thema quae. Tres doloremque capitulus undique decerno altus deludo copiose vilitas.",
    "notes": "do in nisi",
    "startDate": "2027-09-22",
    "endDate": "2027-03-06",
    "actualTime": 38145393,
    "isRecurringEvent": false,
    "repeatType": "Weekly",
    "repeatsEvery": "Month",
    "repeatsOn": "6",
    "occurrences": "in aute mollit tempor",
    "assignedTo": {
        "userID": 4,
        "name": "Merle Grimes",
        "profilePicture": "https://loremflickr.com/400/400?lock=4041998712380673"
    },
    "customerContactID": 81,
    "siteContactID": 63,
    "propertyID": 71,
    "engineerID": 42
}

Modified at 2026-10-30 07:25:25

Appointments feedbacks

Appointments