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 on the event. At least one participant with the Organizer role is required.
Requires EventAdmin permission on the event.
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` to make the activity visible to all event participants. Requires `EventAdmin` permission. |
| 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. |
| users | array | Optional | User participants. See participant object below. |
| collaborators | array | Optional | Collaborator participants. See participant object below. |
Participant Object
| Field | Type | Required | Description |
|---|---|---|---|
| id | Guid | Required | User or collaborator ID. |
| isRequired | bool | Required | Whether attendance is required. |
| role | string | Required | Participant role. One of: `Organizer`, `Attendee`. |
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 200 OK with no body on success.