Create an SMS activity | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/activity/sms/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "status": "inbox",
  "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
  "direction": "inbound",
  "lead_id": "lead_iuSXNk1x3446ggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
  "local_phone": "+14154445555",
  "remote_phone": "+18183334444",
  "source": "External",
  "text": "Hi! This is a reminder that we have a call scheduled for 12pm PT today."
}'

{
  "_type": "SMS",
  "activity_at": "2016-10-03T16:06:11.167000+00:00",
  "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
  "cost": "1",
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2016-10-03T16:06:11.167000+00:00",
  "date_updated": "2016-10-03T16:06:11.167000+00:00",
  "direction": "outbound",
  "id": "acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp",
  "lead_id": "lead_iuSXNk1x3446ggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
  "local_country_iso": "US",
  "local_phone": "+14154445555",
  "local_phone_formatted": "+1 415-444-5555",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "remote_country_iso": "US",
  "remote_phone": "+18183334444",
  "remote_phone_formatted": "+1 818-333-4444",
  "source": "Close.io",
  "status": "outbox",
  "text": "Hi! This is a reminder that we have a call scheduled for 12pm PT today.",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": "Tobias Fuenke",
  "updated_by_name": "Tobias Fuenke",
  "user_name": "Tobias Fuenke"
}

status must be one of the following:

inbox to log an already received SMS.
draft to create a draft SMS.
scheduled to send an SMS at a scheduled date and time, which must be specified in the date_scheduled field.
outbox to actually send an SMS. To delay SMS sending by a few seconds (to allow undo), specify send_in in seconds (must be less than 60).
sent to log an already sent SMS.

Only drafts can be modified, and their status can be changed to scheduled (to send later) or outbox (to send immediately). Scheduled SMS, or SMS in outbox that weren’t sent yet can be canceled by setting the status back to draft.

You have to provide a local_phone that will be used to send the SMS. The number you choose has to be associated with a Phone Number of type internal. See the Phone Numbers paragraph for more details.

A template_id referencing an SMS Template may be provided instead of text to automatically render that template and use the content as text.

When direction is not provided, but status="inbox", direction will default to “inbound”. Otherwise, direction defaults to “outbound”.

When creating a new SMS with the status set to inbox, you can pass the query parameter send_to_inbox with the value of true to create a corresponding Inbox Notification for the SMS.

*status* must be one of the following: - `inbox` to log an already received SMS. - `draft` to create a draft SMS. - `scheduled` to send an SMS at a scheduled date and time, which must be specified in the `date_scheduled` field. - `outbox` to actually **send** an SMS. To delay SMS sending by a few seconds (to allow undo), specify `send_in` in seconds (must be less than 60). - `sent` to log an already sent SMS. Only drafts can be modified, and their status can be changed to `scheduled` (to send later) or `outbox` (to send immediately). Scheduled SMS, or SMS in outbox that weren't sent yet can be canceled by setting the status back to `draft`. You have to provide a `local_phone` that will be used to send the SMS. The number you choose has to be associated with a Phone Number of type `internal`. See the [Phone Numbers](/resources/phone-numbers/) paragraph for more details. A `template_id` referencing an SMS Template may be provided instead of `text` to automatically render that template and use the content as `text`. When `direction` is not provided, but `status="inbox"`, `direction` will default to "inbound". Otherwise, `direction` defaults to "outbound". When creating a new SMS with the status set to `inbox`, you can pass the query parameter `send_to_inbox` with the value of `true` to create a corresponding Inbox Notification for the SMS.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

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

Query parameters

send_to_inboxbooleanOptional

Request

This endpoint expects an object.

statusenumRequired

activity_atdatetime or nullOptional

attachmentslist of objects or nullOptional

contact_idstring or nullOptional

created_by_idstring or nullOptional

date_createddatetime or nullOptional

directionenumOptional

Allowed values:

lead_idstring or nullOptional

local_phonestring or nullOptional

Phone number in E.164 format

organization_idstring or nullOptional

remote_phonestring or nullOptional

Phone number in E.164 format

sourceenumOptional

Allowed values:

template_idstring or nullOptional

textstring or nullOptional

user_idstring or nullOptional

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

coststring or null

created_bystring or null

date_createddatetime

date_scheduleddatetime or null

date_sentdatetime or null

date_updateddatetime

directionenum

Direction of a phone call or an SMS message. If you want to use this for a new activity, consider more generic CommunicationDirection instead.

Allowed values:

error_messagestring or null

idstring

lead_idstring or null

local_country_isostring or null

local_phonestring or null

local_phone_formattedstring or null

organization_idstring

remote_country_isostring or null

remote_phonestring or null

remote_phone_formattedstring or null

sourceenum

Source of a phone call or an SMS message.

Allowed values:

statusenum

Status of a message, such as Email or SMS. This set of statuses should be enough to support features such as "send later" or "undo send".

template_idstring or null

textstring or null

updated_bystring or null

user_idstring or null

userslist of strings

agent_action_reasonstring or null

agent_config_idstring or null

created_by_namestring or null

sequence_idstring or null

sequence_namestring or null

sequence_subscription_idstring or null

updated_by_namestring or null

user_namestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

status must be one of the following:

inbox to log an already received SMS.
draft to create a draft SMS.
scheduled to send an SMS at a scheduled date and time, which must be specified in the date_scheduled field.
outbox to actually send an SMS. To delay SMS sending by a few seconds (to allow undo), specify send_in in seconds (must be less than 60).
sent to log an already sent SMS.

A template_id referencing an SMS Template may be provided instead of text to automatically render that template and use the content as text.

When direction is not provided, but status="inbox", direction will default to “inbound”. Otherwise, direction defaults to “outbound”.

When creating a new SMS with the status set to inbox, you can pass the query parameter send_to_inbox with the value of true to create a corresponding Inbox Notification for the SMS.