Skip to main content
POST
CSharp (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

connector_id
string
required

The connector id.

Response

202 - application/json

OK

id
string
required
object
any
required
status
enum<string>
required
Available options:
running,
completed,
failed
trigger
enum<string>
required

What started the run: the interval, a sync request, creation with stores, a store being linked, or a rule change.

Available options:
schedule,
manual,
created,
linked,
rules_changed
started_at
integer
required

When the run started (Unix seconds).

Required range: -9007199254740991 <= x <= 9007199254740991
finished_at
integer | null
required

When the run ended (Unix seconds).

Required range: -9007199254740991 <= x <= 9007199254740991
added
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updated
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
removed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
restored
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
skipped
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
failed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
error
string | null
required

Why the run failed as a whole; null when it completed or is still running.