Skip to navigation
Sales CRMCompanies

Create a company/deal attribute

View as Markdown

Create a new custom attribute for companies or deals. The attribute label must be unique within the object type, cannot exceed 50 characters, and cannot use reserved names. For single-select or multi-choice attribute types, you must also provide the optionsLabels array.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Request

Attribute creation data for a company/deal.

attributeTypeenumRequired

The type of attribute (must be one of the defined enums)

labelstringRequired

The label for the attribute (max 50 characters, cannot be empty)

objectTypeenumRequired

The type of object the attribute belongs to. Must be either companies or deals.

Allowed values:
descriptionstringOptional
A description of the attribute
optionsLabelslist of stringsOptional

Options for multi-choice or single-select attributes

Response

Created new attribute
idstring
Unique ID of the created attribute

Errors

400
Bad Request Error