Docs
Create Collaborator Property
POST /organizations/{organizationId}/collaborator-properties
POST
/organizations/{organizationId}/collaborator-propertiesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Organization token | x-Organization-Token | Optional | Run **Authorize Organization** in the Authorization folder. |
Creates a new reusable collaborator property in the organization. Properties are the field definitions that get assigned to collaborator types.
Select type properties require at least one option. All other types must not include options.
Requires OrganizationAdmin permission.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| organizationId | Guid | Required | The organization to create the property in. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Display name for the property. |
| type | string | Required | Property type. One of: `Text`, `Select`, `Number`, `Date`, `Checkbox`, `Link`. |
| options | array? | Optional | Required for `Select` type. Must not be provided for other types. |
Options
| Field | Type | Required | Description |
|---|---|---|---|
| label | string | Required | Display label for the option. |