CompaniesDeactivate Company

Deactivate Company

Mark the Company as deactivated and notify internal channels. The record is retained but excluded from active listings.

curl -X PATCH "https://api.getkini.com/companies/123/deactivate/" \
  -H "Content-Type: application/json" \
  -H "Company-Id: 123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "detail": "success"
}
PATCH
/companies/{id}/deactivate/
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Bearer API Key Authentication. Include your API key in the Authorization header.

Bearer API Key Authentication. Include your API key in the Authorization header.
path
idinteger
Required

Unique Kini ID of the company

header
Company-Idinteger
Required

Kini ID of the company the key is associated with

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer API Key Authentication. Include your API key in the Authorization header.

Path Parameters

idinteger
Required

Unique Kini ID of the company

Headers

Company-Idinteger
Required

Kini ID of the company the key is associated with

Responses

detailstring

Result of the deactivation request