Delete a role | PlannrCRM API documentation

Delete a role Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

DELETE /api/v2/roles/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

Responses

204 application/json
422 application/json

Validation error
Hide response attributes Show response attributes object
- message string Required
  
  A human-readable description of the error.
- errors object
  
  Validation messages keyed by the field that failed.
  
  Hide errors attribute Show errors attribute object
  
  * array[string] Additional properties

DELETE /api/v2/roles/{uuid}

curl \
 --request DELETE 'https://api.plannrcrm.com/api/v2/roles/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (204)

{}

Response examples (422)

{
  "message": "This role cannot be deleted as it is protected - contact Plannr for more assistance.",
  "errors": {
    "role": [
      "This role cannot be deleted as it is protected - contact Plannr for more assistance."
    ]
  }
}

{
  "message": "You cannot delete a role that you're currently assigned to.",
  "errors": {
    "role": [
      "You cannot delete a role that you're currently assigned to."
    ]
  }
}

{
  "message": "You cannot delete a role that is linked as a legacy role.",
  "errors": {
    "role": [
      "You cannot delete a role that is linked as a legacy role."
    ]
  }
}