v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Applications

Update Application

patch/unified/ats/applications/{id}

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "application_status": {
    "value": "hired"
  },
  "source": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "LinkedIn"
  }
}

Response

Record updated successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}