Usuários
Convidar usuário para a empresa
A API não cria usuários diretamente. A pessoa entra na empresa por convite, porque é ela
quem define a própria senha. O vínculo começa pendente (approved: false) e passa a valer
quando a pessoa aceita o convite pelo e-mail.
Se o e-mail já tiver conta no sistema, o convite apenas vincula essa conta à empresa.
O token precisa da permissão users: POST. O convite fica registrado em nome do
administrador que criou o token.
Disponível apenas em instalações self-service. Nas demais, a resposta é
403 ERR_SELF_SERVICE_DISABLED.
POST
/
users
/
invites
Convidar usuário para a empresa
curl --request POST \
--url https://api.connectadesk.com/api/v1/users/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "marina@exemplo.com.br",
"profileId": 21,
"name": "Gabriel Goulart",
"queueIds": [
7
],
"channelsIds": [
4
],
"maxOpenTickets": 5
}
'import requests
url = "https://api.connectadesk.com/api/v1/users/invites"
payload = {
"email": "marina@exemplo.com.br",
"profileId": 21,
"name": "Gabriel Goulart",
"queueIds": [7],
"channelsIds": [4],
"maxOpenTickets": 5
}
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({
email: 'marina@exemplo.com.br',
profileId: 21,
name: 'Gabriel Goulart',
queueIds: [7],
channelsIds: [4],
maxOpenTickets: 5
})
};
fetch('https://api.connectadesk.com/api/v1/users/invites', 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://api.connectadesk.com/api/v1/users/invites",
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([
'email' => 'marina@exemplo.com.br',
'profileId' => 21,
'name' => 'Gabriel Goulart',
'queueIds' => [
7
],
'channelsIds' => [
4
],
'maxOpenTickets' => 5
]),
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 := "https://api.connectadesk.com/api/v1/users/invites"
payload := strings.NewReader("{\n \"email\": \"marina@exemplo.com.br\",\n \"profileId\": 21,\n \"name\": \"Gabriel Goulart\",\n \"queueIds\": [\n 7\n ],\n \"channelsIds\": [\n 4\n ],\n \"maxOpenTickets\": 5\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("https://api.connectadesk.com/api/v1/users/invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"marina@exemplo.com.br\",\n \"profileId\": 21,\n \"name\": \"Gabriel Goulart\",\n \"queueIds\": [\n 7\n ],\n \"channelsIds\": [\n 4\n ],\n \"maxOpenTickets\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/users/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"marina@exemplo.com.br\",\n \"profileId\": 21,\n \"name\": \"Gabriel Goulart\",\n \"queueIds\": [\n 7\n ],\n \"channelsIds\": [\n 4\n ],\n \"maxOpenTickets\": 5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 3,
"email": "gabriel@exemplo.com.br",
"name": "Gabriel Goulart",
"profile": {
"id": 20,
"name": "Admin"
},
"isOwner": false,
"active": true,
"online": true,
"approved": true,
"maxOpenTickets": 15,
"lastLogin": "2026-08-19T08:12:00.000Z",
"queues": [
{
"id": 13,
"name": "Comercial"
}
],
"createdAt": "2026-01-08T12:00:00.000Z",
"updatedAt": "2026-08-19T08:30:00.000Z"
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O campo `number` é obrigatório."
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O parâmetro `application` é obrigatório e aceita \"contact\" ou \"card\"."
}
}Autorizações
Token da API no formato sk_live_….
Corpo
application/json
E-mail da pessoa que vai receber o convite.
Exemplo:
"marina@exemplo.com.br"
Perfil de permissões da pessoa nesta empresa. Use o id de GET /profiles.
Um id que não é desta empresa responde 422 ERR_API_PROFILE_NOT_FOUND.
Exemplo:
21
Forma antiga de escolher o perfil, mantida para as integrações que já a usam. Prefira profileId.
| valor | significado |
|---|---|
admin | Perfil padrão Admin da empresa. |
user | Perfil padrão Atendente da empresa. |
Se profileId também for enviado, vale o profileId. Sem nenhum dos dois, a pessoa entra como Atendente.
Opções disponíveis:
admin, user Nome exibido na empresa. Se não for enviado, é usado o nome da conta.
Exemplo:
"Gabriel Goulart"
Filas em que a pessoa vai atender.
Exemplo:
[7]
Canais que a pessoa pode ver.
Exemplo:
[4]
Limite de atendimentos simultâneos. Se não for enviado, não há limite.
Exemplo:
5
Idioma do e-mail de convite enviado à pessoa:
| valor | significado |
|---|---|
pt-BR | Português do Brasil. |
en-US | Inglês. |
Opções disponíveis:
pt-BR, en-US Resposta
Convite enviado. Devolve o vínculo recém-criado, no mesmo formato de
GET /users/{id}, com approved: false até a pessoa aceitar o convite pelo e-mail. O id
retornado já é o id do vínculo e pode ser usado nas próximas chamadas.
Usuário do ponto de vista da empresa. O id é o do usuário nesta empresa, e o email é o da conta da pessoa. Nome, perfil, ativação, presença e limite de atendimentos são definidos por empresa, então o mesmo usuário pode ter valores diferentes em cada empresa.
Contas de super admin nunca aparecem.
Show child attributes
Show child attributes
Exemplo:
{
"id": 3,
"email": "gabriel@exemplo.com.br",
"name": "Gabriel Goulart",
"profile": { "id": 20, "name": "Admin" },
"isOwner": false,
"active": true,
"online": true,
"approved": true,
"maxOpenTickets": 15,
"lastLogin": "2026-08-19T08:12:00.000Z",
"queues": [{ "id": 13, "name": "Comercial" }],
"createdAt": "2026-01-08T12:00:00.000Z",
"updatedAt": "2026-08-19T08:30:00.000Z"
}
⌘I
Convidar usuário para a empresa
curl --request POST \
--url https://api.connectadesk.com/api/v1/users/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "marina@exemplo.com.br",
"profileId": 21,
"name": "Gabriel Goulart",
"queueIds": [
7
],
"channelsIds": [
4
],
"maxOpenTickets": 5
}
'import requests
url = "https://api.connectadesk.com/api/v1/users/invites"
payload = {
"email": "marina@exemplo.com.br",
"profileId": 21,
"name": "Gabriel Goulart",
"queueIds": [7],
"channelsIds": [4],
"maxOpenTickets": 5
}
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({
email: 'marina@exemplo.com.br',
profileId: 21,
name: 'Gabriel Goulart',
queueIds: [7],
channelsIds: [4],
maxOpenTickets: 5
})
};
fetch('https://api.connectadesk.com/api/v1/users/invites', 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://api.connectadesk.com/api/v1/users/invites",
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([
'email' => 'marina@exemplo.com.br',
'profileId' => 21,
'name' => 'Gabriel Goulart',
'queueIds' => [
7
],
'channelsIds' => [
4
],
'maxOpenTickets' => 5
]),
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 := "https://api.connectadesk.com/api/v1/users/invites"
payload := strings.NewReader("{\n \"email\": \"marina@exemplo.com.br\",\n \"profileId\": 21,\n \"name\": \"Gabriel Goulart\",\n \"queueIds\": [\n 7\n ],\n \"channelsIds\": [\n 4\n ],\n \"maxOpenTickets\": 5\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("https://api.connectadesk.com/api/v1/users/invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"marina@exemplo.com.br\",\n \"profileId\": 21,\n \"name\": \"Gabriel Goulart\",\n \"queueIds\": [\n 7\n ],\n \"channelsIds\": [\n 4\n ],\n \"maxOpenTickets\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/users/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"marina@exemplo.com.br\",\n \"profileId\": 21,\n \"name\": \"Gabriel Goulart\",\n \"queueIds\": [\n 7\n ],\n \"channelsIds\": [\n 4\n ],\n \"maxOpenTickets\": 5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 3,
"email": "gabriel@exemplo.com.br",
"name": "Gabriel Goulart",
"profile": {
"id": 20,
"name": "Admin"
},
"isOwner": false,
"active": true,
"online": true,
"approved": true,
"maxOpenTickets": 15,
"lastLogin": "2026-08-19T08:12:00.000Z",
"queues": [
{
"id": 13,
"name": "Comercial"
}
],
"createdAt": "2026-01-08T12:00:00.000Z",
"updatedAt": "2026-08-19T08:30:00.000Z"
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O campo `number` é obrigatório."
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O parâmetro `application` é obrigatório e aceita \"contact\" ou \"card\"."
}
}