Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

role
integer
required

Body

application/json

A custom role's name, what it is for and the permissions it holds, for creating it or changing it.

name
string
required
Maximum string length: 100
permissions
string[]
required
description
string | null
Maximum string length: 500

Response

RoleResource

data
RoleResource · object
required