Skip to main content
PATCH
/
documents
/
{id}
Update an existing Document
curl --request PATCH \
  --url https://commerce.driv.ly/api/documents/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "deal": "<string>",
  "data": {},
  "isSigned": true
}
'
{
  "data": {
    "id": "<string>",
    "data": {},
    "deal": "<string>",
    "isSigned": true
  },
  "success": true
}

Path Parameters

​
id
string
required

Document is uniquely identified by id

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Body

application/json
​
id
string

Document is uniquely identified by id

​
deal

Deal has Document

​
data
object

Document has Data

​
isSigned
boolean

Document is signed

Response

Document Updated

​
data
Document · object
Example:
{
  "id": "doc_5dk39d3j93jd",
  "deal": "Deal ID",
  "data": { "key": "value" },
  "isSigned": true
}
​
success
boolean