RErecruitwithatlas
Custom Attributes

Append a custom attribute option to a company

Changed on

Adds a single option selection to an options-type custom attribute on a company record without replacing the existing selections — unlike PATCH /companies/{id}, which replaces all values of each attribute it receives.

Appending an option that is already selected is idempotent: the existing selection is returned with 200 and no duplicate is created. For single-select attributes (multipleValues: false) the append is rejected with 409 when another value is already set.

Returns 404 if the attribute, option, or company does not exist for this agency, and 422 if the attribute is not of type options.

post/api/v1/companies/{id}/custom-attributes/{attributeId}/values

Request

Path parameters

idstring uuid required

Record identifier (person, company or meeting ID)

Example:4f5e6d7c-8b9a-4c3d-9e2f-1a2b3c4d5e6f
attributeIdstring uuid required

Custom attribute ID

Example:123e4567-e89b-12d3-a456-426614174000

Request body

optionIdstring uuid required

Option to select on the record. Must belong to the attribute in the URL.

Example request

{
  "optionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

Response

Option was already selected (idempotent no-op)

status'ok' required

Changes