/dashboard/organizations/{org}/invitations (POST)

POST

/dashboard/organizations/{org}/invitations

const url = 'https://example.com/dashboard/organizations/example/invitations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"[email protected]","role":"admin"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/dashboard/organizations/example/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "role": "admin" }'

Authorizations

apiKey

Parameters

Path Parameters

org

required

string

Request Body^required

application/json

object

email

required

string format: email

<= 254 characters

role

required

string

Allowed values: admin member viewer

Responses

200

Default Response

/dashboard/organizations/{org}/invitations (POST)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Request Body^required