---
title: "Add recipients to a collection"
method: POST
path: "/api/v1/rest/raccolta/collections/{id}/recipients"
tags: ["Document collection"]
---

# Add recipients to a collection

`POST /api/v1/rest/raccolta/collections/{id}/recipients`

## Request

- Base URL: `https://api.custodo.ai`
- URL: `https://api.custodo.ai/api/v1/rest/raccolta/collections/{id}/recipients`
- Auth: HTTP bearer

Adds people to a raccolta, deduplicated by address (or, on WhatsApp, by number) against the ones already in it. A raccolta by email needs each one’s `email`, one on WhatsApp their `whatsapp` number; one without it is skipped and counted. On an active raccolta the new ones are sent on the next raccolta_send_collection.

## Path parameters

- `id` string, uuid, required

## Headers

- `X-Tenant-Id` string, uuid

## Request body

- object
  - `recipients` object[], required
    - `name` string, required
    - `email` string, email
    - `whatsapp` string: The WhatsApp number as written: «+39 333 123 4567», «333 1234567».
    - `party_id` string, uuid: The recipient’s anagrafica in the register (Anagrafiche module), e.g. from anagrafiche_search_parties. Optional: an id that is not a live anagrafica you may see is ignored, and an address that is the email or PEC of exactly one anagrafica is linked to it anyway.

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `404`: Nothing with that id in this organisation.
- `409`: The record is in a state that does not allow it — under legal hold, already sent, already closed. `error.code` says which.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)