Send an organization invite link via WhatsApp template
curl --request POST \
--url http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "5511999999999",
"role": "member",
"area_ids": [
1
]
}
'import requests
url = "http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite"
payload = {
"phone_number": "5511999999999",
"role": "member",
"area_ids": [1]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({phone_number: '5511999999999', role: 'member', area_ids: [1]})
};
fetch('http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite",
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([
'phone_number' => '5511999999999',
'role' => 'member',
'area_ids' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite"
payload := strings.NewReader("{\n \"phone_number\": \"5511999999999\",\n \"role\": \"member\",\n \"area_ids\": [\n 1\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"5511999999999\",\n \"role\": \"member\",\n \"area_ids\": [\n 1\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"5511999999999\",\n \"role\": \"member\",\n \"area_ids\": [\n 1\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"link": {
"id": 42,
"token": "AbC",
"url": "https://app/invite/AbC"
}
}{
"message": "validation error"
}{
"error": "unauthorized"
}{
"error": "forbidden"
}{
"error": "internal_error"
}{
"error": "bad_gateway",
"message": "Falha ao enviar WhatsApp."
}Organizations
Send an organization invite link via WhatsApp template
POST
/
v1
/
organizations
/
{id}
/
whatsapp-invite
Send an organization invite link via WhatsApp template
curl --request POST \
--url http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "5511999999999",
"role": "member",
"area_ids": [
1
]
}
'import requests
url = "http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite"
payload = {
"phone_number": "5511999999999",
"role": "member",
"area_ids": [1]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({phone_number: '5511999999999', role: 'member', area_ids: [1]})
};
fetch('http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite",
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([
'phone_number' => '5511999999999',
'role' => 'member',
'area_ids' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite"
payload := strings.NewReader("{\n \"phone_number\": \"5511999999999\",\n \"role\": \"member\",\n \"area_ids\": [\n 1\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"5511999999999\",\n \"role\": \"member\",\n \"area_ids\": [\n 1\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://0.0.0.0:3000/v1/organizations/{id}/whatsapp-invite")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"5511999999999\",\n \"role\": \"member\",\n \"area_ids\": [\n 1\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"link": {
"id": 42,
"token": "AbC",
"url": "https://app/invite/AbC"
}
}{
"message": "validation error"
}{
"error": "unauthorized"
}{
"error": "forbidden"
}{
"error": "internal_error"
}{
"error": "bad_gateway",
"message": "Falha ao enviar WhatsApp."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID da organização
Body
application/json
Número no formato E.164 sem '+' (ex.: 5511999999999). Caracteres não-dígitos são removidos automaticamente.
Papel atribuído ao aceitar (default: member).
Available options:
admin, member IDs de áreas às quais o usuário será adicionado após aprovação.
Dias até o link expirar. null = nunca. Default: 7.
Response
Convite enviado