Update an SMS activity | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/activity/sms/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "text": "Updated text message!"
}'

{
  "_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_scheduled": null,
  "date_sent": null,
  "date_updated": "2016-10-03T18:00:00.167000+00:00",
  "direction": "outbound",
  "error_message": null,
  "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": "draft",
  "template_id": null,
  "text": "Updated text message!",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": "Tobias Fuenke",
  "updated_by_name": "Tobias Fuenke",
  "user_name": "Tobias Fuenke"
}

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.

curl -X PUT https://api.close.com/api/v1/activity/sms/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "text": "Updated text message!"
}'

{
  "_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_scheduled": null,
  "date_sent": null,
  "date_updated": "2016-10-03T18:00:00.167000+00:00",
  "direction": "outbound",
  "error_message": null,
  "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": "draft",
  "template_id": null,
  "text": "Updated text message!",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": "Tobias Fuenke",
  "updated_by_name": "Tobias Fuenke",
  "user_name": "Tobias Fuenke"
}

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.

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

attachmentslist of objects or nullOptional

contact_idstring or nullOptional

lead_idstring or nullOptional

local_phonestring or nullOptional

Phone number in E.164 format

remote_phonestring or nullOptional

Phone number in E.164 format

statusenumOptional

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 activity, such as a call or an SMS message.

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 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

Status of a message, such as Email or SMS.

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

$	curl -X PUT https://api.close.com/api/v1/activity/sms/id/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"text": "Updated text message!"
>	}'

1	{
2	"_type": "SMS",
3	"activity_at": "2016-10-03T16:06:11.167000+00:00",
4	"contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
5	"cost": "1",
6	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
7	"date_created": "2016-10-03T16:06:11.167000+00:00",
8	"date_scheduled": null,
9	"date_sent": null,
10	"date_updated": "2016-10-03T18:00:00.167000+00:00",
11	"direction": "outbound",
12	"error_message": null,
13	"id": "acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp",
14	"lead_id": "lead_iuSXNk1x3446ggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
15	"local_country_iso": "US",
16	"local_phone": "+14154445555",
17	"local_phone_formatted": "+1 415-444-5555",
18	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
19	"remote_country_iso": "US",
20	"remote_phone": "+18183334444",
21	"remote_phone_formatted": "+1 818-333-4444",
22	"source": "Close.io",
23	"status": "draft",
24	"template_id": null,
25	"text": "Updated text message!",
26	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
27	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
28	"users": [],
29	"created_by_name": "Tobias Fuenke",
30	"updated_by_name": "Tobias Fuenke",
31	"user_name": "Tobias Fuenke"
32	}