PApartoo
Custom Roles

Create Custom Role

This endpoint enables you to create custom roles for organizations within your scope.

post/custom_role

Request

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 required

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

api_idstring required

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

descriptionstring

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

permissionsstring[] required

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 created custom role.

Example response

{
  "api_id": "my_custom_role"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.