v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Applications

Reject Application

post/unified/ats/applications/{id}/reject

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

rejected_reason_idstring nullable

Unique identifier of the rejection reason

Example request

{
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "rejected_reason_id": "f223d7f6-908b-48f0-9237-b201c307f609"
}

Response

The application was rejected successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Application rejected successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}