---
title: "Report whether an integration's credentials are working"
method: POST
path: "/integration/{integrationId}/connectionStatus"
tags: ["Integration"]
---

# Report whether an integration's credentials are working

`POST /integration/{integrationId}/connectionStatus`

## Request

- Base URL: `https://api.zentail.com/v1`
- URL: `https://api.zentail.com/v1/integration/{integrationId}/connectionStatus`
- Auth: API key in header `AUTHORIZATION`

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.

## Path parameters

- `integrationId` integer, required

## Request body

- IntegrationConnectionStatusPOSTRequest
  - `connected` boolean, required: false when the integration's credentials are being rejected by the channel.
  - `error` string: Short reason shown to the seller alongside the connection warning. Send null when connected.

## Response `200`

Success

- string

## Other responses

- `400`: Bad Request
- `403`: Permission Denied
- `404`: Not Found
- `500`: Zentail Error
- `503`: Zentail Error

---

[API](https://skmtc.dev/zentail/apis/zentail-api.md) - [All operations](https://skmtc.dev/zentail/apis/zentail-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zentail/apis/zentail-api/revisions/55e43cb43caf?raw)