Update a Call activity

PUT

https://api.close.com/api/v1/activity/call/:id/

PUT

/api/v1/activity/call/:id/

curl -X PUT https://api.close.com/api/v1/activity/call/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "note_html": "<body><p>This is some new call note.</p></body>",
  "outcome_id": "outcome_031uY9IKV1JxfNKM9n2qCw"
}'

{
  "_type": "Call",
  "activity_at": "2013-02-01T00:51:33+00:00",
  "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-20T06:34:33.637000+00:00",
  "date_updated": "2013-02-20T06:34:35.656000+00:00",
  "id": "acti_Ay0QqN91HKAHVQUesISYV8QlhDobGfWb1Ui3TE75pJR",
  "lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "outcome_id": "outcome_031uY9IKV1JxfNKM9n2qCw",
  "source": "Close.io",
  "status": "completed",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "call_method": "regular",
  "cost": "2",
  "dialer_id": null,
  "dialer_saved_search_id": null,
  "direction": "outbound",
  "disposition": "answered",
  "duration": 10,
  "local_country_iso": "US",
  "local_phone": "+16505556666",
  "local_phone_formatted": "+1 650-555-6666",
  "note": "This is some new call note.",
  "note_html": "<body><p>This is some new call note.</p></body>",
  "phone": "+16503334444",
  "recording_url": null,
  "remote_country_iso": "US",
  "remote_phone": "+16503334444",
  "remote_phone_formatted": "+1 650-333-4444",
  "voicemail_duration": null,
  "voicemail_url": null
}

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, changing or clearing recording_url or voicemail_url, or setting recording_transcript to null, permanently deletes the corresponding recording, voicemail, or transcript. This 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.

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, changing or clearing `recording_url` or `voicemail_url`, or setting `recording_transcript` to `null`, permanently deletes the corresponding recording, voicemail, or transcript. This 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.

Authentication

AuthorizationBasic

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

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

quality_infostring or nullOptional

recording_urlstring or nullOptionalformat: "uri"

statusenumOptional

user_idstring or nullOptional

voicemail_urlstring or nullOptionalformat: "uri"

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.

statusenum

Current status of the call.

updated_bystring or null

user_idstring or null

userslist of strings

created_by_namestring or nullOptional

sequence_idstring or nullOptional

sequence_namestring or nullOptional

sequence_subscription_idstring or nullOptional

updated_by_namestring or nullOptional

user_namestring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error