RErecruitwithatlas
Custom Attributes

Add options to a project custom attribute

Changed on

Adds one or more selectable options to an existing options-type custom attribute definition for project records.

The body accepts either a single option object or an array of them (max 100). Each option takes a value and an optional 1-based position; when position is omitted the option is appended to the end. Inserting at an occupied position shifts existing options down. Option values must be unique within the attribute (case-insensitive) — a duplicate returns 409. Adding options to a non-options attribute returns 422.

post/api/v1/projects/custom-attributes/{id}/options

Request

Path parameters

idstring uuid required

Custom attribute definition identifier

Request body

OR

Example request

{
  "value": "Principal",
  "position": 4
}

Response

Options added to the project custom attribute definition

status'ok' required
addedOptionIdsstring[] required

Identifiers of the newly created options, in the order they appeared in the request

Example response

{
  "data": {
    "name": "Seniority Level",
    "description": "Candidate's seniority level",
    "type": "options",
    "multipleValues": true,
    "recordType": "contract",
    "options": [
      {
        "value": "Senior"
      }
    ]
  }
}

Changes