Integration

Report whether an integration's credentials are working

Marks the integration as connected or disconnected. A disconnected integration raises the connection warning shown to the seller on every page, so only report a disconnect once the channel has rejected the credentials, not on a transient network failure.

post/integration/{integrationId}/connectionStatus

Request

  • Base URL
    https://api.zentail.com/v1
  • Auth
    API key in header AUTHORIZATION

Path parameters

integrationIdinteger required

Zentail Integration ID

Request body

connectedboolean required

false when the integration's credentials are being rejected by the channel.

errorstring

Short reason shown to the seller alongside the connection warning. Send null when connected.

Response

Success

string required

Changes

No recorded changes to this operation across all 1 revision of this API.