Create Permission

Create a permission with a POST request to the endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Before granting a permission, the user must first be added as a member of the organization.
If you need to add a SmartBox user to your organization, refer to the Organization Membership API.
For details on different user types, please see the Help Center.

Request Structure

The POST body must include the necessary data to create the permission, formatted as a JSON object.

{
    "user": {
        "id": 123456
    },
    "key": {
        "id": 654321
    },
    "role": "ADMINISTRATOR"
}
❗️

Only one of the following should be specified in the request body:

  • Group ID
  • Key ID
  • Location ID
    depending on the resource you are granting permission for.

Response

If the request is successful, the API returns the newly created Permission object.

Body Params
string
enum
required

The permission role: RESERVATION_ACCESS, EXCHANGE_ONLY, ADMINISTRATOR, VIEW_ONLY (deprecated).

Allowed:
user
object
required

The user to grant the permission to.

key
object

The key the permission grants access to.

location
object

The location the permission grants access to.

group
object

The group the permission grants access to.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json