Skip to main content
POST
/
invitations
/
{invitationKey}
Accept invitation by key
curl --request POST \
  --url https://console.gmicloud.ai/api/v1/invitations/{invitationKey} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://console.gmicloud.ai/api/v1/invitations/{invitationKey}"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://console.gmicloud.ai/api/v1/invitations/{invitationKey}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://console.gmicloud.ai/api/v1/invitations/{invitationKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://console.gmicloud.ai/api/v1/invitations/{invitationKey}"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://console.gmicloud.ai/api/v1/invitations/{invitationKey}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://console.gmicloud.ai/api/v1/invitations/{invitationKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "group": "request",
  "code": 0,
  "validationDetail": [
    {
      "field": "invitationKey",
      "expression": "required",
      "originalValue": "",
      "reason": "This field is required."
    }
  ]
}
{
"group": "invitation",
"code": 1,
"message": "The user has no permission to access invitation resources."
}
{
"group": "organization",
"code": 2,
"message": "Organization does not exist."
}
{
"group": "organization",
"code": 0,
"message": "User already owns an organization."
}
{
"group": "organization",
"code": 1201,
"message": "Get organization encountered DB error.",
"traces": [
"DB error occurred."
]
}

Authorizations

Authorization
string
header
required

An access token used to authenticate a user and grant access to restricted APIs. It is issued by session APIs. For status codes related to this header, refer to the Common Headers Documentation.

Path Parameters

invitationKey
string
required

The invitation key for joining an existing organization.

Example:

"CB8OZUZQUxddQG9DTAlGXg9Ea0IBV18EQ25FTFhAUVtcakdRU0JVRGUaDxodEwwdNhwLWRNVEToRAlVNSlQKbxFIVxcDTHIRA1oQSlsLPUoHB0FdRD5CUA"

Response

Successfully accepted the invitation.