Update Permanent Supporting Document#
Update the external reference of a single Permanent Supporting Document owned by your account.
Only external_reference_id can be updated. The files, template, identity,
and created_at values cannot be changed. To replace the document content, template, or
identity, create a new Permanent Supporting Document;
creating a document for the same template and identity supersedes the previous one.
Request#
HTTP Method: PATCH
URI Path: /v3/permanent_supporting_documents/{id}
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Permanent Supporting Document. |
Request Body Object Attributes#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
external_reference_id |
|
No |
Optional identifier for the permanent supporting document in the customer’s external system. Maximum length is 100 characters. |
Examples#
http
PATCH /v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"id": "d1a1a686-969a-4c02-954c-ae500ba74a1d",
"type": "permanent_supporting_documents",
"attributes": {
"external_reference_id": "test"
}
}
}
curl
curl -i -X PATCH https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"external_reference_id": "test"}, "id": "d1a1a686-969a-4c02-954c-ae500ba74a1d", "type": "permanent_supporting_documents"}}'
response
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "d1a1a686-969a-4c02-954c-ae500ba74a1d",
"type": "permanent_supporting_documents",
"attributes": {
"created_at": "2021-03-28T18:51:59.590Z",
"external_reference_id": "test"
},
"relationships": {
"template": {
"links": {
"self": "https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/template",
"related": "https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/template"
}
},
"identity": {
"links": {
"self": "https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/identity",
"related": "https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/identity"
}
}
}
},
"meta": {
"api_version": "2026-04-16"
}
}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
400 |
No |
|
401 |
No |