Skip to main content
PATCH
/
messages
/
{id}
Updates a Message
curl --request PATCH \
  --url https://commerce.driv.ly/api/messages/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "status": "Send",
  "message": "<string>",
  "phone": "<string>",
  "lead": 123,
  "template": 123,
  "createdTime": "<string>",
  "generated": true,
  "type": "<string>",
  "openphoneMessageId": "<string>"
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "status": "Send",
    "message": "<string>",
    "phone": "<string>",
    "lead": 123,
    "template": 123,
    "createdTime": "<string>",
    "generated": true,
    "type": "<string>",
    "openphoneMessageId": "<string>"
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { messages } from '@drivly/commerce'

const sdk = new SDK(...)

const messages = await sdk.messages.update(messagesId: string, data: messages): Promise<messages>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Message

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
​
status
enum<string> | null
Available options:
Send,
Sent,
Received,
Queued,
Canceled,
Retry,
Manual
​
message
string | null
​
phone
string | null
​
lead
​
template
​
createdTime
string | null
​
generated
boolean | null
​
type
string | null
​
openphoneMessageId
string | null

Response

ok

​
doc
Message · object
required
​
message
string
required