---
title: "Updates outbox message"
method: PUT
path: "/v1/outbox/messages/{id}"
tags: ["outbox"]
---

# Updates outbox message

`PUT /v1/outbox/messages/{id}`

## Path parameters

- `id` integer, required

## Request body

- OutboxMessageRequest
  - `content` string — message content
  - `subject` string — subject
  - `sender` string — sender
  - `recipients` string[] — recipient list
  - `contactGroupIds` integer[] — contact group id list
  - `selectors` string[] — selectors
  - `sendOn` string, date-time — send on (now if not specified)
  - `timeSpread` integer — time spread in hours
  - `repeat` string — repeat period (hourly, daily, weekly, monthly, yearly)
  - `repeatInterval` integer — repeat interval
  - `repeatIterations` integer — repeat iterations
  - `repeatEndDate` string, date-time — repeat end datetime
  - `deliveryReport` boolean — request delivery report?
  - `smsType` integer — SMS type (0 = default, 1 = flash, 2 = both)
  - `predictedSmsCount` integer — predicted SMS count
  - `contentCategory` string — content category (personal, advertisement or informational
  - `messageType` string — message type (default, sms, voice, rcs, whatsapp
  - `attachmentId` integer — attachment id
  - `urlshorteningType` string — urlshortening type
  - `baseTemplateId` integer — base templateId
  - `customerChannelId` integer — customerChannelId
  - `rcsMessage` RcsMessage
    - `agentMessage` AgentContentMessageDto, required
      - `text` string
      - `fileName` string
      - `richCard` RichCardDto
        - `carouselCard` CarouselCardDto
          - `cardWidth` string
          - `cardContents` CardContentDto[]
            - `title` string
            - `description` string
            - `media` MediaDto
              - …
            - `suggestions` SuggestionDto[]
              - …
        - `standaloneCard` StandaloneCardDto
          - `cardOrientation` string
          - `thumbnailImageAlignment` string
          - `cardContent` CardContentDto
            - `title` string
            - `description` string
            - `media` MediaDto
              - …
            - `suggestions` SuggestionDto[]
              - …
      - `suggestions` SuggestionDto[]
        - `reply` ReplyDto
          - `text` string
          - `postbackData` string
        - `action` ActionDto
          - `text` string
          - `postbackData` string
          - `dialAction` DialActionDto
            - `phoneNumber` string
          - `viewLocationAction` ViewLocationActionDto
            - `latLong` LatLngDto, required
              - …
            - `label` string
            - `query` string
          - `createCalendarEventAction` CreateCalendarEventActionDto
            - `startTime` string
            - `endTime` string
            - `title` string
            - `description` string
          - `openUrlAction` OpenUrlActionDto
            - `application` string
            - `url` string
            - `description` string
            - `webviewViewMode` string
          - `shareLocationAction` ShareLocationActionDto
          - `composeAction` ComposeActionDto
            - `composeTextMessage` ComposeTextMessageDto
              - …
            - `composeRecordingMessage` ComposeRecordingMessageDto
              - …
      - `contentInfo` ContentInfoDto
        - `fileUrl` string
        - `thumbnailUrl` string
        - `forceRefresh` boolean
  - `whatsappMessage` WhatsappMessage
    - `metaWhatsappMessage` MetaWhatsappMessageDto, required
      - `type` string
      - `context` MetaContextDto
        - `message_id` string
      - `status` string
      - `sticker` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `text` MetaWhatsappTextDto
        - `body` string
        - `preview_url` boolean
      - `reaction` MetaWhatsappReactionDto
        - `emoji` string
        - `message_id` string
      - `video` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `image` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `audio` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `document` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `location` MetaWhatsappLocationDto
        - `longitude` number, double, required
        - `latitude` number, double, required
        - `name` string
        - `address` string
      - `contacts` MetaWhatsappContactDto[]
        - `addresses` AddressDto[]
          - `city` string
          - `country` string
          - `state` string
          - `street` string
          - `zip` string
          - `type` string
          - `country_code` string
        - `birthday` string
        - `emails` EmailDto[]
          - `email` string
          - `type` string
        - `name` NameDto, required
          - `suffix` string
          - `prefix` string
          - `formatted_name` string
          - `first_name` string
          - `last_name` string
          - `middle_name` string
        - `org` OrgDto
          - `company` string
          - `department` string
          - `title` string
        - `phones` PhoneDto[]
          - `phone` string
          - `type` string
          - `wa_id` string
        - `urls` UrlDto[]
          - `url` string
          - `type` string
      - `interactive` MetaWhatsappInteractiveDto
        - `type` string
        - `header` HeaderDto
          - `type` string
          - `text` string
          - `document` MetaWhatsappMediaDto
            - `id` string
            - `link` string
            - `filename` string
            - `caption` string
          - `image` MetaWhatsappMediaDto
            - `id` string
            - `link` string
            - `filename` string
            - `caption` string
          - `video` MetaWhatsappMediaDto
            - `id` string
            - `link` string
            - `filename` string
            - `caption` string
        - `body` BodyDto
          - `text` string
        - `footer` FooterDto
          - `text` string
        - `action` ActionDto
          - `text` string
          - `postbackData` string
          - `dialAction` DialActionDto
            - `phoneNumber` string
          - `viewLocationAction` ViewLocationActionDto
            - `latLong` LatLngDto, required
              - …
            - `label` string
            - `query` string
          - `createCalendarEventAction` CreateCalendarEventActionDto
            - `startTime` string
            - `endTime` string
            - `title` string
            - `description` string
          - `openUrlAction` OpenUrlActionDto
            - `application` string
            - `url` string
            - `description` string
            - `webviewViewMode` string
          - `shareLocationAction` ShareLocationActionDto
          - `composeAction` ComposeActionDto
            - `composeTextMessage` ComposeTextMessageDto
              - …
            - `composeRecordingMessage` ComposeRecordingMessageDto
              - …
      - `template` MetaWhatsappTemplateDto
        - `name` string
        - `namespace` string
        - `language` LanguageDto
          - `code` string
          - `policy` string
        - `components` MetaWhatsappComponentDto[]
          - `type` string
          - `index` string
          - `parameters` MetaWhatsappParameterDto[]
            - `type` string
            - `location` MetaWhatsappLocationDto
              - …
            - `text` string
            - `currency` MetaWhatsAppCurrencyDto
              - …
            - `video` MetaWhatsappMediaDto
              - …
            - `image` MetaWhatsappMediaDto
              - …
            - `document` MetaWhatsappMediaDto
              - …
            - `payload` string
            - `action` ActionDto
              - …
            - `parameter_name` string
            - `date_time` MetaWhatsAppDateTimeDto
              - …
            - `limited_time_offer` MetaLimitedTimeOfferDto
              - …
            - `coupon_code` string
          - `cards` MetaWhatsappCardDto[]
            - `components` MetaWhatsappComponentDto[]
            - `card_index` integer
          - `sub_type` string
      - `biz_opaque_callback_data` string
      - `messaging_product` string
      - `recipient_type` string
    - `whatsappTemplate` WhatsappTemplateReference
      - `id` string
      - `name` string
      - `language` string
      - `category` string
      - `status` string
      - `components` object[]
      - `sub_category` string
      - `correct_category` string
      - `previous_category` string
      - `cta_url_link_tracking_opted_out` string
      - `library_template_name` string
      - `message_send_ttl_seconds` string
      - `parameter_format` string
      - `rejected_reason` string
  - `smsMessage` SmsMessage
    - `content` string — message content
    - `deliveryReport` boolean — request delivery report?

## Response `200`

OK

- OutboxMessageResponse
  - `content` string — message content
  - `subject` string — subject
  - `sender` string — sender identification
  - `recipients` string[] — recipient list
  - `contactGroupIds` integer[] — contact group id list
  - `selectors` string[] — selectors
  - `sendOn` string, date-time — send on (now if not specified)
  - `timeSpread` integer — time spread in hours
  - `repeat` string — repeat period (hourly, daily, weekly, monthly, yearly)
  - `repeatInterval` integer — repeat interval
  - `repeatIterations` integer — repeat iterations
  - `repeatEndDate` string, date-time — repeat end datetime
  - `deliveryReport` boolean — request delivery report?
  - `smsType` integer — SMS type (0 = default, 1 = flash, 2 = both)
  - `predictedSmsCount` integer — predicted SMS count
  - `contentCategory` string — content category (personal, advertisement or informational
  - `messageType` string — message type (default, sms, voice, rcs, whatsapp
  - `attachmentId` integer — attachment id
  - `urlshorteningType` string — urlshortening type
  - `baseTemplateId` integer — base templateId
  - `customerChannelId` integer — customerChannelId
  - `rcsMessage` RcsMessage
    - `agentMessage` AgentContentMessageDto, required
      - `text` string
      - `fileName` string
      - `richCard` RichCardDto
        - `carouselCard` CarouselCardDto
          - `cardWidth` string
          - `cardContents` CardContentDto[]
            - `title` string
            - `description` string
            - `media` MediaDto
              - …
            - `suggestions` SuggestionDto[]
              - …
        - `standaloneCard` StandaloneCardDto
          - `cardOrientation` string
          - `thumbnailImageAlignment` string
          - `cardContent` CardContentDto
            - `title` string
            - `description` string
            - `media` MediaDto
              - …
            - `suggestions` SuggestionDto[]
              - …
      - `suggestions` SuggestionDto[]
        - `reply` ReplyDto
          - `text` string
          - `postbackData` string
        - `action` ActionDto
          - `text` string
          - `postbackData` string
          - `dialAction` DialActionDto
            - `phoneNumber` string
          - `viewLocationAction` ViewLocationActionDto
            - `latLong` LatLngDto, required
              - …
            - `label` string
            - `query` string
          - `createCalendarEventAction` CreateCalendarEventActionDto
            - `startTime` string
            - `endTime` string
            - `title` string
            - `description` string
          - `openUrlAction` OpenUrlActionDto
            - `application` string
            - `url` string
            - `description` string
            - `webviewViewMode` string
          - `shareLocationAction` ShareLocationActionDto
          - `composeAction` ComposeActionDto
            - `composeTextMessage` ComposeTextMessageDto
              - …
            - `composeRecordingMessage` ComposeRecordingMessageDto
              - …
      - `contentInfo` ContentInfoDto
        - `fileUrl` string
        - `thumbnailUrl` string
        - `forceRefresh` boolean
  - `whatsappMessage` WhatsappMessage
    - `metaWhatsappMessage` MetaWhatsappMessageDto, required
      - `type` string
      - `context` MetaContextDto
        - `message_id` string
      - `status` string
      - `sticker` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `text` MetaWhatsappTextDto
        - `body` string
        - `preview_url` boolean
      - `reaction` MetaWhatsappReactionDto
        - `emoji` string
        - `message_id` string
      - `video` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `image` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `audio` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `document` MetaWhatsappMediaDto
        - `id` string
        - `link` string
        - `filename` string
        - `caption` string
      - `location` MetaWhatsappLocationDto
        - `longitude` number, double, required
        - `latitude` number, double, required
        - `name` string
        - `address` string
      - `contacts` MetaWhatsappContactDto[]
        - `addresses` AddressDto[]
          - `city` string
          - `country` string
          - `state` string
          - `street` string
          - `zip` string
          - `type` string
          - `country_code` string
        - `birthday` string
        - `emails` EmailDto[]
          - `email` string
          - `type` string
        - `name` NameDto, required
          - `suffix` string
          - `prefix` string
          - `formatted_name` string
          - `first_name` string
          - `last_name` string
          - `middle_name` string
        - `org` OrgDto
          - `company` string
          - `department` string
          - `title` string
        - `phones` PhoneDto[]
          - `phone` string
          - `type` string
          - `wa_id` string
        - `urls` UrlDto[]
          - `url` string
          - `type` string
      - `interactive` MetaWhatsappInteractiveDto
        - `type` string
        - `header` HeaderDto
          - `type` string
          - `text` string
          - `document` MetaWhatsappMediaDto
            - `id` string
            - `link` string
            - `filename` string
            - `caption` string
          - `image` MetaWhatsappMediaDto
            - `id` string
            - `link` string
            - `filename` string
            - `caption` string
          - `video` MetaWhatsappMediaDto
            - `id` string
            - `link` string
            - `filename` string
            - `caption` string
        - `body` BodyDto
          - `text` string
        - `footer` FooterDto
          - `text` string
        - `action` ActionDto
          - `text` string
          - `postbackData` string
          - `dialAction` DialActionDto
            - `phoneNumber` string
          - `viewLocationAction` ViewLocationActionDto
            - `latLong` LatLngDto, required
              - …
            - `label` string
            - `query` string
          - `createCalendarEventAction` CreateCalendarEventActionDto
            - `startTime` string
            - `endTime` string
            - `title` string
            - `description` string
          - `openUrlAction` OpenUrlActionDto
            - `application` string
            - `url` string
            - `description` string
            - `webviewViewMode` string
          - `shareLocationAction` ShareLocationActionDto
          - `composeAction` ComposeActionDto
            - `composeTextMessage` ComposeTextMessageDto
              - …
            - `composeRecordingMessage` ComposeRecordingMessageDto
              - …
      - `template` MetaWhatsappTemplateDto
        - `name` string
        - `namespace` string
        - `language` LanguageDto
          - `code` string
          - `policy` string
        - `components` MetaWhatsappComponentDto[]
          - `type` string
          - `index` string
          - `parameters` MetaWhatsappParameterDto[]
            - `type` string
            - `location` MetaWhatsappLocationDto
              - …
            - `text` string
            - `currency` MetaWhatsAppCurrencyDto
              - …
            - `video` MetaWhatsappMediaDto
              - …
            - `image` MetaWhatsappMediaDto
              - …
            - `document` MetaWhatsappMediaDto
              - …
            - `payload` string
            - `action` ActionDto
              - …
            - `parameter_name` string
            - `date_time` MetaWhatsAppDateTimeDto
              - …
            - `limited_time_offer` MetaLimitedTimeOfferDto
              - …
            - `coupon_code` string
          - `cards` MetaWhatsappCardDto[]
            - `components` MetaWhatsappComponentDto[]
            - `card_index` integer
          - `sub_type` string
      - `biz_opaque_callback_data` string
      - `messaging_product` string
      - `recipient_type` string
    - `whatsappTemplate` WhatsappTemplateReference
      - `id` string
      - `name` string
      - `language` string
      - `category` string
      - `status` string
      - `components` object[]
      - `sub_category` string
      - `correct_category` string
      - `previous_category` string
      - `cta_url_link_tracking_opted_out` string
      - `library_template_name` string
      - `message_send_ttl_seconds` string
      - `parameter_format` string
      - `rejected_reason` string
  - `smsMessage` SmsMessage
    - `content` string — message content
    - `deliveryReport` boolean — request delivery report?
  - `id` integer, required — message id
  - `status` string, required — status
  - `numberOfRecipients` integer — number of recipients
  - `numberOfContactGroups` integer — number of contact groups
  - `numberOfTotalRecipients` integer — number of total recipients (msisdns + contact group members)
  - `lastModified` string, date-time — last modified
  - `lastModifiedBy` string — last modified by
  - `attachmentMimeType` string — attachment mime type
  - `links` Link[] — links
    - `rel` string
    - `href` string
  - `origin` 'api_http' | 'api_http_simple' | 'api_rest' | 'api_rest_simple' | 'api_rest_converged' | 'api_rest_customer_channel' | 'api_smpp' | 'api_smtp' | 'api_ftp' | 'sdk_java' | 'sdk_cpp' | 'sdk_csharp' | 'sdk_perl' | 'sdk_ruby' | 'sdk_python' | 'sdk_node' | 'sdk_php' | 'api_smtp_email2sms' | 'api_smtp_email2voice' | 'api_smtp_email2sms_ucs' | 'api_smtp_email2whatsapp' | 'oms' | 'oms_reply' | 'remotesms' | 'remotesms_msisdn_change' | 'remotesms_error' | 'group_subscription' | 'trigger_rule' | 'registration' | 'birthday_sms' | 'mycokemusic' | 'optin' | 'applet_optin' | 'applet_optout' | 'applet_quick_optin' | 'internex' | 'onlinesms_v2' | 'onlinesms_v3' | 'api_v1' | 'plugin_excel_365' | 'plugin_excel_2010' | 'plugin_google_sheets' | 'plugin_google_chrome' | 'unknown'
  - `automated` boolean — is generated by an automation like Opt-Ins, PIN verification, etc.

## Other responses

- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.dev/linkmobility/apis/untitled-api.md) · [All operations](https://skmtc.dev/linkmobility/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/linkmobility/untitled-api/revisions/db84f79799b9/schema)
