Custom Attributes

Create a meeting custom attribute definition

Changed on

Creates a new agency-wide custom attribute definition for meeting records.

For options-type attributes, provide the selectable choices via options (in display order) and optionally set multipleValues to allow multi-select. The attribute name must be unique per entity type within the agency (exact match, case-sensitive — same as the Atlas app) — a duplicate name returns 409.

post/api/v1/meetings/custom-attributes

Request

  • Base URL
    https://api.recruitwithatlas.com
  • Auth
    HTTP bearer

Request body

namestring required

Display name. Must be unique per entity type within the agency (exact match, case-sensitive). Leading/trailing whitespace is trimmed.

type'options' | 'text_block' | 'text_line' | 'integer' | 'date' required

Data type of the attribute

multipleValuesboolean

When true and type is options, multiple options can be selected. Only allowed for options type. Defaults to false.

requiredboolean

Marks the attribute as mandatory when a person or placement is created in Atlas. Only allowed for people and placement attributes — sending true for any other record type returns 422. Defaults to false.

optionsstring[]

Selectable choices, in display order. Required (at least one value) when type is options; not allowed otherwise. Values must be unique (case-insensitive).

Example request

{
  "name": "Seniority Level",
  "type": "options",
  "options": [
    "Junior",
    "Mid",
    "Senior"
  ]
}

Response

Created meeting custom attribute definition

status'ok' required

Example response

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

Changes

    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

    • info

      added the optional property to the response with the status