Request an Appointment

POST /api/portal/appointment/create

This endpoint allows you to request a new appointment.

Note

Upon appointment creation, an email will be sent to the creator, all members, as well as any system admin with the “APPOINTMENT_REQUESTED” notification enabled.

Security

This endpoint requires authentication. You must include a valid API key in the request header. Permission(s) Required: IMPERSONATE_PORTAL_USER
You must also include these headers to identify the registered user making the request:

X-IMPERSONATED-USER-FIRST-NAME: <first-name>
X-IMPERSONATED-USER-LAST-NAME: <last-name>
X-IMPERSONATED-USER-EMAIL: <email>

Request Body

{
    "startTimestamp": timestamp,
    "hoursLength": number,
    "tools": string[],
    "members": Member[],
    "customFields": {
        "{field_id}": "{field_value}",
    },
}

startTimestamp

Unix Epoch format (millis). This is the start time of the appointment.

hoursLength

How many hours long this appointment is.

tools

Array of tools that are required for this appointment.
The possible values for this are defined in the system config.

members

Array of members emails in this appointment.
These users do not need to be registered users in the system, but if they are then their names will be displayed on the appointment details page.

customFields

Object of custom fields from the appointment request form and their responses.
The possible values for this are defined in the system config.

Response Body

{
    "id": string
}

id

UUID of the newly created appointment.