Skip to main content

Create a recipient

Create a recipient in the document. If the email does not match with existing contact, a new contact will be created also.

Parameters​

email
string
required
Email of the recipient.
name
string
required
Name of the recipient.
passcode
string
Passcode for the recipient in order to access the document.
role
string
Valid document role name.

Returns​

Returns the created recipient object. Throws an error if some parameters are not valid.

post
/api/documents/{id}/recipients
curl -X POST https://{workspace}.documocu.com/api/documents/{id}/recipients \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "address": null,
  "city": null,
  "color": "#83f793",
  "contact": "con_itw5atndlebaj0wguoerhbpn",
  "country": null,
  "created_at": "2024-05-14T08:36:49+00:00",
  "email": "[email protected]",
  "first_name": "Brielle",
  "full_name": "Brielle Turner",
  "id": "1e3b4f50-10ba-3c60-83db-69ab768b8e53",
  "is_signer": false,
  "job_title": null,
  "last_name": "Turner",
  "organization": null,
  "passcode": null,
  "phone_number": null,
  "postal_code": null,
  "role": "Sender",
  "sent_at": null,
  "signed_at": null,
  "state": null,
  "updated_at": "2024-05-14T08:36:49+00:00",
  "viewed_at": null
}