Docs

Update Assignment Flags

PUT /eventTypes/{typeId}/assignmentFlags

PUT/eventTypes/{typeId}/assignmentFlags

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Saves the flags for several placements across the whole event type in one request - attributes and roles together. Prefer this over the per-placement Update Assignment and Update Role Assignment calls.

Each write triggers a tracking-task reconcile that fans out over every event of the type and can take seconds. One request per toggle therefore overlaps its own predecessors and both sides insert the same tracking task, which is what wedged the attribute profile in production twice (#1734, #1777). This endpoint collapses a whole editing session into one SaveChanges and one reconcile.

Returns 200 OK. Only the listed assignments are touched; anything omitted is left alone.

Requires OrganizationAdmin permission.

Path Parameters

FieldTypeRequiredDescription
typeIdGuidRequiredThe event type that owns the placements.

Request Body

FieldTypeRequiredDescription
assignmentsarrayRequiredThe placements to update. An empty array is accepted and is a no-op apart from the reconcile.

assignments[]

FieldTypeRequiredDescription
sectionIdGuidRequiredThe section holding the placement.
kindstringRequired`Attribute` or `Role`. Anything else is rejected.
attributeIdGuidOptionalThe assigned library attribute.
roleDefinitionIdGuidOptionalThe assigned role definition.
isRequiredboolRequiredRequired on events of this type. Maps to `defaultIsRequired` for a role.
isTaskTrackedboolRequiredWhether the placement is tracked as a task. Maps to `defaultIsTaskTracked` for a role.
isTaskReviewRequiredboolRequiredWhether the tracked task requires review. Only meaningful when `isTaskTracked` is true.
indexintRequiredDisplay order within the section. Attributes and roles share one index sequence.

Errors

A validation failure rejects the whole batch - nothing is saved. Role failures report as role errors and attribute failures as attribute errors, matching the per-placement endpoints.