---
title: "Edit RCS Carousel Message API"
method: PUT
path: "/template/edit"
tags: ["Template APIs"]
---

# Edit RCS Carousel Message API

`PUT /template/edit`

## Request

- Base URL: `https://soipapi.netcorecloud.com`
- URL: `https://soipapi.netcorecloud.com/template/edit`
- Auth: HTTP bearer

Send the updated details of your carousel template in this request. Ensure all authentication headers are included.

## Headers

- `api_key` string, required
- `Content-Type` string, required
- `nc_bot_id` string

## Request body

- object
  - `action_type` string, required: Enter the action type. For carousel updates, use "carousel".
  - `payload` object
    - `card_width` string, required: Select the card width (e.g., "SMALL_WIDTH", "MEDIUM_WIDTH").
    - `card_height` string, required: Select the card height (e.g., "SHORT_HEIGHT", "MEDIUM_HEIGHT").
    - `rcs_type` string, required: Use "carousel" to define the message type.
    - `cards` object[], required: Add one or more cards to include in the carousel.
      - `type` integer, required: Specify the card type. A value of 2 supports suggestions or actions.
      - `image_file` string: Upload the image or video as a base64 file.
      - `url` string: Provide the direct media URL.
      - `thumbnail_url` string: Provide the thumbnail image URL.
      - `thumbnail_file` string: Upload the thumbnail file as base64.
      - `title` string: Enter the card title.
      - `description` string: Enter the card description.
      - `suggestions` object[]: Add suggestion actions like replies, URLs, or dial actions.
        - `suggestionType` string: Choose a suggestion type such as "reply", "url_action", or "dialer_action".
        - `displayText` string: Enter the label shown to users.
        - `postback` string: Enter the data returned when the user selects the suggestion.
        - `url` string: Enter the URL for URL actions.
    - `template_name` string, required: Enter the name of the template being edited.

## Response `200`

Template updated successfully.

```
{
  "message": "Template modified successfully",
  "payload": { ... },
  "status": "Success"
}
```

## Other responses

- `400`: Returned when the template name already exists or required fields are missing. ``` { "error": "template 'test_edit_text_message' either does not exist or is not eligible for editing", "message": "Template creation failed", "status": "Failure" } ``` ``` { "error": "missing required field: template_content", "message": "Template creation failed", "status": "Failure" } ```

---

[API](https://skmtc.dev/netcorecloud/apis/rcs-api.md) - [All operations](https://skmtc.dev/netcorecloud/apis/rcs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/netcorecloud/apis/rcs-api/revisions/479db24ef963?raw)
