Docs
Add Activity Segment
POST /Activities/{activityId}/segments
POST
/Activities/{activityId}/segmentsRequired 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. |
Adds a new segment to the activity's run of show at the specified position. Other segments are reordered automatically.
Requires EventAdmin permission on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| activityId | Guid | Required | The ID of the activity to add a segment to. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| index | int | Required | Zero-based position in the run of show. |
| name | string | Required | Display name for the segment. |
| duration | int | Required | Duration of the segment in minutes. |
| color | string | Required | Display color for the segment (e.g., a hex color string). |
| properties | array | Optional | Values for the activity's configuration columns. See property object below. |
Property Object
| Field | Type | Required | Description |
|---|---|---|---|
| columnId | Guid | Required | The ID of the configuration column this value belongs to. |
| value | string | Required | The value for this column on this segment. |
Response
Returns 200 OK with no body on success.