Skip to main content
POST
/
invite
cURL
curl --request POST \
  --url https://api.example.com/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "policyId": "<string>",
  "customerId": "<string>",
  "role": "<string>",
  "branchId": "<string>",
  "email": "<string>"
}
'
import requests

url = "https://api.example.com/invite"

payload = {
"policyId": "<string>",
"customerId": "<string>",
"role": "<string>",
"branchId": "<string>",
"email": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
policyId: '<string>',
customerId: '<string>',
role: '<string>',
branchId: '<string>',
email: '<string>'
})
};

fetch('https://api.example.com/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_URL => "https://api.example.com/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([
'policyId' => '<string>',
'customerId' => '<string>',
'role' => '<string>',
'branchId' => '<string>',
'email' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/invite"

payload := strings.NewReader("{\n \"policyId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"role\": \"<string>\",\n \"branchId\": \"<string>\",\n \"email\": \"<string>\"\n}")

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

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/invite")
.header("Content-Type", "application/json")
.body("{\n \"policyId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"role\": \"<string>\",\n \"branchId\": \"<string>\",\n \"email\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/invite")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"policyId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"role\": \"<string>\",\n \"branchId\": \"<string>\",\n \"email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{}

Body

application/json
policyId
string
required

Policy id

customerId
string
required

Customer id

role
string
required

Role for the invitation

branchId
string

Branch id

email
string

Email address

Response

The response is of type object.