Set interview metadata

Set or update metadata for a specific interview. Up to 50 keys, each key max 40 chars, each value max 500 chars. All values must be strings.

post/api/v2/interviews/{interview_id}/metadata

Request

interview_idstring required

X-API-KEYstring nullable

Authorizationstring nullable

X-Workspace-Idstring nullable

metadataobject required

Key-value pairs to set. Up to 50 keys, each key max 40 chars, each value max 500 chars. All values must be strings.

{
  "metadata": {
    "external_id": "ats_12345",
    "source": "workday"
  }
}

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.

{
  "data": {
    "object": "metadata",
    "metadata": {
      "external_id": "ats_12345",
      "source": "workday"
    }
  }
}

No recorded changes to this operation across all 6 revisions of this API.