Add Activity

post

https://api.joinplanbase.com/api/v1/activities

Add a new activity to the current user's organization. The activity should be an instance of an existing activity type and it may include attributes such as unique name, date, and associated roles or departments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The unique ID of the activity

activity_type_id

integer

required

The ID of the activity type

start

date-time

required

The start time (UTC) of the activity e.g 2023-07-27 06:30:00+00

end

date-time

required

The end time (UTC) of the activity e.g 2023-07-27 06:30:00+00

notes

Notes for the activity

recurrence_id

The recurrence ID for the activity

shift_ids

array | null

List of shift IDs to which the activity is joined

patient_ids

array | null

List of patient IDs linked to the activity

archived

Whether activity has been archived

recurrence_details

RecurrenceNew | null

The recurrence details for the activity

external_id

ID linking activity to external integrations, i.e. Healthie, etc

pattern_override_uuid

Slot uuid from the recurrence's pattern_overrides that produced this activity

Responses

200Successful Response

422Validation Error