Update a recipient
Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
address
nullable string
Address of the contact.
city
nullable string
City of the contact.
country
nullable string
Two-letter ISO code of the contact country.
job_title
nullable string
Job title of the contact.
name
string
Name of the contact.
organization
nullable string
Organization of the contact.
passcode
string
Passcode for the recipient in order to access the document.
phone
nullable string
Phone of the contact.
postal_code
nullable string
Postal code of the contact.
role
string
Valid document role name.
state
nullable string
State of the contact.
Returns
Returns the recipient object if the update succeeded. Throws an error if update parameters are invalid.
put
/api/documents/{id}/recipients/{id}
curl -X PUT https://{workspace}.documocu.com/api/documents/{id}/recipients/{id} \
-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
}