Skip to Content
InvyteDocs

Delete a role

Delete a role: everyone holding it loses it, everywhere. Undoing it later brings back only assignments whose person, Job or Client still exists. Admins only. Shows who loses what before it is done.

POST
/operations/access.deleteRole

Authorization

bearer
headerAuthorizationBearer <API key or OAuth token>

An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.

Header Parameters

Idempotency-Key?string

Makes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.

Match^[A-Za-z0-9._:-]+$
Length8 <= length <= 128

Request Body

application/json
  1. body
input*
confirmation?string

The id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.

Response Body

Done. A replay of the same key and input omits output.

application/json
  1. response
status*unknown
output?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/access.deleteRole' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "roleId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "roleId": "string"  },  "actionId": "string"}