Skip to content

Permissions

Get list of permissions

GET/Owners/{ownerAccountId}/Permissions

Get a list of permissions for the current owner.

Scope

read:owneraccount:permissions

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.

Response

200 OK
[
  {
    "id": "1",
    "ownerAccountId": "1",
    "contactId": "1",
    "role": "Owner"
  },
  {
    "id": "2",
    "ownerAccountId": "1",
    "contactId": "2",
    "role": "Admin"
  },
  {
    "id": "3",
    "ownerAccountId": "1",
    "contactId": "3",
    "role": "Admin"
  }
]

Put permission

PUT/Owners/{ownerAccountId}/Permissions

Create a new permission.

Scope

write:owneraccount:permissions

Body

Bug

The owner account's ID is required in the post body and the path parameter.

{
  "ownerAccountId": "1",
  "contactId": "4",
  "role": "Admin"
}

Response

200 OK
{
  "id": "4",
  "ownerAccountId": "1",
  "contactId": "4",
  "role": "Admin"
}

Get permission by ID

GET/Owners/{ownerAccountId}/Permissions/{id}

Get a specific Owner Account permission.

Scope

read:owneraccount:permissions

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
id string path The permission's ID.

Response

200 OK
{
  "id": "1",
  "ownerAccountId": "1",
  "contactId": "1",
  "role": "Owner"
}

Delete permission

DELETE/Owners/{ownerAccountId}/Permissions/{id}

Delete a specific Owner Account permission.

Scope

write:owneraccount:permissions

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
id string path The permission's ID.

Response

204 No Content