Skip to main content

CampaignActionError

Returned when an action on a campaign was refused for a business reason rather than a transport or permission failure.

type CampaignActionError {
code: CampaignActionErrorCode!
message: String!
field: String
}

Fields

CampaignActionError.code ● CampaignActionErrorCode! non-null enum

The machine-readable reason the action was refused.

CampaignActionError.message ● String! non-null scalar

A human-readable explanation, safe to show a merchant as written.

CampaignActionError.field ● String scalar

The input field the problem belongs to, when it belongs to exactly one. Null for refusals that are about the campaign’s state rather than the request.

Implemented By

PauseCampaignResult union