Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Body

application/json
shop_id
string

Only this connected shop; default every connected shop of the workspace. A shop outside the workspace is 404.

Pattern: ^[0-9]{1,20}$

Response

Accepted: the work has started and goes on after this answer.

object
string
required
Allowed value: "workspace.sync_start"
shops
object[]
required

One outcome per shop.

notices
object[]
required

sync_daily_cap_reached: the workspace started its most syncs through the API for the UTC day.