Docs

Set Collaborator Property Value

PUT /organizations/{organizationId}/collaborator-records/{recordId}/properties/{propertyId}

PUT/organizations/{organizationId}/collaborator-records/{recordId}/properties/{propertyId}

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.

Sets (or updates) the value of a property on a typed collaborator record. The record must have a type assigned, and the property must belong to that type.

For required properties, passing a null or empty value will return a validation error.

Requires CollaboratorDatabase.Edit permission.

Path Parameters

FieldTypeRequiredDescription
organizationIdGuidRequiredThe organization the record belongs to.
recordIdGuidRequiredThe record to update.
propertyIdGuidRequiredThe property to set a value for. Must belong to the record's current type.

Request Body

FieldTypeRequiredDescription
valuestring?OptionalThe value to store. For required properties, must not be null or empty.