Suspend, resume or disconnect an agency client

PATCH/orgs/{organizationId}/agency/clients/{relationshipId}

Suspend, resume or disconnect an agency client using current organization authority.

Authorization

AuthorizationBearer <token>

Scoped FishOut API key. Never send credentials in query parameters.

In: header

Path Parameters

organizationId*string

Length1 <= length

relationshipId*string

Length1 <= length

Header Parameters

Idempotency-Key*string

Reuse for retries of the same action for 24 hours. A changed body returns 409.

Length8 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Value in

"active"
"suspended"
"disconnected"

Response Body

`application/json`

curl -X PATCH "https://example.com/orgs/string/agency/clients/string" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "status": "active"  }'

{  "data": "string",  "meta": {    "requestId": "string",    "replayed": true  }}

Suspend, resume or disconnect an agency client

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

413application/json

415application/json

429application/json

500application/json

502application/json

503application/json

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`