{
  "opencollection": "1.0.0",
  "info": {
    "name": "Talkpush Agents API Candidate Attributes API API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Candidate Attributes API",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all candidate attribute definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://company_subdomain.talkpush.com/api/talkpush_services/company/candidate_attributes",
            "params": [
              {
                "name": "api_key",
                "value": "",
                "type": "query",
                "description": "The API key provided for your application."
              }
            ]
          },
          "docs": "Returns every attribute definition for the company, including default (system) and custom attributes, ordered by `name`. Use this to drive integrations and to discover keys for the leads `others` payload.\n\nEach item includes type, suggested values, visibility flags, and whether the attribute is a default (built-in) field (`default: true`) or a custom one (`default: false`)."
        },
        {
          "info": {
            "name": "Create a custom candidate attribute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://company_subdomain.talkpush.com/api/talkpush_services/company/candidate_attributes",
            "params": [
              {
                "name": "api_key",
                "value": "",
                "type": "query",
                "description": "The API key provided for your application."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new **custom** attribute definition. It becomes available in the UI immediately and is writable on leads through the `others` field using the persisted key (custom keys are stored with an `others.` prefix where applicable).\n\n**Duplicate prevention:** If the normalized `key` already exists for an attribute, the API returns **409 Conflict** (not a second record).\n\n**Required fields:** `name` and `key` (see request schema). `data_type` defaults to `text` when omitted."
        }
      ]
    }
  ],
  "bundled": true
}