Email an audience in the shop name
- Credentials
- OAuth access token
- Scopes
messages:send- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Add-on
- Marketing plus
- Daily limit
- Email sends, 100 a day per store. Over the limit is
429 rate_limited. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Only customers who said yes to marketing get it (checked again now), each with their own unsubscribe link. Costs 1 credit per 10 recipients, taken before sending. Spends credits, so owner or admin. Comes with Growth.
Plan: Marketing Plus (included with Growth and Scale), else 403 plan_limit. Not enough credits is 403 insufficient_credits. A connected AI app that would go past its monthly credit limit (see Connection credit limit) is 403 over_credit_limit; the limit and the credits are taken in one transaction, before anything is sent, and a refused send spends nothing.
Access: OAuth scope messages:send; write-gated by the subscription.
merchantOAuth messages:sendAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: messages:send
storeId*stringA store the person can reach. Any other id answers 404, never 403.
Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$application/json- body
audience*AudienceId"all""best""repeat""one_time""lapsed""new""never_ordered"subject*string1 <= length <= 150body*stringPlain text. Blank lines make paragraphs.
1 <= length <= 5000button?OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/campaigns/send' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "audience": "all", "subject": "string", "body": "string"}'{ "data": { "campaignId": "string", "recipients": 0, "sent": 0, "failed": 0, "skippedNoConsent": 0, "credits": 0 }}Send a campaign proof to the signed-in person POST
The campaign, sent to the signed-in person only, to check how it looks. Free. Nobody else gets it, and nothing is recorded as a campaign. Owner or admin. Plan: Marketing Plus (included with Growth and Scale), else 403 `plan_limit`. Access: OAuth scope `messages:send`; write-gated by the subscription. Comes with Growth.
Credits the business has and what each make costs GET
Costs are by feature, e.g. `studio.adset`, `library.scene`, `brand.logo`. Access: OAuth scope `store:read`; not write-gated.