Skip to main content
DELETE
/
custom_role
/
{custom_role_api_id}
Delete Custom Role
curl --request DELETE \
  --url https://api.partoo.co/v2/custom_role/{custom_role_api_id} \
  --header 'x-APIKey: <api-key>'
{
  "status": "success",
  "api_id": "my_custom_role"
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

​
custom_role_api_id
string
required

API identifier of the custom role (api_id)

Query Parameters

​
org_id
integer

Organization ID. Only PROVIDER users can specify a different organization. If not provided, defaults to your own organization.

Response

OK

Response for successfully deleting a custom role

​
status
string
Example:

"success"

​
api_id
string

API identifier of the deleted custom role

Example:

"my_custom_role"