CLclose
activities.sms

Update an SMS activity

Changed on

This can be used to modify a draft or send it once the draft is complete.

To send an SMS immediately, you can update its status to outbox. To send it at a later time, change the status to scheduled and provide the desired date & time in the date_scheduled field.

put/activity/sms/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/sms/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Request body

activity_atstring date-time nullable
caller_id_mode'fixed' | 'auto' | 'null' nullable
contact_idstring nullable
lead_idstring nullable
local_phonestring nullable

Phone number in E.164 format

remote_phonestring nullable

Phone number in E.164 format

status'inbox' | 'draft' | 'scheduled' | 'outbox' | 'sent' | 'error'
template_idstring nullable
textstring nullable
user_idstring nullable

Response

Successful response

_typestring required
activity_atstring date-time nullable required
agent_action_reasonstring nullable
agent_config_idstring nullable

Deprecated. Use created_by_agent_id instead.

caller_id_mode'fixed' | 'auto' required

How a caller's outbound number is chosen. Fixed uses a single configured number; Auto lets Close select the best number per call/SMS (Managed by Close Caller ID).

caller_id_reason'context' | 'local_presence' | 'fallback' required

Why a number was chosen in Auto mode: reused from a prior communication (context), picked for geographic proximity (local_presence), or the default/oldest fallback.

contact_idstring nullable required
coststring nullable required
created_bystring nullable required
created_by_agent_idstring nullable
created_by_namestring nullable
date_createdstring date-time required
date_scheduledstring date-time nullable required
date_sentstring date-time nullable required
date_updatedstring date-time required
direction'inbound' | 'outbound' required

Direction of a phone activity, such as a call or an SMS message.

error_messagestring nullable required
idstring required
lead_idstring nullable required
local_country_isostring nullable required
local_phonestring nullable required
local_phone_formattedstring nullable required
organization_idstring required
remote_country_isostring nullable required
remote_phonestring nullable required
remote_phone_formattedstring nullable required
sequence_idstring nullable
sequence_namestring nullable
sequence_subscription_idstring nullable
source'Close.io' | 'External' required

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.

status'inbox' | 'draft' | 'scheduled' | 'outbox' | 'sent' | 'error' required

Status of a message, such as Email or SMS.

template_idstring nullable required
textstring nullable required
updated_bystring nullable required
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • cf871955b78fRevision changes
    • info

      added the optional property to the response with the status

    • info

      response property agent_config_id deprecated