Disable an identity

POST /api/v1/forward/identities/{identity_id}/disable

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT or SAT>`

Path parameters

Parameter	Type	Required	Description
`identity_id`	string	Yes	Forward Identity ID.

Example response

HTTP 200 OK

{
  "id": "idn_019eabc123",
  "enabled": false
}

Response fields

Field	Type	Description
`id`	string	Identity ID.
`enabled`	boolean	State after the operation. Always `false`.

Errors

HTTP	Type	Code	Trigger
401	`authentication_error`	-	The PAT or SAT is invalid, expired, or missing.
404	`not_found_error`	-	The Identity does not exist or is not visible to the caller.
409	`conflict_error`	`ADMIN_IDENTITY_READ_ONLY`	The target is the Admin Identity.

Notes

After an Identity is disabled, it accepts no new API or IM execution requests and starts no new Schedule executions. Executions accepted before disabling finish naturally; event streams, reconnections, and result delivery continue. Disabling does not automatically cancel tasks or truncate output. Requests that have already passed execution checks may start even after the disable response is returned. Tool confirmations or results for existing pending actions can still be submitted, but must match a real pending action in that Session and must not include new user messages. Manual cancellation, deletion, archiving, and credential revocation follow their own rules. The Identity switch does not change the switches on Schedules or Channels. For scheduling and Session behavior after re-enabling, see Enable an identity.

​Headers

​Path parameters

​Example response

​Response fields