Skip to navigation
ActivitiesCalls

Update a Call activity

View as Markdown

Most commonly used to update note_html or outcome_id. Some fields (status, duration, direction) cannot be updated for internal calls made through Close’s VoIP system.

note_html and note: setting one overwrites the other. If both are provided, note_html takes precedence. note_html supports rich-text HTML; note is plaintext only.

Deleting recordings: for internal calls, setting recording_url, voicemail_url, or recording_transcript to null permanently deletes the corresponding recording, voicemail, or transcript. A delete requires the delete_own_activities permission for your own calls, or manage_others_activities for other users’ calls and calls not assigned to a user. Without the required permission, the request fails with a 400 error. Any other new value for recording_url or voicemail_url also fails with a 400 error.

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.
activity_atdatetime or nullOptional
contact_idstring or nullOptional
conversation_type_idstring or nullOptional
durationinteger or nullOptional<=604800
lead_idstring or nullOptional
notestring or nullOptional
note_htmlstring or nullOptional
outcome_idstring or nullOptional
phonestring or nullOptional
Phone number in E.164 format
playbook_idstring or nullOptional
recording_urlstring or nullOptionalformat: "uri"

HTTPS URL of the recording of a call that you log through the API. For a call made through Close, only null can change this field, and it deletes the recording.

statusenumOptional
user_idstring or nullOptional
voicemail_urlstring or nullOptionalformat: "uri"

HTTPS URL of the voicemail that the caller left, for a call that you log through the API. The call must be inbound and completed, with a duration of 0. For a call made through Close, only null can change this field, and it deletes the voicemail.

Response

Successful response
_typestring
activity_atdatetime or null
contact_idstring or null
created_bystring or null
date_createddatetime
date_updateddatetime
idstring
lead_idstring or null
organization_idstring
outcome_idstring or null
sourceenum

Source of a phone activity. Describes whether the phone activity (such as a call or an SMS) was handled by Close’s telephony provider or handled externally by a 3rd party and is merely logged in Close.

Allowed values:
statusenum
Current status of the call.
updated_bystring or null
user_idstring or null
userslist of strings
created_by_namestring or nullOptional
recording_urlstring or nullOptional

URL of the call recording, or null if the call has no recording or the recording expired. A GET request to this URL needs the same authentication as other API requests. The response is a redirect to the audio file. For a call that you logged through the API, the redirect goes to the recording URL that you sent.

sequence_idstring or nullOptional
sequence_namestring or nullOptional
sequence_subscription_idstring or nullOptional
updated_by_namestring or nullOptional
user_namestring or nullOptional
voicemail_urlstring or nullOptional

URL of the voicemail that the caller left on an inbound call, or null if the call has no voicemail. A GET request to this URL needs the same authentication as other API requests. The response is a redirect to the audio file. For a call that you logged through the API, the redirect goes to the voicemail URL that you sent.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error