Method: POST
Content-Type: application/json
Description
Creates an activity (appointment or task) in Centerbase and schedules existing items to it. Can be accomplished with other, more generic endpoints, but this simplifies the process.
Request
- session-id - The authorization session ID from the Login
- type - The type of activity to create ("TASK" or "APPOINTMENT"). If it is not specified it defaults to “APPOINTMENT”
- subject - The subject / name of the activity
- start-date - The start date for the activity
- end-date - The end date for the activity
- all-day-event - Specifies whether the activity will be an all day event / timeless.
- location - The location for the activity
- schedule-for - An array of IDs for items to show as scheduled with the activity
Request Body Sample
{
"session-id": "42ed2ab4-06ba-4803-8d0a-445af8bf3140",
"type": "APPOINTMENT",
"subject": "Planning meeting",
"start-date": "2025-03-10T18:30:00",
"end-date": "2025-03-10T18:45:00",
"all-day-event": false,
"location": "Conference room",
"schedule-for": [
"21430b59-906d-4ec1-88ea-6f127493b386",
"3f3f9adc-3ec2-453f-ba1a-a4b898ef5f24"
]
}
Response
- error-code - If an error occurred, the error code returned
- error-message - If an error occurred, the text of the error
- activity-id - The ID of the newly created activity