Schemas

Resolve payer names against a schema's required inputs

Given a schema and a batch of payer names, returns the schema's own required/optional inputs plus the per-payer required inputs for each name, so you can assemble the complete input set for a specific payer before calling POST /v1/requests, instead of discovering a payer-specific field from an INVALID_INPUTS rejection. The schema-level requiredInputs/optionalInputs are identical in shape and meaning to GET /v1/schemas/{schemaId}/required-inputs; payers adds the per-payer detail.

The response carries one payers entry per payerNames entry, in input order, with no de-duplication (positionally aligned 1:1 with the request array). Each entry is either matched (inputPayerName, matchedPayerName, payerRequiredInputs.fields) or a per-payer error (inputPayerName, errorCode, message). Discriminate on the presence of errorCode. A per-payer failure never fails the whole request; whole-request failures use the uniform {error, message} envelope.

Opt-in. Gated on the enforcePayerRequiredInputs account feature. When it is off the endpoint returns 403 PAYER_REQUIRED_INPUTS_DISABLED. This is the schema-keyed twin of POST /v1/scripts/{scriptId}/required-payer-inputs. See the Per-Payer Required Inputs guide.

post/v1/schemas/{schemaId}/required-payer-inputs

Request

  • Base URL: https://robodialer-service-api-9nc4t1p9.uc.gateway.dev
  • URL: https://robodialer-service-api-9nc4t1p9.uc.gateway.dev/v1/schemas/{schemaId}/required-payer-inputs
  • Auth: HTTP bearer

Path parameters

schemaIdstring required

The schema ID (from GET /v1/schemas). Must be non-blank, ≤1500 characters, contain no /, and must not start with _ or ..

Request body

payerNamesstring[] required

Payer names to resolve, 1–50 per request. Resolved independently, in order, with no de-duplication. The response's payers array is positionally aligned 1:1 with this array. More than 50 entries returns 400 INVALID_REQUEST (no truncation). A blank/whitespace-only entry is not a whole-request error. It comes back as a per-payer INVALID_PAYER_NAME entry in payers.

Example request

{
  "payerNames": [
    "Sample Insurance Co",
    "Unknown Payer"
  ]
}

Response

Schema required/optional inputs plus one payers entry per requested name.

schemaIdstring required

Echoes the path parameter.

Changes

No recorded changes to this operation across all 1 revision of this API.