Skip to main content

Read the result for this operation

The HTTP status and response body describe the operation you called. They do not all mean that a person received a message. The reference for each operation remains authoritative: messages, release, handoff, and Custom Connections.
A correlation ID is not a status URL. The published contract does not define a polling endpoint for trackingId or requestId. Keep it for correlation and support; do not construct a new endpoint from it.

Parse the error shape the endpoint publishes

REST Integrations and Custom Connections have separate error contracts.

REST Integrations

Many responses use Problem: title and status are required; code, detail, errors, traceId, instance, and extra are optional. When a code is present, use it to select a documented error handler rather than matching the human-readable title. Keep traceId when provided for a support request. Some published validation responses declare HTTPValidationError, whose detail is an array of entries with loc, msg, and type. The shared API error handler reviewed for this documentation returns request validation details as Problem.errors[] instead. The published response definitions are preserved; confirmation against the deployed API is still pending. See the validation compatibility note. Accept JSON errors with either application/json or application/problem+json. Inspect a code when present, then an errors array or a detail array for field errors. A string detail is an explanation, not an array. A 422 status alone does not identify one universal body shape. Keep a fallback for an error without code, and use the endpoint reference together with Error codes to choose the action.

Custom Connections

Its error body has required type, title, and status, and may include detail. Here type is the machine-readable error identifier. It is not the REST code field. The Custom Connections error reference lists these responses. Error responses do not carry the submission requestId; only a successful 202 does. For an error support request, retain the page URL and approximate time as described in that reference.

Make retry decisions by operation and cause

See Rate limits for pacing and Custom Connections errors for its distinct retry rules.

Some failures can follow a write

The Agent outbound reference documents that an unknown template.media.mediaId can produce BRIDGE_AI_LEADSCOUT_0016 after the conversation was created or recovered. A retry may therefore produce a different result. This is why a failure status alone is not a universal rollback guarantee. Follow the effects and recovery instructions for the specific operation. If those instructions are unclear or conflict, identify the uncertainty and contact Bridge support before retrying an action with external effects.