Webhooks

Inactivate webhook subscription

Deactivate the account's oldest webhook endpoint. While inactive, no events are sent to it; other endpoints are unaffected. Requires the webhooks:write OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/accounts/{accountId}/webhooks/inactivate

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/accounts/{accountId}/webhooks/inactivate
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

accountIdstring required

Workspace account ID.

Response

The inactivated subscription

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "events": [
      "document_ready",
      "document_prepared"
    ],
    "is_active": true,
    "url": "http://example.com?test=1",
    "email": "email@test.com",
    "updated_at": "2023-05-10T14:58:24Z"
  }
}

Changes

No recorded changes to this operation across all 14 revisions of this API.