Docs

Update Activity

PUT /Activities/{activityId}

PUT/Activities/{activityId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Replaces all fields of an existing activity. This is a full update — all fields must be provided. To update only the start and end times, use Update Activity Time instead.

Requires EventAdmin permission on the event, or the Organizer role on the activity.

Path Parameters

FieldTypeRequiredDescription
activityIdGuidRequiredThe ID of the activity to update.

Request Body

FieldTypeRequiredDescription
namestringRequiredDisplay name for the activity.
descriptionstringOptionalOptional description.
startDateTimeDateTimeRequiredStart time in UTC (ISO 8601).
endDateTimeDateTimeRequiredEnd time in UTC (ISO 8601).
exactLocationstringOptionalSpecific location string.
isGlobalboolRequired`true` to make the activity visible to all event participants. Requires `EventAdmin` permission.
isAllDayboolRequired`true` for all-day activities.
recurrenceRulesobjectOptionalRecurrence configuration. Omit or set to `null` for non-recurring activities.
areasarrayOptionalArray of area GUIDs to associate with this activity.
usersarrayOptionalUser participants. See participant object below.
collaboratorsarrayOptionalCollaborator participants. See participant object below.

Participant Object

FieldTypeRequiredDescription
idGuidRequiredUser or collaborator ID.
isRequiredboolRequiredWhether attendance is required.
rolestringRequiredOne of: `Organizer`, `Attendee`.

Recurrence Rules Object

FieldTypeRequiredDescription
frequencystringRequiredOne of: `Daily`, `Weekly`, `Monthly`.
intervalintRequiredNumber of frequency units between occurrences (must be > 0).
endDateDateTimeRequiredWhen the recurrence ends (must be in the future).
daysOfWeekarrayRequiredRequired when `frequency` is `Weekly`. Values: `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`.

Response

Returns 200 OK with no body on success.