POST
/
recipients
/
batch
cURL
curl -X POST https://api.bodhveda.com/recipients/batch \
  -H "Authorization: Bearer bv_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": [
      { "id": "recipient_123", "name": "Alice Johnson" },
      { "id": "recipient_456", "name": "Bob Smith" },
      { "name": "Bob Smith" }    ]
  }'
{
  "data": {
    "created": [
      {
        "id": "recipient_123"
      }
    ],
    "updated": [
      {
        "id": "recipient_456"
      }
    ],
    "failed": [
      {
        "id": "",
        "batch_index": 2,
        "errors": [
          {
            "message": "ID is required",
            "description": "ID cannot be empty",
            "property_path": "id",
            "invalid_value": ""
          }
        ]
      }
    ]
  }
}
Instead of creating one recipient per HTTP request, we provide a batching endpoint that permits you to create up to 100 recipients in a single API call.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer bv_xxxxxxxxx, where bv_xxxxxxxxx is your API Key with Full access scope.

Body

application/json

Response

200 - application/json

Batch create recipients result

The response is of type any.