Convites
Criar convite para membro da empresa
Cria um convite para um novo membro da empresa e envia e-mail de convite.
POST
/
invitations
Criar convite para membro da empresa
curl --request POST \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/invitations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-company-id: <x-company-id>' \
--data '
{
"company_role": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"active": true
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/invitations"
payload = {
"company_role": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"active": True
}
headers = {
"x-company-id": "<x-company-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-company-id': '<x-company-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
company_role: '<string>',
email: '<string>',
name: '<string>',
role: '<string>',
active: true
})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/invitations', 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://golang-api-vgnqx.ondigitalocean.app/v1/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'company_role' => '<string>',
'email' => '<string>',
'name' => '<string>',
'role' => '<string>',
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-company-id: <x-company-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://golang-api-vgnqx.ondigitalocean.app/v1/invitations"
payload := strings.NewReader("{\n \"company_role\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-company-id", "<x-company-id>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://golang-api-vgnqx.ondigitalocean.app/v1/invitations")
.header("x-company-id", "<x-company-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company_role\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_role\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).
Headers
company uuid
Body
application/json
dados do convite
Response
Created
The response is of type object.
⌘I
Criar convite para membro da empresa
curl --request POST \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/invitations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-company-id: <x-company-id>' \
--data '
{
"company_role": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"active": true
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/invitations"
payload = {
"company_role": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"active": True
}
headers = {
"x-company-id": "<x-company-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-company-id': '<x-company-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
company_role: '<string>',
email: '<string>',
name: '<string>',
role: '<string>',
active: true
})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/invitations', 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://golang-api-vgnqx.ondigitalocean.app/v1/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'company_role' => '<string>',
'email' => '<string>',
'name' => '<string>',
'role' => '<string>',
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-company-id: <x-company-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://golang-api-vgnqx.ondigitalocean.app/v1/invitations"
payload := strings.NewReader("{\n \"company_role\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-company-id", "<x-company-id>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://golang-api-vgnqx.ondigitalocean.app/v1/invitations")
.header("x-company-id", "<x-company-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company_role\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_role\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}