Documents

Email several documents again

POST
/v1/ec/documents/email

Queues the email of up to 100 documents, with the rules of sending one: only authorized ones, to each one's recipient or to the addresses in to. It answers with the result for each: one that cannot be sent does not stop the others.

Authorization

AuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids*array<>

The documents, from one to 100.

Items1 <= items <= 100
to?array<>

Who to send them to. If you omit it, each one goes to its document's recipient, in any environment.

Items1 <= items <= 10

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/ec/documents/email" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "6e0346a3-e54d-40e3-9779-4ba1e707e35b"    ]  }'
{  "object": "bulk_email",  "queued": 0,  "refused": 0,  "data": [    {      "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",      "status": "queued",      "to": [        "string"      ],      "reason": "string",      "code": "string",      "params": {        "property1": "string",        "property2": "string"      }    }  ]}