curl --request POST \
  --url https://api.usecleff.com/v1/beneficiaries/collection-invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiary_ids": [
    "<string>"
  ],
  "message": "<string>",
  "display_name": "<string>"
}
'

import requests

url = "https://api.usecleff.com/v1/beneficiaries/collection-invites"

payload = {
    "beneficiary_ids": ["<string>"],
    "message": "<string>",
    "display_name": "<string>"
}
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({beneficiary_ids: ['<string>'], message: '<string>', display_name: '<string>'})
};

fetch('https://api.usecleff.com/v1/beneficiaries/collection-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.usecleff.com/v1/beneficiaries/collection-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([
    'beneficiary_ids' => [
        '<string>'
    ],
    'message' => '<string>',
    'display_name' => '<string>'
  ]),
  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.usecleff.com/v1/beneficiaries/collection-invites"

	payload := strings.NewReader("{\n  \"beneficiary_ids\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"display_name\": \"<string>\"\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.usecleff.com/v1/beneficiaries/collection-invites")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiary_ids\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"display_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usecleff.com/v1/beneficiaries/collection-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  \"beneficiary_ids\": [\n    \"<string>\"\n  ],\n  \"message\": \"<string>\",\n  \"display_name\": \"<string>\"\n}"

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

{
  "invited": [
    "<string>"
  ]
}

{
  "error": {
    "code": "validation_failed",
    "message": "Request validation failed",
    "request_id": "req_abc123",
    "occurred_at": "2026-07-07T12:00:00.000Z",
    "actor": {
      "user_id": "usr_...",
      "membership_id": "mem_...",
      "role": "business_admin",
      "environment": "sandbox"
    },
    "details": [
      {
        "field": "beneficiary_ids",
        "code": "is_required",
        "message": "beneficiary_ids should not be null or undefined"
      }
    ],
    "docs_url": "https://docs.usecleff.com/errors#validation_failed"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "request_id": "req_abc123",
    "occurred_at": "2026-07-07T12:00:00.000Z",
    "actor": null,
    "docs_url": "https://docs.usecleff.com/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden resource",
    "request_id": "req_abc123",
    "occurred_at": "2026-07-07T12:00:00.000Z",
    "actor": {
      "user_id": "usr_...",
      "membership_id": "mem_...",
      "role": "business_read_only",
      "environment": "sandbox"
    },
    "docs_url": "https://docs.usecleff.com/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Beneficiary 3f9c2b1a-6d4e-4f8a-b2c7-9e1d0a5b7c3f not found",
    "request_id": "req_abc123",
    "occurred_at": "2026-07-07T12:00:00.000Z",
    "actor": {
      "user_id": "usr_...",
      "membership_id": "mem_...",
      "role": "business_admin",
      "environment": "sandbox"
    },
    "docs_url": "https://docs.usecleff.com/errors#not_found"
  }
}

{
  "error": {
    "code": "BENEFICIARY_ARCHIVED",
    "message": "Beneficiary is archived and accepts no new Payouts, links or bank details",
    "request_id": "req_abc123",
    "occurred_at": "2026-07-07T12:00:00.000Z",
    "actor": {
      "user_id": "usr_...",
      "membership_id": "mem_...",
      "role": "business_admin",
      "environment": "sandbox"
    },
    "docs_url": "https://docs.usecleff.com/errors#beneficiary_archived"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Slow down and retry after the window.",
    "request_id": "req_abc123",
    "occurred_at": "2026-07-07T12:00:00.000Z",
    "actor": null,
    "docs_url": "https://docs.usecleff.com/errors#rate_limited"
  }
}