Update an SMS activity
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.
A switch of caller_id_mode to auto requires a plan that includes Local Presence. On a plan without it, a draft can use auto only if the draft already uses auto. It can also switch to auto if the sender’s Membership has default_caller_id_mode set to auto. The sender is the user in user_id. If the request has no user_id, the sender is the user of the draft, else the authenticated user. On a plan without Local Presence, Close sends an auto SMS from the default_caller_id of the sender’s Membership. If default_caller_id is unset or cannot send the SMS, Close uses the oldest number that the sender can send from.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Request
When to send the message. Required when status is scheduled, and ignored otherwise.
Seconds to delay sending, to allow undo. Only used when status is outbox.
Response
Type of the activity, e.g. Call, Email or Note.
When the activity happened, e.g. when an Email or SMS was sent. Defaults to date_created.
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).
Why a number was chosen in Auto mode: reused from a prior communication (context), picked for geographic proximity (local_presence), the default/oldest fallback (fallback), or the same fallback because the plan does not include Local Presence (plan_fallback).
ID of the Contact the activity is with, or null if it isn’t with a particular Contact.
ID of the user who created the activity, or null if it wasn’t created by a user.
ID of the activity, e.g. acti_abc123.
ID of the Lead the activity is on. Can be null for Calls and SMS with phone numbers that don’t match any Contact.
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.
ID of the user who last updated the activity, or null if it wasn’t updated by a user.
ID of the user the activity belongs to, e.g. who made the Call or sent the Email. Can be null, e.g. for an incoming SMS to a group number.
Why an agent created the activity, e.g. send_scheduling_link, or null if no agent created it.
ID of the agent that created the activity, or null if no agent created it.
Name of the user in created_by.
ID of the Workflow that created the activity, or null.
Name of the Workflow in sequence_id.
ID of the Workflow subscription, i.e. the Contact’s enrollment in the Workflow, that created the activity, or null.
Name of the user in updated_by.
Name of the user in user_id.
Deprecated. Use created_by_agent_id instead.