Criar Convite
Envia um convite para um novo usuário se juntar à empresa. O convite é enviado para o e-mail informado com o papel (role) especificado.
Regras:
- O
roleIddeve ser um UUID v4 válido de um papel existente na empresa. - O
emaildeve ser um endereço de e-mail válido. - Não é possível enviar convite para um e-mail que já possui convite pendente ou que já está vinculado à empresa.
curl -X POST "https://api-sandbox.contasimples.com/users/v1/invites" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"roleId": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@company.com"
}'
import requests
import json
url = "https://api-sandbox.contasimples.com/users/v1/invites"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"roleId": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@company.com"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api-sandbox.contasimples.com/users/v1/invites", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"roleId": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@company.com"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"roleId": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@company.com"
}`)
req, err := http.NewRequest("POST", "https://api-sandbox.contasimples.com/users/v1/invites", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api-sandbox.contasimples.com/users/v1/invites')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"roleId": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@company.com"
}'
response = http.request(request)
puts response.body
{
"message": "Invite created."
}
{
"error": "Bad Request",
"message": "Um ou mais parâmetros da requisição são inválidos.",
"code": 400,
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"details": [
"O campo exemplo deve ter um valor entre 5 e 100.",
"datas devem estar no formato YYYY-MM-DD."
]
}
{
"error": "Unauthorized",
"message": "Token de acesso inválido ou expirado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 401
}
{
"error": "Not Found",
"message": "O recurso solicitado não foi encontrado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 404
}
{
"error": "Internal Server Error",
"message": "Ocorreu um erro inesperado ao processar a solicitação.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 500
}
POST
/users/v1/invites
POST
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token
Bearer Tokenstring
RequiredToken Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato:
Bearer TOKENContent-Typestring
RequiredThe media type of the request body
Options: application/json
roleIdstring
RequiredIdentificador único do papel (role) a ser atribuído ao usuário convidado. Deve ser um UUID v4 válido.
Format: uuid
emailstring
RequiredEndereço de e-mail para o qual o convite será enviado.
Format: email
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
Body
application/json
roleIdstring
RequiredIdentificador único do papel (role) a ser atribuído ao usuário convidado. Deve ser um UUID v4 válido.
Example:
550e8400-e29b-41d4-a716-446655440000Responses
Was this page helpful?