---
title: "Update Templates"
method: POST
path: "/client/template/update"
tags: ["Template"]
---

# Update Templates

`POST /client/template/update`

## Request

- Base URL: `https://netcoreapi-main-prod-us.netcorein.com/v5`
- URL: `https://netcoreapi-main-prod-us.netcorein.com/v5/client/template/update`
- Auth: API key in header `api-key`

## Headers

- `Content-Type` string
- `api-key` string, required

## Request body

- object
  - `data` object, required
    - `templates` object[], required
      - `channel_name` 'apn', required
      - `template_id` integer, required
      - `template_name` string
      - `category_name` string: new category is created if a category does not already exist for the given name
      - `custom` object
        - `Personalisation` object: Optional map of personalization variables. Attribute entries require attribute_name; event entries require category, event_name, and payload_param. Additional data validity is enforced at runtime. Example: "{\"name\":{\"attribute_name\":\"name\",\"default_value\":\"Customer\",\"entity\":\"attribute\"},\"product_price\":{\"category\":\"user_activity\",\"default_value\":\"0\",\"entity\":\"event\",\"event_name\":\"add_to_cart\",\"payload_param\":\"price\"}}"
      - `content` object: This contains the template content, landing page configuration, and platform-specific notification interactions.
        - `title` string: Specifies the title displayed in the APN notification. The value must contain between 1 and 100 characters.
        - `description` string: Specifies the main text displayed in the APN notification. The value must contain between 1 and 1,000 characters.
        - `landing_page_type` 'app_homepage' | 'url' | 'deeplink': Specifies the destination type when the notification is opened. Supported values are `app_homepage`, `url`, and `deeplink`.
        - `landing_page_url` string: Specifies the destination URL or deep link. Required when landing_page_type is **url** or **deeplink**.
        - `apn_interactions` object[]
          - `os_type` 'android' | 'ios'
          - `subtitle` string
          - `rich_media` object
            - `media_type` 'image' | 'carousel' | 'gif' | 'audio' | 'video'
            - `media_url` string: required when media_type is image, gif, audio or video. video applicable only for ios
            - `layout` 'portrait' | 'landscape': required when media_type is carousel
            - `image_alignment` 'left' | 'right': Specifies the image alignment for the small_image template type. Supported values are left and right.
            - `carousel_metadata` object[]
              - …
            - `overlay_color` BackgroundColor
              - …
          - `timer` object: applicable only for template types `timer` and `progress_bar`.
            - `text` string: required when template_type is `progress_bar`
            - `end_message` string: required when template_type is `progress_bar` or `timer`
            - `background_color` string
            - `text_color` string
            - `settings` object
              - …
          - `background_color` BackgroundColor
            - `type` 'solid' | 'gradient'
            - `color` string: required when type is solid
            - `color_start` string
            - `color_end` string
          - `action_button` object[]: maximum 5 button for ios and 3 for android. When template_type is small_image length is restricted to 1.
            - `action_title` string
            - `background_color` string
            - `text_color` string
            - `call_to_action` object
              - …
          - `quick_reply` object: applicable only for template types `quick_reply`. This replaces action_button
            - `button_text` string
            - `placeholder_text` string: applicable only for android
            - `submission_text` string: applicable only for android
          - `enable_sticky_notification` boolean: applicable only for android
          - `customize_collapsed_state` object: applicable only for template types `overlay_on_image` and `edge_to_edge`
            - `type` 'image_only' | 'image_and_text'
            - `image_url` string
          - `sound` object
            - `type` 'default' | 'custom'
            - `file_name` string: required when type is custom
            - `channel_id` string: applicable only for android
        - `custom_key_values` object[]
          - `ostype` 'all' | 'android' | 'ios': cannot be set to an os which is not declared in custom.os
          - `key` string
          - `value` string

## Response `200`

- object

---

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