Schemas

Required inputs for a schema

Returns the input keys this schema declares: those required to submit a request against it, and those it accepts but does not require. Field names are returned verbatim. Use them as the keys of the inputs object on POST /v1/requests. Lists are sorted. Neither list constrains inputs: additional keys outside both are accepted and passed to the call as context. This is the baseline: if your account is enabled for per-payer required inputs, some payers require additional fields not listed here, reported as INVALID_INPUTS on POST /v1/requests.

get/v1/schemas/{schemaId}/required-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-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 ..

Response

Sorted list of required input field names for this schema.

schemaIdstring required

Echoes the path parameter.

Changes

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