SendEligibilityGql

Whether a message may be sent now, and if not why.

type SendEligibilityGql {
  allowed: Boolean!
  deferredUntil: DateTime
  reason: String
  reasonText: String
}

Fields

SendEligibilityGql.allowed ● Boolean! non-null scalar

True when the message may be sent.

SendEligibilityGql.deferredUntil ● DateTime scalar

When allowed but held to the next send window, the time it will go out.

SendEligibilityGql.reason ● String scalar

A machine-readable reason when not allowed, for example NO_CONSENT or OPTED_OUT.

SendEligibilityGql.reasonText ● String scalar

A plain reason to show next to a disabled action.

Returned By

sendEligibility query