Skip to main content
POST
/
api
/
v1
/
ops
/
members
Create Member
curl --request POST \
  --url https://api.example.com/api/v1/ops/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneIso": "BR",
  "phoneDdi": "55",
  "phoneNumber": "99999999999",
  "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "email": "novo@example.com"
}
'
import requests

url = "https://api.example.com/api/v1/ops/members"

payload = {
"phoneIso": "BR",
"phoneDdi": "55",
"phoneNumber": "99999999999",
"roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"email": "novo@example.com"
}
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({
phoneIso: 'BR',
phoneDdi: '55',
phoneNumber: '99999999999',
roleId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
email: 'novo@example.com'
})
};

fetch('https://api.example.com/api/v1/ops/members', 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.example.com/api/v1/ops/members",
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([
'phoneIso' => 'BR',
'phoneDdi' => '55',
'phoneNumber' => '99999999999',
'roleId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
'email' => 'novo@example.com'
]),
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.example.com/api/v1/ops/members"

payload := strings.NewReader("{\n \"phoneIso\": \"BR\",\n \"phoneDdi\": \"55\",\n \"phoneNumber\": \"99999999999\",\n \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n \"email\": \"novo@example.com\"\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.example.com/api/v1/ops/members")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phoneIso\": \"BR\",\n \"phoneDdi\": \"55\",\n \"phoneNumber\": \"99999999999\",\n \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n \"email\": \"novo@example.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/ops/members")

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 \"phoneIso\": \"BR\",\n \"phoneDdi\": \"55\",\n \"phoneNumber\": \"99999999999\",\n \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n \"email\": \"novo@example.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "title": "204-Member invite sent"
}
{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}
{
"message": "Missing or invalid access token",
"statusCode": 401
}
{
"message": "Insufficient permissions",
"statusCode": 403
}
{
"message": "Internal Server Error",
"statusCode": 500
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Create member payload

phoneIso
string
required

Phone ISO country code

Example:

"BR"

phoneDdi
string
required

International dialing code

Example:

"55"

phoneNumber
string
required

Phone number without country code

Example:

"99999999999"

roleId
string<uuid>
required

Role identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

email
string<email> | null

Invitee email

Example:

"novo@example.com"

Response

Member invite sent