GraphQL

Execute a GraphQL query, mutation, or introspection request

Send the operation document as JSON. Mutations should carry an IdempotencyKey argument so a retried request cannot create a duplicate (see https://docs.highnote.com/docs/developers/api/idempotency). Validation and business-logic failures are returned as data in UserError types inside the mutation payload rather than in the top-level errors array; see https://docs.highnote.com/docs/developers/api/error-handling. Every response includes extensions.requestId — quote it when contacting support.

post/graphql

Request

  • Base URL: https://api.us.highnote.com
  • URL: https://api.us.highnote.com/graphql
  • Auth: HTTP basic

Request body

querystring required

The GraphQL document: a query, a mutation, or an introspection query.

variablesobject

Values for the variables declared in query.

operationNamestring

Which operation to run when query defines more than one.

Response

Operation executed. Inspect data; a partially failed operation still returns 200 with an errors array alongside any resolvable data. Responses are Content-Type: application/json.

dataobject nullable

The operation result, keyed by root field. null when the request failed before execution.

Changes

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