Pause scheduling at a store
const url = 'https://data.creatorain.com/partner/v1/locations/store_123/pause';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"reason":"Kitchen refit"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://data.creatorain.com/partner/v1/locations/store_123/pause \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "reason": "Kitchen refit" }'Stops us offering this store to creators from the moment of the call.
CONFIRMED BOOKINGS ARE NOT CANCELLED. One cancellation usually loses that creator permanently, and creator supply is shared across a city. If the store cannot host a visit that is already booked, ask us to reschedule it.
IDEMPOTENT: a store that is already paused answers 200 with its current state, writes
nothing, and keeps the instant of the FIRST pause, which is what a merchant’s “paused
since” line is made of.
WEBHOOK: a pause that changes the store sends one location.paused event (data:
location_id, partner_location_id, reason, effective_at, timezone,
initiated_by). A repeat sends nothing. A pause or resume made by our own team sends the
same event with initiated_by: creatorain. resume sends location.resumed and
terminate sends location.terminated the same way (once per change).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”YOUR id for the store, as you sent it to POST /locations.
Example
store_123Request Body
Section titled “Request Body”object
Why, in your words. Kept on the store so an operator reading it later can tell a partner
pause from one of ours. Defaults to Paused by partner.
Example
Kitchen refitResponses
Section titled “Responses”The store, now paused.
The store as we hold it. ONE body for every verb on a location: the create’s 201 (also
returned when a terminated store is added again), an identical repeat’s 200 (plus a warning), the PATCH response, and pause, resume and terminate. Write one
receiver for it. GET /locations/{partner_location_id} returns this plus progress and the
next visit (LocationState).
object
OUR id for the store. Stable, and what every other endpoint refers to it by.
Your id, as you sent it (trimmed).
paused means no NEW scheduling: creators are not offered the store and a new booking
is refused, while bookings already confirmed are untouched. Resume opens it again.
terminated means the contract has ended. Terminated wins over paused.
A display label for the local creator pool, for example example-pool. Label only.
The embeddable merchant dashboard for this store, carrying a freshly minted 30 minute
read-only token. Null when this deployment hosts no embedded dashboard, rather than a
plausible URL pointing at nothing: an iframe rendered from a dead URL shows a merchant
a blank panel, which is worse than a field you can branch on. Mint a fresh one with
POST /locations/{partner_location_id}/dashboard-token when you render the embed.
IANA name for the store as we resolve it: the timezone you sent when you sent one,
otherwise derived from the address. Null when neither yields one.
RFC 3339 with the store’s offset.
Whether we hold this store’s real opening hours, and where they came from. A store with
no hours is still active: the contract exists and nothing about the enrolment failed.
What it cannot do yet is take a creator booking, because our two date pickers are built
from the stored week and an absent one disables both. state: missing is a request to
chase the hours at source, which is the one place they actually exist.
object
Where the hours came from. partner means you sent them (opening_hours); the rest
are our own lookups or an operator (manual). Null for a store never checked.
How creators are approved for this store. auto (the default) books matching creators
straight away. sample_review means the merchant first approves a batch of 5 sample
creators (GET /locations/{partner_location_id}/creator-samples); nothing starts until
that decision.
The store’s price for the month it is in: the same block as the quote, LOCKED when the store
was confirmed. A change to plan.videos_per_month or approval_mode re-locks it from the
next month (at the base price and your surcharge at that moment), shown meanwhile as upcoming.
A later surcharge change does not move it. A store confirmed before pricing existed has no
locked price: its block is worked out from the current default terms and marked
locked: false, source: default (nothing is stored for it, and it shows the default
creator cost range). NULL only when pricing is not set up at all.
Read with a merchant’s store token, only the merchant price is returned (creatorain and
surcharge are left out).
object
What we bill the partner per published video. Not a fixed price.
object
Estimate range of the creator cost per video (on a quote, and on a store with no locked price; null on a locked store). The bill uses the actual cost.
object
object
The non-standard plan line, included in merchant. 0 / false for a standard plan.
object
True while the amount is provisional.
object
Per_video x videos per month. Null for a store with no plan.
Per_month x 3.
When the price in force was locked (UTC). Null when locked is false.
False for a store with no locked price, priced from the current defaults.
The price from from_month (the store’s next month), when a re-lock is waiting.
object
What we bill the partner per published video. Not a fixed price.
object
Estimate range of the creator cost per video (on a quote, and on a store with no locked price; null on a locked store). The bill uses the actual cost.
object
object
object
object
Per_video x videos per month. Null for a store with no plan.
Per_month x 3.
The first-visit commitment for this store, in business days (Monday to Friday, store clock, skipping Thanksgiving Day, Christmas Day, New Year’s Day and any weekday the store’s own opening hours say it is closed), as agreed in your contract. Locked when the store is created. Null for a store created before this field existed. Show it as given.
The store-local date the first creator visit is due by: first_visit_business_days
counted from the day after the confirm day (approved_at when you sent it, otherwise
the day the store was created). Locked at creation.
WHAT THIS STORE ASKS OF A CREATOR: the terms you set with PATCH, read back. Always
present, ordered by attribute then operator, and [] for a store that asks nothing -
which is what a store has until you send its first rule.
THIS IS THE SAME ARRAY PATCH ACCEPTS, so the obvious read-modify-write is safe: read
a store, change one entry, send the array back. value is returned in the shape we
STORED it, which is the normalised one - a bare 20000 you sent for follower_count
reads back as {"count": 20000, "platform": null}, and sending that object again
changes nothing.
It is deliberately NOT our internal effective rule set. Terms an operator set on our
own dashboard through the older per-venue columns are not folded in here, because you
can neither send nor clear those through this API and a term you cannot remove is worse
than one you cannot see. Everything this array contains, clear_rules can remove.
One term this store asks of a creator.
ethnicity, age_band and gender are real members of our attribute list and are
REFUSED with 422 validation_error on both this API and our dashboard. Filtering paid work
by a protected characteristic needs a written policy agreed with counsel, and until one
exists we will not store the rule.
follower_count takes gte or lte and a value of {"count": N}, optionally with
"platform" to say WHERE the count is measured - {"count": 20000, "platform": "tiktok"}
means twenty thousand on TikTok, not twenty thousand in total from somebody who also has a
TikTok handle. platform and language take eq with one value or in with a list; over
a creator who works on several, eq means “this is one of hers”, never “this is her only
one”.
home_metro (local creators only) takes in; radius_miles (within N miles of this
store) takes lte and the miles, 25 or {"miles": 25}, from 1 to 500. Both are measured
from this store’s own address, which we resolve when you write the rule and again when the
address moves; an address we cannot place in a US city is a 422.
performance_index (content performance score, 0 to 100) and engagement_rate (percent,
3.5 means 3.5%) take gte and a number. They are floors.
A creator we hold no answer for is decided by the store’s own policy, which passes by
default - so adding a language rule today records your intent and excludes nobody until
we hold languages. The follower bar, the platform, home_metro, radius_miles,
performance_index and engagement_rate are the exception and always exclude a creator we
cannot measure.
object
object
Example
{ "partner_location_id": "store_123", "status": "active", "network": "example-pool", "timezone": "America/Los_Angeles", "created_at": "2026-09-10T13:22:00-07:00", "hours": { "state": "missing", "source": "partner" }, "approval_mode": "auto", "pricing": { "currency": "USD", "billing_unit": "published_video", "creatorain": { "fee_per_video": 10, "creator_cost_per_video": { "min": 20, "max": 40 }, "billed_as": "creator_cost_plus_fee" }, "surcharge": { "per_video": 10 }, "plan_surcharge": { "per_video": 5, "applies": false, "placeholder": true }, "merchant": { "per_video": 100, "per_month": 200, "per_season": 600 }, "season_videos": 6, "source": "locked", "upcoming": { "from_month": "2026-11", "creatorain": { "fee_per_video": 10, "creator_cost_per_video": { "min": 20, "max": 40 }, "billed_as": "creator_cost_plus_fee" }, "merchant": { "per_video": 100, "per_month": 200, "per_season": 600 } } }, "first_visit_due_by": "2026-10-06", "rules": [ { "attribute": "follower_count", "operator": "gte", "value": { "count": 20000, "platform": "tiktok" } }, { "attribute": "platform", "operator": "eq", "value": "tiktok" } ]}validation_error. field names the offending parameter.
object
object
The stable value to branch on.
A human sentence. Copy, not contract; it may be reworded.
The request field at fault, dotted for a nested one (plan.term_months).
Example
{ "error": { "code": "unauthorized" }}unauthorized. A missing, malformed, unknown or revoked key; or an invalid, expired or
wrong-store dashboard token. One answer for every case on purpose: the holder of a bad
credential learns nothing from the difference.
object
object
The stable value to branch on.
A human sentence. Copy, not contract; it may be reworded.
The request field at fault, dotted for a nested one (plan.term_months).
Example
{ "error": { "code": "unauthorized" }}location_not_found. No store of this key carries that partner_location_id.
object
object
The stable value to branch on.
A human sentence. Copy, not contract; it may be reworded.
The request field at fault, dotted for a nested one (plan.term_months).
Example
{ "error": { "code": "unauthorized" }}location_terminated.
object
object
The stable value to branch on.
A human sentence. Copy, not contract; it may be reworded.
The request field at fault, dotted for a nested one (plan.term_months).
Example
{ "error": { "code": "unauthorized" }}rate_limited. Over this key’s requests-per-minute ceiling.
object
object
The stable value to branch on.
A human sentence. Copy, not contract; it may be reworded.
The request field at fault, dotted for a nested one (plan.term_months).
Example
{ "error": { "code": "unauthorized" }}