Skip to main content
PATCH
/
documents
/
{id}
Updates a Document
curl --request PATCH \
  --url https://commerce.driv.ly/api/documents/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "email": "<string>",
  "notes": "<string>",
  "attachments": "<string>",
  "createdBy": 123
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "email": "<string>",
    "notes": "<string>",
    "attachments": "<string>",
    "createdBy": 123
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { documents } from '@drivly/commerce'

const sdk = new SDK(...)

const documents = await sdk.documents.update(documentsId: string, data: documents): Promise<documents>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Document

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
email
string | null
​
notes
string | null
​
attachments
string | null
​
createdBy
number

Response

ok

​
doc
Document · object
required
​
message
string
required