Skip to main content
PATCH
/
attachments
/
{id}
Updates a Attachment
curl --request PATCH \
  --url https://commerce.driv.ly/api/attachments/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "status": "Error",
  "type": "<string>",
  "file": "<string>",
  "serviceOrders": "<string>",
  "orderId": "<string>",
  "transportServiceOrders": [
    123
  ]
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "status": "Error",
    "type": "<string>",
    "file": "<string>",
    "serviceOrders": "<string>",
    "orderId": "<string>",
    "transportServiceOrders": [
      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 { attachments } from '@drivly/commerce'

const sdk = new SDK(...)

const attachments = await sdk.attachments.update(attachmentsId: string, data: attachments): Promise<attachments>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Attachment

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
​
status
enum<string> | null
Available options:
Error,
Sending,
Sent
​
type
string | null
​
file
string | null
​
serviceOrders
string | null
​
orderId
string | null
​
transportServiceOrders
(number | ServiceOrder · object)[] | null

Response

ok

​
doc
Attachment · object
required
​
message
string
required