Skip to main content
PATCH
/
messages
/
{id}
Update an existing Message
curl --request PATCH \
  --url https://commerce.driv.ly/api/messages/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "agent": "<string>",
  "lead": "<string>",
  "salesRep": "<string>",
  "internalEmail": "<string>",
  "externalPhoneNumber": "<string>",
  "externalEmail": "<string>",
  "internalPhoneNumber": "<string>",
  "text": "<string>",
  "templateType": "<string>",
  "template": "<string>",
  "attachments": [
    "<string>"
  ]
}
'
import requests

url = "https://commerce.driv.ly/api/messages/{id}"

payload = {
"id": "<string>",
"agent": "<string>",
"lead": "<string>",
"salesRep": "<string>",
"internalEmail": "<string>",
"externalPhoneNumber": "<string>",
"externalEmail": "<string>",
"internalPhoneNumber": "<string>",
"text": "<string>",
"templateType": "<string>",
"template": "<string>",
"attachments": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
agent: '<string>',
lead: '<string>',
salesRep: '<string>',
internalEmail: '<string>',
externalPhoneNumber: '<string>',
externalEmail: '<string>',
internalPhoneNumber: '<string>',
text: '<string>',
templateType: '<string>',
template: '<string>',
attachments: ['<string>']
})
};

fetch('https://commerce.driv.ly/api/messages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://commerce.driv.ly/api/messages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'agent' => '<string>',
'lead' => '<string>',
'salesRep' => '<string>',
'internalEmail' => '<string>',
'externalPhoneNumber' => '<string>',
'externalEmail' => '<string>',
'internalPhoneNumber' => '<string>',
'text' => '<string>',
'templateType' => '<string>',
'template' => '<string>',
'attachments' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://commerce.driv.ly/api/messages/{id}"

payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"lead\": \"<string>\",\n \"salesRep\": \"<string>\",\n \"internalEmail\": \"<string>\",\n \"externalPhoneNumber\": \"<string>\",\n \"externalEmail\": \"<string>\",\n \"internalPhoneNumber\": \"<string>\",\n \"text\": \"<string>\",\n \"templateType\": \"<string>\",\n \"template\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://commerce.driv.ly/api/messages/{id}")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"lead\": \"<string>\",\n \"salesRep\": \"<string>\",\n \"internalEmail\": \"<string>\",\n \"externalPhoneNumber\": \"<string>\",\n \"externalEmail\": \"<string>\",\n \"internalPhoneNumber\": \"<string>\",\n \"text\": \"<string>\",\n \"templateType\": \"<string>\",\n \"template\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/messages/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"lead\": \"<string>\",\n \"salesRep\": \"<string>\",\n \"internalEmail\": \"<string>\",\n \"externalPhoneNumber\": \"<string>\",\n \"externalEmail\": \"<string>\",\n \"internalPhoneNumber\": \"<string>\",\n \"text\": \"<string>\",\n \"templateType\": \"<string>\",\n \"template\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "agent": "<string>",
    "lead": "<string>",
    "salesRep": "<string>",
    "internalEmail": "<string>",
    "externalPhoneNumber": "<string>",
    "externalEmail": "<string>",
    "internalPhoneNumber": "<string>",
    "text": "<string>",
    "templateType": "<string>",
    "template": "<string>",
    "attachments": [
      "<string>"
    ]
  },
  "success": true
}
{
"error": {
"code": 123,
"message": "<string>"
},
"success": true
}
{
"error": {
"code": 123,
"message": "<string>"
},
"success": true
}
{
"error": {
"code": 123,
"message": "<string>"
},
"success": true
}

Path Parameters

id
string
required

Message 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

Message is uniquely identified by id

agent

Message is written by Agent

lead

Lead sends/receives chat- Message

salesRep

Sales Rep sends/receives Message

internalEmail
string<idn-email>

Message is with Internal Email

externalPhoneNumber
string

Message is with External Phone Number

Pattern: ^\+?1?[- ]?\(?([0-9]{3})\)?[- ]?([0-9]{3})-?([0-9]{4})$
externalEmail
string<idn-email>

Message is with External Email

internalPhoneNumber
string

Message is with Internal Phone Number

Pattern: ^\+?1?[- ]?\(?([0-9]{3})\)?[- ]?([0-9]{3})-?([0-9]{4})$
text
string

Message has Message Text

templateType
string

Message is autofilled by Template Type

template

Message is filled in from Template

attachments
(string | Attachment · object)[]

Message has Attachment

Response

Message Updated

data
Message · object
Example:
{
"id": "msg_kj3l9dks9j20",
"sentAt": "2023-05-14T12:00:00Z",
"content": "Is the vehicle still available?",
"senderId": "cus_9j2k3ls9dj20",
"receiverId": "com_9j3k2dls0j29"
}
success
boolean