Docs

Add Advance

POST /collaborators/{collaboratorId}/advances

POST/collaborators/{collaboratorId}/advances

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.

Creates a new advance form for a collaborator. Optionally seeds the advance from a template and/or scopes it to a specific area or activity.

Path Parameters

FieldTypeRequiredDescription
collaboratorIdGuidRequiredThe ID of the collaborator.

Request Body

FieldTypeRequiredDescription
namestringRequiredDisplay name for the advance.
templateIdGuid?OptionalID of an advance template to seed modules from. Omit or `null` to create blank.
areaIdGuid?OptionalScope this advance to a specific area. Omit or `null` for event-wide.
activityIdGuid?OptionalScope this advance to a specific activity. Omit or `null` for event-wide.

Response

Returns 201 Created with an empty body on success.