Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Custom Roles

Update Custom Role

Update a Custom Role, allowing you to set the name, api_id, description, and permissions of an already existing Custom Role.

post/custom_role/{custom_role_api_id}

Path parameters

custom_role_api_idstring required

API identifier of the custom role (api_id)

Query parameters

org_idinteger

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

Request body

namestring

Name of the Custom Role. Cannot contain any of the following characters: ,;/\|<>.

api_idstring

Unique identifier. Cannot contain any of the following characters: ,;/\|<>.

descriptionstring

Description of the Custom Role. Cannot contain any of the following characters: ,;/\|<>.

permissionsstring[]

List of permission names. (Use GET /api/v2/permissions to get a list of all available permissions for your organization.)

org_idinteger

Unique identifier of an organization in Partoo.

Example request

{
  "name": "My Custom Role",
  "api_id": "my_custom_role",
  "description": "This Custom Role is just an example for our API documentation",
  "permissions": [
    "business_edit",
    "business_edit_name",
    "review_read"
  ],
  "org_id": 42
}

Response

OK

status'success'

Request status

api_idstring

API identifier of the updated custom role.

Example response

{
  "api_id": "my_custom_role"
}