Update Candidate

Adding or updating Custom Attributes on a candidate

📘

Custom Field - IMPORTANT

It is important to read about Custom Fields and their resource_type and field_type and how they must be confirmed before you can create Custom Attributes alongside candidates.

custom_attributes created for candidates must have be associated with custom_fields that have a resource_type of candidate. The appropriate value for the new custom_attribute must also align with the field_type of the custom_field.

👍

Adding Custom Attributes to the request body

• You must add custom_attributes to the relationships section of the request body and give each one a temp-id.
• These temp-id must match the temp-id that you assign the corresponding custom_attribute that you create in the included section of the request body.
• The included section is where you will pass all of the attributes and relationships for the custom_attribute, to properly create it along side the application. The only required relationship for the custom_attribute is the custom_field

Create custom attributesUpdate custom attributes

{
  "data": {
    "id": "1",
    "type": "candidates",
    "relationships": {
      "custom_attributes": {
        "data": [
          {
            "type": "custom_attributes",
            "temp-id": "temp-id-1",
            "method": "create"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "custom_attributes",
      "temp-id": "temp-id-1",
      "attributes": {
        "varchar_value": "New attribute submission"
      },
      "relationships": {
        "custom_field": {
          "data": {
            "type": "custom_fields",
            "id": "25"
          }
        }
      }
    }
  ]
}

{
  "data": {
    "id": "1",
    "type": "candidates",
    "relationships": {
      "custom_attributes": {
        "data": [
          {
            "type": "custom_attributes",
            "id": "84",
            "method": "update"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "custom_attributes",
      "id": "84",
      "attributes": {
        "varchar_value": "An updated value"
      }
    }
  ]
}

Attaching documents

Documents can be supplied with the request by providing a documents_base64 array that contains objects with both of the fields shown below. If only one of the fields is present in the object then that document will not be saved.

Validations

• Accepted file formats are pdf, doc, and docx, txt, and rtf
• File size limit is 30 megabytes.

Example

{
  "data": {
    "type": "candidates",
    "id": "1",
    "attributes": {
      "documents_base64": [
        {
          "filename": "cv.pdf",
          "data": "data:application/pdf;base64,...[DATA]..."
        }
      ]
    }
  }
}