Skip to main content
POST
/
organization
/
{organizationId}
/
inviteMember
Invite someone in the organization
curl --request POST \
  --url https://api.qovery.com/organization/{organizationId}/inviteMember \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "role": "ADMIN",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "role": "ADMIN",
  "invitation_link": "<string>",
  "invitation_status": "EXPIRED",
  "organization_name": "<string>",
  "inviter": "<string>",
  "logo_url": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

​
organizationId
string<uuid>
required

Organization ID

Body

application/json
​
email
string
required
​
role
enum<string>

deprecated

Available options:
ADMIN,
DEVELOPER,
OWNER,
VIEWER
​
role_id
string<uuid>

the target role to attribute to the new member

Response

User invited

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
email
string<email>
required
​
role
enum<string>
required

deprecated

Available options:
ADMIN,
DEVELOPER,
OWNER,
VIEWER
​
invitation_link
string<uri>
required
​
invitation_status
enum<string>
required
Available options:
EXPIRED,
PENDING
​
inviter
string
required
​
updated_at
string<date-time>
​
organization_name
string
​
logo_url
string<uri>
​
role_id
string<uuid>
​
role_name
string