Skip to main content
POST
/
appointments
Create Appointment
curl --request POST \
  --url https://crm.universal.rollout.com/api/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Rollout-Credential-Id: <api-key>' \
  --data '
{
  "personId": "<string>",
  "appointmentTypeId": "<string>",
  "title": "<string>",
  "location": "<string>",
  "userId": "<string>",
  "invitees": [
    {
      "userId": "<string>",
      "personId": "<string>"
    }
  ],
  "appointmentOutcomeId": "<string>",
  "outcomeReason": "<string>",
  "description": "<string>",
  "isAllDay": true,
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "personId": "<string>",
  "userId": "<string>",
  "createdById": "<string>",
  "updatedById": "<string>",
  "appointmentOutcomeId": "<string>",
  "appointmentTypeId": "<string>",
  "invitees": [
    {
      "userId": "<string>",
      "personId": "<string>"
    }
  ],
  "title": "<string>",
  "description": "<string>",
  "location": "<string>",
  "isAllDay": true,
  "type": "<string>",
  "outcome": "<string>",
  "outcomeReason": "<string>",
  "startsAt": "<string>",
  "endsAt": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "rolloutUpdated": "<string>",
  "originalIds": {},
  "original": {}
}

Authorizations

Authorization
string
header
required

Authorization JWT

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Body

application/json
personId
string
required
appointmentTypeId
string
required
title
string
required
location
string
required
userId
string
invitees
object[]
appointmentOutcomeId
string
outcomeReason
string
description
string
isAllDay
boolean
startsAt
endsAt

Response

Created

id
string
required
personId
string
required
userId
string
required
createdById
string
required
updatedById
string
required
appointmentOutcomeId
string
required
appointmentTypeId
string
required
invitees
object[]
required
title
string
required
description
string
required
location
string
required
isAllDay
boolean
required
type
string
required
outcome
string
required
outcomeReason
string
required
startsAt
string
required
endsAt
string
required
created
string
required
updated
string
required
rolloutUpdated
string
required
originalIds
object
required
original
object
required