> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update template
> Update existing OneSignal message templates for push, email, or SMS. Changes apply immediately across dashboard and API usage via the `template_id` reference.
## Overview
This endpoint allows you to update an existing push, email, or SMS template in your OneSignal app. Once updated, the changes are applied immediately and reflected across both the Dashboard and API when using the associated `template_id`.
Templates are updated using the same structure as when [creating templates](/reference/create-template).
See [Templates](/docs/en/templates) for more information.
***
## How to use this API
To update a template, you must supply:
* Your **OneSignal App ID** found in [Keys & IDs](/docs/en/keys-and-ids).
* The **Template ID**
### Template ID
Each template has a unique OneSignal-generated `template_id` (UUID v4). You can find it:
* Using the [View Templates API](/reference/view-templates)
* In the OneSignal Dashboard under **Messages > Templates > Options > Copy Template ID**
***
## Channel-Specific Requirements
### Push Templates
* The `contents` property must use the `en` (English) key along with other languages you want to support.
* All [Push Notification Properties](/reference/push-notification) are valid.
* All platforms are enabled by default. To limit, explicitly enable desired ones (e.g., `isAndroid: true` disables iOS and Web).
### Email Templates
* Set `isEmail: true`
* Include `email_subject` and `email_body`
* All [Email Channel Properties](/reference/email) are supported.
### SMS Templates
* Set `isSMS: true`
* All [SMS Channel Properties](/reference/sms) are supported.
***
## OpenAPI
````yaml PATCH /templates/{template_id}?app_id={app_id}
openapi: 3.1.0
info:
title: api.onesignal.com
version: '11.6'
servers:
- url: https://api.onesignal.com
security:
- {}
paths:
/templates/{template_id}?app_id={app_id}:
patch:
summary: Update template
description: >-
Update existing OneSignal message templates for push, email, or SMS.
Changes apply immediately across dashboard and API usage via the
`template_id` reference.
operationId: update-template
parameters:
- name: template_id
in: path
description: The template ID in UUID v4 format. See [Templates](/docs/templates).
schema:
type: string
default: YOUR_TEMPLATE_ID
required: true
- name: app_id
in: query
description: >-
Your OneSignal App ID in UUID v4 format. See [Keys &
IDs](/docs/en/keys-and-ids).
required: true
schema:
type: string
default: YOUR_APP_ID
- name: Authorization
in: header
description: >-
Your App API key with prefix `Key `. See [Keys &
IDs](/docs/en/keys-and-ids).
required: true
schema:
type: string
default: Key YOUR_APP_API_KEY
requestBody:
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
description: >-
An internal name you set to help organize and track
Templates. Maximum 128 characters.
default: YOUR_TEMPLATE_NAME
contents:
type: object
description: >-
The main message body with [language-specific
values](/docs/en/multi-language-messaging#supported-languages).
Supports [Message
Personalization](/docs/message-personalization).
required:
- en
properties:
en:
type: string
description: >-
The required message language type. See [Supported
Languages](/docs/en/multi-language-messaging#supported-languages).
isEmail:
type: boolean
description: Required to be set `true` for email templates.
email_body:
type: string
description: >-
The body of the email in HTML format. Required for email
templates. Supports [Message
Personalization](/docs/message-personalization).
isSMS:
type: boolean
description: Required to be set `true` for SMS templates.
dynamic_content:
type: object
description: >-
Add personalization to your templates programmatically. No
need to upload a CSV. See [Dynamic
Content](/docs/dynamic-content) for details.
example: >-
{"campaign_id": {"A": {"title": "Custom Title A", "message":
"Custom Message A", "url": "https://www.onesignal.com"},
"B": {"title": "Custom Title B", "message": "Custom Message
B", "url": "https://www.onesignal.com/login"}}}
responses:
'200':
description: The updated template record. Same shape as POST /templates.
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResource'
'400':
description: '400'
content:
application/json:
schema:
oneOf:
- type: object
properties:
success:
type: boolean
example: false
default: true
errors:
type: array
items:
type: string
example: >-
'message' Notifications must have Any/English
language content
- title: Bad Request (Email)
type: object
properties:
success:
type: boolean
example: false
default: true
errors:
type: array
items:
type: string
example: '''message'' Email body can not be blank'
'429':
description: >-
Rate limit exceeded. Wait the number of seconds in the `Retry-After`
header before retrying.
headers:
Retry-After:
description: >-
Number of seconds to wait before retrying the request. Always
emitted on 429 responses.
schema:
type: integer
minimum: 0
content:
application/json:
schema:
$ref: '#/components/schemas/BasicErrorResponse'
example:
errors:
- API rate limit exceeded
'503':
description: >-
Service temporarily unavailable. Retry after a short backoff. The
body may be empty or non-JSON in some failure modes.
headers:
Retry-After:
description: >-
Number of seconds to wait before retrying. Optional — may be
absent when the response is generated upstream.
schema:
type: integer
minimum: 0
content:
application/json:
schema:
$ref: '#/components/schemas/BasicErrorResponse'
example:
errors:
- Service temporarily unavailable
deprecated: false
security: []
x-codeSamples:
- lang: typescript
label: Node.js SDK
source: |-
import Onesignal from '@onesignal/node-onesignal';
const configuration = Onesignal.createConfiguration({
restApiKey: 'YOUR_REST_API_KEY',
});
const apiInstance = new Onesignal.DefaultApi(configuration);
// string
const templateId: string = "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c";
// string
const appId: string = "00000000-0000-0000-0000-000000000000";
// UpdateTemplateRequest
const updateTemplateRequest: Onesignal.UpdateTemplateRequest = {
name: "name_example",
contents: {
en: "en_example",
ar: "ar_example",
bs: "bs_example",
bg: "bg_example",
ca: "ca_example",
zh_hans: "zh_hans_example",
zh_hant: "zh_hant_example",
zh: "zh_example",
hr: "hr_example",
cs: "cs_example",
da: "da_example",
nl: "nl_example",
et: "et_example",
fi: "fi_example",
fr: "fr_example",
ka: "ka_example",
de: "de_example",
el: "el_example",
hi: "hi_example",
he: "he_example",
hu: "hu_example",
id: "id_example",
it: "it_example",
ja: "ja_example",
ko: "ko_example",
lv: "lv_example",
lt: "lt_example",
ms: "ms_example",
nb: "nb_example",
pl: "pl_example",
fa: "fa_example",
pt: "pt_example",
pa: "pa_example",
ro: "ro_example",
ru: "ru_example",
sr: "sr_example",
sk: "sk_example",
es: "es_example",
sv: "sv_example",
th: "th_example",
tr: "tr_example",
uk: "uk_example",
vi: "vi_example",
},
headings: {
en: "en_example",
ar: "ar_example",
bs: "bs_example",
bg: "bg_example",
ca: "ca_example",
zh_hans: "zh_hans_example",
zh_hant: "zh_hant_example",
zh: "zh_example",
hr: "hr_example",
cs: "cs_example",
da: "da_example",
nl: "nl_example",
et: "et_example",
fi: "fi_example",
fr: "fr_example",
ka: "ka_example",
de: "de_example",
el: "el_example",
hi: "hi_example",
he: "he_example",
hu: "hu_example",
id: "id_example",
it: "it_example",
ja: "ja_example",
ko: "ko_example",
lv: "lv_example",
lt: "lt_example",
ms: "ms_example",
nb: "nb_example",
pl: "pl_example",
fa: "fa_example",
pt: "pt_example",
pa: "pa_example",
ro: "ro_example",
ru: "ru_example",
sr: "sr_example",
sk: "sk_example",
es: "es_example",
sv: "sv_example",
th: "th_example",
tr: "tr_example",
uk: "uk_example",
vi: "vi_example",
},
subtitle: {
en: "en_example",
ar: "ar_example",
bs: "bs_example",
bg: "bg_example",
ca: "ca_example",
zh_hans: "zh_hans_example",
zh_hant: "zh_hant_example",
zh: "zh_example",
hr: "hr_example",
cs: "cs_example",
da: "da_example",
nl: "nl_example",
et: "et_example",
fi: "fi_example",
fr: "fr_example",
ka: "ka_example",
de: "de_example",
el: "el_example",
hi: "hi_example",
he: "he_example",
hu: "hu_example",
id: "id_example",
it: "it_example",
ja: "ja_example",
ko: "ko_example",
lv: "lv_example",
lt: "lt_example",
ms: "ms_example",
nb: "nb_example",
pl: "pl_example",
fa: "fa_example",
pt: "pt_example",
pa: "pa_example",
ro: "ro_example",
ru: "ru_example",
sr: "sr_example",
sk: "sk_example",
es: "es_example",
sv: "sv_example",
th: "th_example",
tr: "tr_example",
uk: "uk_example",
vi: "vi_example",
},
is_email: true,
email_subject: "email_subject_example",
email_body: "email_body_example",
email_bcc: [
"email_bcc_example",
],
is_sms: true,
dynamic_content: "dynamic_content_example",
};
try {
const response = await apiInstance.updateTemplate(templateId, appId, updateTemplateRequest);
console.log(response);
} catch (e) {
if (e instanceof Onesignal.ApiException) {
// `e.errorMessages` flattens any error-envelope shape to a `string[]`;
// the raw parsed body remains on `e.body`.
console.error("updateTemplate failed: HTTP " + e.code, e.errorMessages);
} else {
throw e;
}
}
- lang: python
label: Python SDK
source: >-
import onesignal
from onesignal.api import default_api
from onesignal.models import *
from pprint import pprint
# See configuration.py for a list of all supported configuration
parameters.
# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token
for authorization, while others require REST_API_KEY.
# We recommend adding both of them in the configuration page so that
you will not need to figure it out yourself.
configuration = onesignal.Configuration(
rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints
organization_api_key = "YOUR_ORGANIZATION_API_KEY" # Organization key is only required for creating new apps and other top-level endpoints
)
# Enter a context with an instance of the API client
with onesignal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)
template_id = "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c"
app_id = "00000000-0000-0000-0000-000000000000"
update_template_request = UpdateTemplateRequest(
name="name_example",
contents=LanguageStringMap(
en="en_example",
ar="ar_example",
bs="bs_example",
bg="bg_example",
ca="ca_example",
zh_hans="zh_hans_example",
zh_hant="zh_hant_example",
zh="zh_example",
hr="hr_example",
cs="cs_example",
da="da_example",
nl="nl_example",
et="et_example",
fi="fi_example",
fr="fr_example",
ka="ka_example",
de="de_example",
el="el_example",
hi="hi_example",
he="he_example",
hu="hu_example",
id="id_example",
it="it_example",
ja="ja_example",
ko="ko_example",
lv="lv_example",
lt="lt_example",
ms="ms_example",
nb="nb_example",
pl="pl_example",
fa="fa_example",
pt="pt_example",
pa="pa_example",
ro="ro_example",
ru="ru_example",
sr="sr_example",
sk="sk_example",
es="es_example",
sv="sv_example",
th="th_example",
tr="tr_example",
uk="uk_example",
vi="vi_example",
),
headings=LanguageStringMap(
en="en_example",
ar="ar_example",
bs="bs_example",
bg="bg_example",
ca="ca_example",
zh_hans="zh_hans_example",
zh_hant="zh_hant_example",
zh="zh_example",
hr="hr_example",
cs="cs_example",
da="da_example",
nl="nl_example",
et="et_example",
fi="fi_example",
fr="fr_example",
ka="ka_example",
de="de_example",
el="el_example",
hi="hi_example",
he="he_example",
hu="hu_example",
id="id_example",
it="it_example",
ja="ja_example",
ko="ko_example",
lv="lv_example",
lt="lt_example",
ms="ms_example",
nb="nb_example",
pl="pl_example",
fa="fa_example",
pt="pt_example",
pa="pa_example",
ro="ro_example",
ru="ru_example",
sr="sr_example",
sk="sk_example",
es="es_example",
sv="sv_example",
th="th_example",
tr="tr_example",
uk="uk_example",
vi="vi_example",
),
subtitle=LanguageStringMap(
en="en_example",
ar="ar_example",
bs="bs_example",
bg="bg_example",
ca="ca_example",
zh_hans="zh_hans_example",
zh_hant="zh_hant_example",
zh="zh_example",
hr="hr_example",
cs="cs_example",
da="da_example",
nl="nl_example",
et="et_example",
fi="fi_example",
fr="fr_example",
ka="ka_example",
de="de_example",
el="el_example",
hi="hi_example",
he="he_example",
hu="hu_example",
id="id_example",
it="it_example",
ja="ja_example",
ko="ko_example",
lv="lv_example",
lt="lt_example",
ms="ms_example",
nb="nb_example",
pl="pl_example",
fa="fa_example",
pt="pt_example",
pa="pa_example",
ro="ro_example",
ru="ru_example",
sr="sr_example",
sk="sk_example",
es="es_example",
sv="sv_example",
th="th_example",
tr="tr_example",
uk="uk_example",
vi="vi_example",
),
is_email=True,
email_subject="email_subject_example",
email_body="email_body_example",
email_bcc=[
"email_bcc_example",
],
is_sms=True,
dynamic_content="dynamic_content_example",
)
try:
# Update template
api_response = api_instance.update_template(template_id, app_id, update_template_request)
pprint(api_response)
except onesignal.ApiException as e:
print("Exception when calling DefaultApi->update_template: %s\n" % e)
print("Status Code: %s" % e.status)
print("Response Body: %s" % e.body)
- lang: php
label: PHP SDK
source: >-
setRestApiKeyToken('YOUR_REST_API_KEY')
->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY');
$apiInstance = new onesignal\client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c'; // string
$app_id = '00000000-0000-0000-0000-000000000000'; // string
$update_template_request = new
\onesignal\client\model\UpdateTemplateRequest(); //
\onesignal\client\model\UpdateTemplateRequest
try {
$result = $apiInstance->updateTemplate($template_id, $app_id, $update_template_request);
print_r($result);
} catch (\onesignal\client\ApiException $e) {
echo 'Exception when calling DefaultApi->updateTemplate: ', $e->getMessage(), PHP_EOL;
echo 'Status Code: ', $e->getCode(), PHP_EOL;
// getErrorMessages() flattens any error-envelope shape to a string[];
// the raw body remains on getResponseBody().
echo 'Error Messages: ', implode(', ', $e->getErrorMessages()), PHP_EOL;
echo 'Response Body: ', $e->getResponseBody(), PHP_EOL;
} catch (\Exception $e) {
echo 'Exception when calling DefaultApi->updateTemplate: ', $e->getMessage(), PHP_EOL;
}
- lang: go
label: Go SDK
source: |-
package main
import (
"context"
"fmt"
"os"
"github.com/OneSignal/onesignal-go-api/v5"
)
func main() {
templateId := "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c" // string |
appId := "00000000-0000-0000-0000-000000000000" // string |
updateTemplateRequest := *onesignal.NewUpdateTemplateRequest() // UpdateTemplateRequest |
configuration := onesignal.NewConfiguration()
apiClient := onesignal.NewAPIClient(configuration)
restAuth := context.WithValue(context.Background(), onesignal.RestApiKey, "YOUR_REST_API_KEY") // App REST API key required for most endpoints
resp, r, err := apiClient.DefaultApi.UpdateTemplate(restAuth, templateId).AppId(appId).UpdateTemplateRequest(updateTemplateRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.UpdateTemplate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
if apiErr, ok := err.(*onesignal.GenericOpenAPIError); ok {
// ErrorMessages() flattens any error-envelope shape to a []string;
// the raw body remains on Body().
fmt.Fprintf(os.Stderr, "Error Messages: %v\n", apiErr.ErrorMessages())
fmt.Fprintf(os.Stderr, "Response Body: %s\n", apiErr.Body())
}
}
// response from `UpdateTemplate`: TemplateResource
fmt.Fprintf(os.Stdout, "Response from `DefaultApi.UpdateTemplate`: %v\n", resp)
}
- lang: ruby
label: Ruby SDK
source: >-
require 'onesignal'
# setup authorization
OneSignal.configure do |config|
# Configure Bearer authorization: rest_api_key
config.rest_api_key = 'YOUR_REST_API_KEY'
end
api_instance = OneSignal::DefaultApi.new
template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c' # String |
app_id = '00000000-0000-0000-0000-000000000000' # String |
update_template_request = OneSignal::UpdateTemplateRequest.new #
UpdateTemplateRequest |
begin
# Update template
result = api_instance.update_template(template_id, app_id, update_template_request)
p result
rescue OneSignal::ApiError => e
puts "Error when calling DefaultApi->update_template: #{e}"
puts "Status Code: #{e.code}"
# `e.error_messages` flattens any error-envelope shape to an Array;
# the raw body remains on `e.response_body`.
puts "Error Messages: #{e.error_messages}"
puts "Response Body: #{e.response_body}"
end
- lang: java
label: Java SDK
source: |-
// Import classes:
import com.onesignal.client.ApiClient;
import com.onesignal.client.ApiException;
import com.onesignal.client.Configuration;
import com.onesignal.client.auth.*;
import com.onesignal.client.model.*;
import com.onesignal.client.api.DefaultApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.onesignal.com");
// Configure HTTP bearer authorization: rest_api_key
HttpBearerAuth rest_api_key = (HttpBearerAuth) defaultClient.getAuthentication("rest_api_key");
rest_api_key.setBearerToken("YOUR_REST_API_KEY");
DefaultApi apiInstance = new DefaultApi(defaultClient);
String templateId = "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c"; // String |
String appId = "00000000-0000-0000-0000-000000000000"; // String |
UpdateTemplateRequest updateTemplateRequest = new UpdateTemplateRequest(); // UpdateTemplateRequest |
try {
TemplateResource result = apiInstance.updateTemplate(templateId, appId, updateTemplateRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#updateTemplate");
System.err.println("Status code: " + e.getCode());
// getErrorMessages() flattens any error-envelope shape to a List;
// the raw body remains on getResponseBody().
System.err.println("Error messages: " + e.getErrorMessages());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
- lang: csharp
label: C# SDK
source: |-
using System;
using System.Collections.Generic;
using System.Diagnostics;
using OneSignalApi.Api;
using OneSignalApi.Client;
using OneSignalApi.Model;
namespace Example
{
public class UpdateTemplateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.onesignal.com";
// Configure Bearer token for authorization: rest_api_key
config.AccessToken = "YOUR_REST_API_KEY";
var apiInstance = new DefaultApi(config);
var templateId = "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c"; // string |
var appId = "00000000-0000-0000-0000-000000000000"; // string |
var updateTemplateRequest = new UpdateTemplateRequest(); // UpdateTemplateRequest |
try
{
// Update template
TemplateResource result = apiInstance.UpdateTemplate(templateId, appId, updateTemplateRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateTemplate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
// e.ErrorMessages flattens any error-envelope shape to an IReadOnlyList;
// the raw body remains on e.ErrorContent.
Debug.Print("Error Messages: " + string.Join(", ", e.ErrorMessages));
Debug.Print("Response Body: " + e.ErrorContent);
Debug.Print(e.StackTrace);
}
}
}
}
- lang: rust
label: Rust SDK
source: |-
use onesignal_rust_api::apis::configuration::Configuration;
use onesignal_rust_api::apis::default_api;
use onesignal_rust_api::models;
#[tokio::main]
async fn main() {
let mut configuration = Configuration::new();
configuration.rest_api_key_token = Some("YOUR_REST_API_KEY".to_string());
// Realistic values are pulled from the spec's `example:` fields where present.
let template_id: &str = "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c";
let app_id: &str = "00000000-0000-0000-0000-000000000000";
let update_template_request: models::UpdateTemplateRequest = todo!();
match default_api::update_template(&configuration, template_id, app_id, update_template_request).await {
Ok(resp) => println!("{:?}", resp),
Err(e @ onesignal_rust_api::apis::Error::ResponseError(_)) => {
// `e.error_messages()` flattens any error-envelope shape to a Vec;
// the raw response remains on the ResponseError variant.
eprintln!("update_template failed: {:?}", e.error_messages());
}
Err(e) => eprintln!("update_template failed: {:?}", e),
}
}
components:
schemas:
TemplateResource:
type: object
required:
- id
description: >-
A template record. The `content` block is a `TemplateResourceContent`
whose populated fields depend on the template's channel(s).
properties:
id:
type: string
format: uuid
description: Template ID in UUID v4 format.
name:
type: string
description: >-
Internal label set when the template was created or last updated.
Maximum 128 characters.
channel:
type: string
enum:
- push
- email
- SMS
description: >-
The primary channel the template is configured for. Note: `SMS` is
uppercased while the others are lowercased.
created_at:
type: string
format: date-time
description: ISO-8601 timestamp when the template was created.
updated_at:
type: string
format: date-time
description: ISO-8601 timestamp when the template was last updated.
content:
$ref: '#/components/schemas/TemplateResourceContent'
BasicErrorResponse:
type: object
properties:
errors:
type: array
items:
type: string
description: One or more human-readable error messages.
success:
type: boolean
description: >-
Present (and `false`) on some endpoints (notifications, templates,
segments). Not emitted by every endpoint.
reference:
type: array
items:
type: string
description: >-
Documentation URL fragments related to the error. Only emitted by
the API-key auth error helpers.
TemplateResourceContent:
type: object
description: >-
The content block of a template. Every field is nullable: a field is
populated only when the corresponding channel feature is enabled for the
template. For example, push fields (`isAndroid`, `isIos`, `headings`,
...) are populated for push templates; email fields (`isEmail`,
`email_body`, ...) for email templates; and SMS fields (`isSMS`,
`sms_from`, ...) for SMS templates. Cross-channel templates may have
multiple feature blocks populated.
properties:
isAndroid:
type: boolean
nullable: true
isIos:
type: boolean
nullable: true
isMacOSX:
type: boolean
nullable: true
isAdm:
type: boolean
nullable: true
isAlexa:
type: boolean
nullable: true
isWP:
type: boolean
nullable: true
isWP_WNS:
type: boolean
nullable: true
isChrome:
type: boolean
nullable: true
isChromeWeb:
type: boolean
nullable: true
isSafari:
type: boolean
nullable: true
isFirefox:
type: boolean
nullable: true
isEdge:
type: boolean
nullable: true
isHuawei:
type: boolean
nullable: true
headings:
type: object
nullable: true
additionalProperties:
type: string
description: >-
Map of language code to localized string. Keys are 2-letter ISO
codes (e.g., `en`, `es`); values are the message text.
subtitle:
type: object
nullable: true
additionalProperties:
type: string
description: >-
Map of language code to localized string. Keys are 2-letter ISO
codes (e.g., `en`, `es`); values are the message text.
contents:
type: object
nullable: true
additionalProperties:
type: string
description: >-
Map of language code to localized string. Keys are 2-letter ISO
codes (e.g., `en`, `es`); values are the message text.
global_image:
type: string
nullable: true
description: URL of the image to render with the push notification.
url:
type: string
nullable: true
description: Click-action URL for push notifications.
format: uri
isEmail:
type: boolean
nullable: true
email_body:
type: string
nullable: true
description: HTML body of the email.
email_subject:
type: string
nullable: true
email_preheader:
type: string
nullable: true
email_from_address:
type: string
nullable: true
format: email
email_from_name:
type: string
nullable: true
email_reply_to_address:
type: string
nullable: true
format: email
email_bcc:
type: array
items:
type: string
format: email
nullable: true
maxItems: 5
description: >-
BCC recipients for the email template. Maximum 5 addresses. Only
supported when the email service provider is OneSignal Email.
disable_email_click_tracking:
type: boolean
nullable: true
isSMS:
type: boolean
nullable: true
sms_from:
type: string
nullable: true
description: Sender phone number in E.164 format.
sms_media_urls:
type: array
nullable: true
items:
type: string
format: uri
description: Optional array of media URLs to attach to the SMS (MMS).
huawei_badge_add_num:
type: integer
nullable: true
description: Increment value for the Huawei badge counter.
huawei_badge_class:
type: string
nullable: true
description: Activity class associated with the Huawei badge counter.
huawei_badge_set_num:
type: integer
nullable: true
description: Absolute value to set the Huawei badge counter to.
````