Skip to main content
PATCH
/
calls
/
{id}
Update an existing Call
curl --request PATCH \
  --url https://commerce.driv.ly/api/calls/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "externalPhoneNumber": "<string>",
  "internalPhoneNumber": "<string>",
  "ratingNote": "<string>",
  "note": "<string>",
  "rating": 2.5,
  "audioRecording": {},
  "transcript": "<string>",
  "conversationURL": "<string>",
  "time": "2023-11-07T05:31:56Z"
}
'
{
  "data": {
    "id": "<string>",
    "externalPhoneNumber": "<string>",
    "internalPhoneNumber": "<string>",
    "conversationURL": "<string>",
    "time": "2023-11-07T05:31:56Z",
    "ratingNote": "<string>",
    "note": "<string>",
    "rating": 2.5,
    "audioRecording": {},
    "transcript": "<string>"
  },
  "success": true
}

Path Parameters

​
id
string
required

Call 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

Call is uniquely identified by id

​
externalPhoneNumber
string

Call is made with External Phone Number

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

Call is made with Internal Phone Number

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

Call has Rating Note

​
note
string

Call has Note

​
rating
number

Call has Rating

Required range: 0 <= x <= 5Must be a multiple of 0.1
​
audioRecording
object

Call has Audio Recording

​
transcript
string

Call has Transcript

​
conversationURL
string<iri>

Call has Conversation URL

​
time
string<date-time>

Call occurs at Time

Response

Call Updated

​
data
Call · object
Example:
{
  "id": "call_3d9k2j8s7d2k",
  "note": "Follow up with more information",
  "time": "2023-09-20T14:00:00Z",
  "rating": 5,
  "ratingNote": "Excellent call, potential sale",
  "transcript": "Transcript of the call here",
  "audioRecording": { "url": "http://example.com/audio" },
  "conversationURL": "http://example.com/conversation",
  "externalPhoneNumber": "555-6789",
  "internalPhoneNumber": "555-0199"
}
​
success
boolean