Skip to main content
POST
/
api
/
v1
/
memberships
Add Permission for User
curl --request POST \
  --url https://vision.pingintel.com/api/v1/memberships \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "division_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "membership_type": "member",
  "team_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": 123
}
'
{
  "temporary_override": true,
  "user_email": "<string>",
  "user_first_name": "<string>",
  "user_last_name": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "division_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "membership_type": "member",
  "team_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": 123
}

Authorizations

​
Authorization
string
header
required

Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.

Body

​
company_uuid
string<uuid> | null

UUID of the company the user belongs to.

​
division_uuid
string<uuid> | null

UUID of the division the user belongs to.

​
membership_type
enum<string>
default:member

Role of the user within the team, division, or company. Defaults to 'member'.

  • member - Member
  • admin - Admin
  • owner - Owner
Available options:
member,
admin,
owner
​
team_uuid
string<uuid> | null

UUID of the team the user belongs to.

​
user_id
integer

ID of the user. On create, supply either user_id (for an existing user) or user_email.

Response

201 - application/json
​
temporary_override
boolean
required
read-only

True if this membership is a temporary override. While temporary memberships are active, the user's normal memberships are ignored.

​
user_email
string
required
read-only

Email address of the member. On create, supply user_email instead of user_id to add a user by email; if no account exists, one will be created. Optionally include first_name and last_name to populate the new account.

​
user_first_name
string
required
read-only

First name of the member.

​
user_last_name
string
required
read-only

Last name of the member.

​
uuid
string<uuid>
required
read-only

UUID of this membership record.

​
company_uuid
string<uuid> | null

UUID of the company the user belongs to.

​
division_uuid
string<uuid> | null

UUID of the division the user belongs to.

​
membership_type
enum<string>
default:member

Role of the user within the team, division, or company. Defaults to 'member'.

  • member - Member
  • admin - Admin
  • owner - Owner
Available options:
member,
admin,
owner
​
team_uuid
string<uuid> | null

UUID of the team the user belongs to.

​
user_id
integer

ID of the user. On create, supply either user_id (for an existing user) or user_email.