Docs
Add Activity
POST /Activities
POST
/ActivitiesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Creates a new activity (or timeframe) on the event. Participants are split into crew members (internal event users, identified by their crew ID) and collaborators. Areas attach the activity to one or more event areas.
Requires EventBasicAccess on the event. Creating a global activity (isGlobal: true) additionally requires EventActivitiesAdd. Attaching the activity to specific collaborators or areas requires activity-add permission on each of those collaborators/areas (or EventAdmin).
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | Required | Activity type. One of: `Activity`, `TimeFrame`. |
| name | string | Required | Display name for the activity. |
| description | string | Optional | Optional description. |
| startDateTime | DateTime | Required | Start time in UTC (ISO 8601). |
| endDateTime | DateTime | Required | End time in UTC (ISO 8601). |
| exactLocation | string | Optional | Specific location string (e.g., room name, stage). |
| isGlobal | bool | Required | `true` makes the activity visible to all event participants. Requires `EventActivitiesAdd`. |
| isAllDay | bool | Required | `true` for all-day activities. |
| recurrenceRules | object | Optional | Recurrence configuration. Omit or set to `null` for non-recurring activities. |
| areas | array | Optional | Array of area GUIDs to associate with this activity. |
| crewMembers | array | Optional | Crew member participants (internal event users). See participant object below. |
| collaborators | array | Optional | Collaborator participants. See participant object below. |
Participant Object
| Field | Type | Required | Description |
|---|---|---|---|
| id | Guid | Required | Crew ID (for `crewMembers`) or collaborator ID (for `collaborators`). |
| isRequired | bool | Required | Whether attendance is required. |
| role | string | Optional | Participant role. One of: `Organizer`, `Attendee`. Defaults to `Attendee` when omitted. |
Recurrence Rules Object
| Field | Type | Required | Description |
|---|---|---|---|
| frequency | string | Required | One of: `Daily`, `Weekly`, `Monthly`. |
| interval | int | Required | Number of frequency units between occurrences (must be > 0). |
| endDate | DateTime | Required | When the recurrence ends (must be in the future). |
| daysOfWeek | array | Required | Required when `frequency` is `Weekly`. Values: `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`. |
Response
Returns 201 Created with { "id": "<new-activity-id>" }.