Create a subscription type
Creates a new opt-in subscription type bound to a single delivery channel.
Idempotent — pass an Idempotency-Key header to make safely retryable. On a replay the original response is returned with Idempotent-Replayed: true. See the API conventions guide for the full state machine, TTL, and mismatch behaviour.
Authorizations
Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.
Body
Create a new subscription type.
Human-readable subscription-type name.
1"Weekly newsletter"
Delivery channel a subscription type covers.
email, text, push, webhook, in_app "email"
Whether to expose this subscription type on customer-facing preference centres. Defaults to true.
Response
The newly created subscription type.
A named opt-in channel a user can subscribe to. Used to drive sends and customer-facing preference centres. Distinct from a user’s per-channel subscription state.
Numeric subscription-type identifier.
7
Identifier of the owning project.
42
Human-readable subscription-type name shown on preference centres.
"Weekly newsletter"
Delivery channel a subscription type covers.
email, text, push, webhook, in_app "email"
Whether this subscription type is shown on customer-facing preference centres.
Time the subscription type was created. ISO 8601.
Time the subscription type was last modified. ISO 8601.