Update Envelope Metadata (POST /v2.0/envelopes/{envelopeId}/update_envelope_metadata)
Update metadata for a specified envelope.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| name | String | No | Envelope name to be updated. |
| description | String | No | Envelope description to be updated. |
| categories | Array | No | Envelope categories to be updated. Previously added categories will be overwritten. |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | Envelope updated successfully |
Response Body Data Fields
| Field | Always preset | Description |
|---|---|---|
| envelope_id | Yes | ID of envelope whose metadata was updated. |
Sample Success Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/14ece348-46cd-4ed0-afb6-59908ace2d9e/update_envelope_metadata' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
--header 'Content-Type: application/json' \
--data-raw '{
"name" : "Envelope Name",
"description" : "Envelope Description",
"categories" : ["Category-1", "Category-2"]
}'
RESPONSE:
{
"message": "Envelope updated successfully",
"data": {
"envelope_id": 14ece348-46cd-4ed0-afb6-59908ace2d9e",
}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/14ece348-46cd-4ed0-afb6-59908ace2d9e/update_envelope_metadata' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
--header 'Content-Type: application/json' \
--data-raw '{
"name" : "Envelope Name",
"description" : "Envelope Description",
"categories" : ["Category-1", "Category-2"]
}'
RESPONSE:
{
"errors": [
{
"error_code": "ENVELOPE_UPDATE_FAILED",
"developer_message": "Failed to update envelope metadata."
}
]
}
Note: View the full list of applicable error code for this method here.