Reserve PUSH/EMAIL recipients before publishing

post

https://megsapp-nova-stg.85.group/api/v1/communications/campaigns/{campaignId}/recipients/reservations

Claims each recipient exactly once per reservation campaign id. Only keys returned in reserved[] may be published. PUSH additionally filters against the live push-subscription table; ineligible uuids get NO ledger row.

Access: Auth methods: JWT bearer or API key. Allowed user types: MVNO. Requires permissions: campaign:write.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaignId

string

required

Body Params

channel

string

enum

required

Campaign channel. Only PUSH and EMAIL are accepted here: SMS keeps the frozen /sms/campaigns/* endpoints and INBOX reserves and delivers in one call via POST :campaignId/inbox-messages. Both return 400.

Allowed:

reservationCampaignId

string

Campaign id that scopes recipient uniqueness. This phase it MUST equal the path campaignId (400 otherwise); the field exists for future A/B variant support. Defaults to the path campaignId.

jobId

string

required

Strata job uuid. Recorded as the reservation owner; failure transitions apply only when this matches the owning reservation.

recipients

array of strings

required

length ≤ 500

Channel-scoped recipient keys to reserve: app_user.uuid for PUSH, email address for EMAIL. Malformed keys fail the whole request with the offenders listed in error.details.

recipients*

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201