Skip to main content
POST
/
team
/
members
Invite a member
curl --request POST \
  --url https://api.safarapi.com/api/partner/v1/team/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>' \
  --data '
{
  "email": "teammate@bank.ma",
  "first_name": "Sara",
  "last_name": "Benali",
  "role": "DEVELOPER"
}
'
import requests

url = "https://api.safarapi.com/api/partner/v1/team/members"

payload = {
    "email": "teammate@bank.ma",
    "first_name": "Sara",
    "last_name": "Benali",
    "role": "DEVELOPER"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Timestamp": "<x-timestamp>",
    "X-Signature": "<x-signature>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Timestamp': '<x-timestamp>',
    'X-Signature': '<x-signature>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'teammate@bank.ma',
    first_name: 'Sara',
    last_name: 'Benali',
    role: 'DEVELOPER'
  })
};

fetch('https://api.safarapi.com/api/partner/v1/team/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.safarapi.com/api/partner/v1/team/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([
    'email' => 'teammate@bank.ma',
    'first_name' => 'Sara',
    'last_name' => 'Benali',
    'role' => 'DEVELOPER'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-Signature: <x-signature>",
    "X-Timestamp: <x-timestamp>"
  ],
]);

$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.safarapi.com/api/partner/v1/team/members"

	payload := strings.NewReader("{\n  \"email\": \"teammate@bank.ma\",\n  \"first_name\": \"Sara\",\n  \"last_name\": \"Benali\",\n  \"role\": \"DEVELOPER\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Timestamp", "<x-timestamp>")
	req.Header.Add("X-Signature", "<x-signature>")
	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.safarapi.com/api/partner/v1/team/members")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-Timestamp", "<x-timestamp>")
  .header("X-Signature", "<x-signature>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"teammate@bank.ma\",\n  \"first_name\": \"Sara\",\n  \"last_name\": \"Benali\",\n  \"role\": \"DEVELOPER\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.safarapi.com/api/partner/v1/team/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Timestamp"] = '<x-timestamp>'
request["X-Signature"] = '<x-signature>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"teammate@bank.ma\",\n  \"first_name\": \"Sara\",\n  \"last_name\": \"Benali\",\n  \"role\": \"DEVELOPER\"\n}"

response = http.request(request)
puts response.read_body
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "email": "jsmith@example.com", "enabled": true, "is_you": true, "first_name": "<string>", "last_name": "<string>", "created_at": "2023-11-07T05:31:56Z" }

Authorizations

Authorization
string
header
default:sk_test_DEMO0000_replace_with_your_sandbox_key
required

API key authentication. Issued by the Safariat admin or via the partner portal. The secret is shown only once at generation.

Production sk_live_* keys must additionally sign every write request (POST/PUT/DELETE) with the X-Timestamp and X-Signature headers. Sandbox sk_test_* keys are exempt from request signing: X-Signature and X-Timestamp are not required for writes in the sandbox (so the developer-portal "Try it" playground works end to end). The Idempotency-Key header remains required on writes in both environments.

Headers

Idempotency-Key
string
required

Opaque, client-generated string unique per logical operation (a UUID v4 is recommended but any non-blank value up to 255 chars is accepted). Same key + same body = the cached response is returned with the Idempotent-Replayed: true header. Same key + different body = 409 Conflict. Retained for 24 h.

Maximum string length: 255
X-Timestamp
integer<int64>
required

Unix timestamp in seconds at the time the request is issued. Validity window ±5 minutes — beyond that the request is rejected. Required for production sk_live_* keys only; not required for sandbox sk_test_* keys.

X-Signature
string
required

hex(HMAC_SHA256(secret, "{X-Timestamp}\n{METHOD}\n{path}\n{body}")). The path includes the query string. The body is the exact JSON representation sent — any reformatting invalidates the signature. Required for production sk_live_* keys only; not required for sandbox sk_test_* keys.

Pattern: ^[a-f0-9]{64}$

Body

application/json
email
string<email>
required
Maximum string length: 200
first_name
string
required
Maximum string length: 50
last_name
string
required
Maximum string length: 50
role
enum<string>
required

Console role (an actual Keycloak realm role). PARTNER_ADMIN = full access (manages team + API keys); FINANCE = settlements + bookings; DEVELOPER = catalog/quotes/bookings/webhooks/audit; VIEWER = read-only.

Available options:
PARTNER_ADMIN,
FINANCE,
DEVELOPER,
VIEWER

Response

Member invited

id
string<uuid>
required

Keycloak user identifier.

email
string<email>
required
role
enum<string>
required

Console role (an actual Keycloak realm role). PARTNER_ADMIN = full access (manages team + API keys); FINANCE = settlements + bookings; DEVELOPER = catalog/quotes/bookings/webhooks/audit; VIEWER = read-only.

Available options:
PARTNER_ADMIN,
FINANCE,
DEVELOPER,
VIEWER
enabled
boolean
required

Active account (false = disabled).

is_you
boolean
required

true if this is the member authenticated on the current request.

first_name
string | null
last_name
string | null
created_at
string<date-time> | null