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

Set interview metadata

cURL

curl --request POST \
  --url https://api.heymilo.ai/api/v2/interviews/{interview_id}/metadata \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "metadata": {}
}'

200

{
  "data": {
    "object": "<string>",
    "metadata": {}
  },
  "meta": {}
}

Authorizations

X-API-KEY · string · header · required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY · string | null

Authorization · string | null

X-Workspace-Id · string | null

Path Parameters

interview_id · string · required

Body

application/json

Request body for setting metadata on a resource.

metadata · Metadata · object · 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.

Show child attributes

Example:

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

Response

200

application/json

Successful Response

data · MetadataResponse · object · required

Response containing metadata for a resource.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.