Docs
Add Event
POST /Organizations/{organizationId}/events
POST
/Organizations/{organizationId}/eventsRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Creates a new event within the organization. All required custom event attributes (defined on the organization) must be provided. A default collaborator is created using defaultCollaboratorName, and the authenticated user is assigned EventAdmin permission.
Optionally, a template can be applied via templateId to pre-populate the event with collaborators, areas, activities, tasks, advances, and other structure. When using a template, supply any required template input values in templateInputs.
Returns 201 Created with the new event ID.
Requires OrganizationBasicAccess permission.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| organizationId | Guid | Required | The organization to create the event under. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Display name for the event. |
| licenseId | Guid | Required | ID of the license to assign to the event. Must not be empty. |
| defaultCollaboratorName | string | Required | Name for the default collaborator created with the event. |
| templateId | Guid? | Optional | ID of an event template to apply, or `null` for a blank event. |
| templateInputs | Dictionary<Guid, string> | Optional | Key-value pairs of template input IDs to values. Required when using a template with defined inputs. |
| attributes | Attribute[] | Optional | Custom attribute values. All required attributes must be supplied. |
Attribute
| Field | Type | Required | Description |
|---|---|---|---|
| attributeId | Guid | Required | The attribute definition ID. |
| value | string | Required | The value to set for this attribute. |
Response
| Field | Type | Description |
|---|---|---|
| eventId | Guid | ID of the newly created event. |