Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

connection
string
required
stream
string
required

Body

application/json

How often a stream syncs, for the page and the API.

interval_minutes
integer | null
required

Minutes between syncs; null when only webhooks start the stream. Raised to the plan's floor.

Required range: 1 <= x <= 10080
enabled
boolean

False turns the stream off. Defaults to true.

Response

StreamResource

data
StreamResource · object
required