Docs

Delete Collaborator Property

DELETE /organizations/{organizationId}/collaborator-properties/{propertyId}

DELETE/organizations/{organizationId}/collaborator-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.

Deletes or archives a collaborator property depending on whether it has stored values.

  • If no property values exist for this property: the property and its type assignments are permanently deleted.
  • If any property values exist: the property is archived instead. Archived properties are hidden from the property picker but remain visible in Get Collaborator Properties with isArchived: true.

Requires OrganizationAdmin permission.

Path Parameters

FieldTypeRequiredDescription
organizationIdGuidRequiredThe organization the property belongs to.
propertyIdGuidRequiredThe property to delete or archive.