Error responses

Read the HTTP status and JSON description. Recognised API errors also include code. X-Request-Id identifies the request.

400 Invalid input

Creating a submission requires exactly one deal identifier:

{ "description": "dealId and dealRefId cannot be provided together" }

Send dealId or dealRefId with formId.

401 Authentication

A missing or malformed Authorization header returns:

{
  "description": "Unauthorized: Missing or malformed Authorization header. Expected: Bearer <token>",
  "code": "MISSING_AUTH_HEADER"
}

Supply Authorization: Bearer <credential>. Other authentication codes identify an invalid API key, expiry, role, issuer, audience or principal binding. Renew credentials on a host request's 401.

404 Resource lookup

A submission lookup can return this, and the wording varies by route:

{
  "description": "Submission not found or you don't have permission to access it"
}

An unmatched route returns:

{ "description": "Not Found: No matching routes", "code": "NOT_FOUND" }

Check the path, canonical ID and credential's organisation.

429 Rate limit

Back off before retrying and honour Retry-After when present. Upload receipts define how to retry a run-step batch safely. A failed correction can be retried by the reviewer.

500 Service failure

A submission creation failure can return:

{ "description": "Failed to create submission" }

Retain X-Request-Id with the failed operation. For pipeline creation, retain the run receipt and use Run a pipeline.