---
title: "Update an SMS activity"
method: PUT
path: "/activity/sms/{id}/"
tags: ["activities.sms"]
---

# Update an SMS activity

`PUT /activity/sms/{id}/`

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.

## Path parameters

- `id` string, required

## Request body

- UpdateSMSActivity
  - `activity_at` string, date-time, nullable
  - `attachments` object[], nullable
    - `content_type` 'application/pdf' | 'application/vcard' | 'audio/3gpp' | 'audio/3gpp2' | 'audio/L24' | 'audio/ac3' | 'audio/amr' | 'audio/amr-nb' | 'audio/basic' | 'audio/mp4' | 'audio/mpeg' | 'audio/ogg' | 'audio/vnd.rn-realaudio' | 'audio/vnd.wave' | 'audio/webm' | 'image/bmp' | 'image/gif' | 'image/jpeg' | 'image/jpg' | 'image/png' | 'image/tiff' | 'text/calendar' | 'text/csv' | 'text/directory' | 'text/richtext' | 'text/rtf' | 'text/vcard' | 'text/x-vcard' | 'video/3gpp' | 'video/3gpp-tt' | 'video/3gpp2' | 'video/H261' | 'video/H263' | 'video/H263-1998' | 'video/H263-2000' | 'video/H264' | 'video/mp4' | 'video/mpeg' | 'video/quicktime' | 'video/webm', required
    - `filename` string, required
    - `url` string, required
  - `contact_id` string, nullable
  - `lead_id` string, nullable
  - `local_phone` string, nullable — Phone number in E.164 format
  - `remote_phone` string, nullable — Phone number in E.164 format
  - `status` 'inbox' | 'draft' | 'scheduled' | 'outbox' | 'sent' | 'error'
  - `template_id` string, nullable
  - `text` string, nullable
  - `user_id` string, nullable

## Response `200`

Successful response

- SMSActivity
  - `_type` string, required
  - `activity_at` string, date-time, nullable, required
  - `agent_action_reason` string, nullable
  - `agent_config_id` string, nullable
  - `contact_id` string, nullable, required
  - `cost` string, nullable, required
  - `created_by` string, nullable, required
  - `created_by_name` string, nullable
  - `date_created` string, date-time, required
  - `date_scheduled` string, date-time, nullable, required
  - `date_sent` string, date-time, nullable, required
  - `date_updated` string, date-time, required
  - `direction` 'inbound' | 'outbound', required — Direction of a phone activity, such as a call or an SMS message.
  - `error_message` string, nullable, required
  - `id` string, required
  - `lead_id` string, nullable, required
  - `local_country_iso` string, nullable, required
  - `local_phone` string, nullable, required
  - `local_phone_formatted` string, nullable, required
  - `organization_id` string, required
  - `remote_country_iso` string, nullable, required
  - `remote_phone` string, nullable, required
  - `remote_phone_formatted` string, nullable, required
  - `sequence_id` string, nullable
  - `sequence_name` string, nullable
  - `sequence_subscription_id` string, 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_id` string, nullable, required
  - `text` string, nullable, required
  - `updated_by` string, nullable, required
  - `updated_by_name` string, nullable
  - `user_id` string, nullable, required
  - `user_name` string, nullable
  - `users` string[], required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found

---

[API](https://skmtc.net/close/apis/close-api.md) · [All operations](https://skmtc.net/close/apis/close-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/close/close-api/revisions/0dcf3303e9d7/schema)
