> ## 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.
# Copy template to another app
> Create a duplicate of a template in another app. The new template will be completely separate from the original (including having a new template_id) but will be created with all the same content.
## Overview
This API allows you to copy a template from one app (`app_id`) to another (`target_app_id`). The duplicated template will have the same content as the original, but a new unique `template_id`.
If you are trying to copy an email template, we also have an [Email Template Forwarding](/docs/en/email-template-forwarding) feature that does not require an API call.
Both options support HTML and Drag & Drop email templates.
***
## Requirements
* **Organization Membership:** Both the `app_id` and `target_app_id` must belong to the same [Organization](/docs/en/apps-organizations).
* **Authorization Required:** You must use your [Organization API key](/docs/en/keys-and-ids#organization-api-key), not an app-level REST API key.
* **Permissions Note:** Your user must have admin-level access to both the source and target apps. If not, the request will fail with a "permission denied" error.
***
## Parameters
* `template_id` (path param): UUID of the template to be copied.
* `app_id` (query param): ID of the app where the original template exists.
* `target_app_id` (body param): ID of the app where the template will be duplicated.
***
## How to Use
### 1. Locate the 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**
### 2. Get App IDs
Refer to [Keys & IDs](/docs/en/keys-and-ids) to find your `app_id` and `target_app_id`.
***
## Response
The response will include:
* The new `template_id` for the copied template
* Confirmation of successful creation
* Any warnings if applicable (e.g., limited fields copied)
***
## OpenAPI
````yaml POST /templates/{template_id}/copy_to_app?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}/copy_to_app?app_id={app_id}:
post:
summary: Copy template to another app
description: >-
Create a duplicate of a OneSignal message template in another app within
the same organization. The new template will retain the same content but
have a unique template ID.
operationId: copy-template-to-another-app
parameters:
- name: template_id
in: path
description: >-
The template ID in UUID v4 format. See
[Templates](/docs/en/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 Organization API key with prefix `Key `. See [Keys &
IDs](/docs/en/keys-and-ids).
required: true
schema:
type: string
default: Key YOUR_ORGANIZATION_API_KEY
requestBody:
content:
application/json:
schema:
type: object
required:
- target_app_id
properties:
target_app_id:
type: string
description: >-
Specifies the OneSignal app ID that the template will be
copied to. Cannot be the same as the `app_id`.
default: YOUR_OTHER_APP_ID
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Whether the template was copied successfully.
'400':
description: '400'
content:
application/json:
schema:
oneOf:
- title: Bad Request (Missing Body Parameter)
type: object
properties:
errors:
type: array
items:
type: string
description: >-
Missing body parameter.Request is malformed: Failed
to parse app_id from request
- title: Bad Request (Missing Query Parameter)
type: object
properties:
errors:
type: array
items:
type: string
description: >-
Missing query parameter. app_id not found. You may
be missing a Content-Type: application/json header.
'404':
description: '404'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Whether the template was copied successfully.
'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
x-codeSamples:
- lang: typescript
label: Node.js SDK
source: |-
import Onesignal from '@onesignal/node-onesignal';
const configuration = Onesignal.createConfiguration({
organizationApiKey: 'YOUR_ORGANIZATION_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";
// CopyTemplateRequest
const copyTemplateRequest: Onesignal.CopyTemplateRequest = {
target_app_id: "target_app_id_example",
};
try {
const response = await apiInstance.copyTemplateToApp(templateId, appId, copyTemplateRequest);
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("copyTemplateToApp 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"
copy_template_request = CopyTemplateRequest(
target_app_id="target_app_id_example",
)
try:
# Copy template to another app
api_response = api_instance.copy_template_to_app(template_id, app_id, copy_template_request)
pprint(api_response)
except onesignal.ApiException as e:
print("Exception when calling DefaultApi->copy_template_to_app: %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
$copy_template_request = new
\onesignal\client\model\CopyTemplateRequest(); //
\onesignal\client\model\CopyTemplateRequest
try {
$result = $apiInstance->copyTemplateToApp($template_id, $app_id, $copy_template_request);
print_r($result);
} catch (\onesignal\client\ApiException $e) {
echo 'Exception when calling DefaultApi->copyTemplateToApp: ', $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->copyTemplateToApp: ', $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 |
copyTemplateRequest := *onesignal.NewCopyTemplateRequest("TargetAppId_example") // CopyTemplateRequest |
configuration := onesignal.NewConfiguration()
apiClient := onesignal.NewAPIClient(configuration)
orgAuth := context.WithValue(context.Background(), onesignal.OrganizationApiKey, "YOUR_ORGANIZATION_API_KEY") // Organization API key is only required for creating new apps and other top-level endpoints
resp, r, err := apiClient.DefaultApi.CopyTemplateToApp(orgAuth, templateId).AppId(appId).CopyTemplateRequest(copyTemplateRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.CopyTemplateToApp``: %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 `CopyTemplateToApp`: TemplateResource
fmt.Fprintf(os.Stdout, "Response from `DefaultApi.CopyTemplateToApp`: %v\n", resp)
}
- lang: ruby
label: Ruby SDK
source: >-
require 'onesignal'
# setup authorization
OneSignal.configure do |config|
# Configure Bearer authorization: organization_api_key
config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
end
api_instance = OneSignal::DefaultApi.new
template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c' # String |
app_id = '00000000-0000-0000-0000-000000000000' # String |
copy_template_request =
OneSignal::CopyTemplateRequest.new({target_app_id:
'target_app_id_example'}) # CopyTemplateRequest |
begin
# Copy template to another app
result = api_instance.copy_template_to_app(template_id, app_id, copy_template_request)
p result
rescue OneSignal::ApiError => e
puts "Error when calling DefaultApi->copy_template_to_app: #{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: organization_api_key
HttpBearerAuth organization_api_key = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
organization_api_key.setBearerToken("YOUR_ORGANIZATION_API_KEY");
DefaultApi apiInstance = new DefaultApi(defaultClient);
String templateId = "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c"; // String |
String appId = "00000000-0000-0000-0000-000000000000"; // String |
CopyTemplateRequest copyTemplateRequest = new CopyTemplateRequest(); // CopyTemplateRequest |
try {
TemplateResource result = apiInstance.copyTemplateToApp(templateId, appId, copyTemplateRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#copyTemplateToApp");
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 CopyTemplateToAppExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.onesignal.com";
// Configure Bearer token for authorization: organization_api_key
config.AccessToken = "YOUR_ORGANIZATION_API_KEY";
var apiInstance = new DefaultApi(config);
var templateId = "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c"; // string |
var appId = "00000000-0000-0000-0000-000000000000"; // string |
var copyTemplateRequest = new CopyTemplateRequest(); // CopyTemplateRequest |
try
{
// Copy template to another app
TemplateResource result = apiInstance.CopyTemplateToApp(templateId, appId, copyTemplateRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CopyTemplateToApp: " + 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.organization_api_key_token = Some("YOUR_ORGANIZATION_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 copy_template_request: models::CopyTemplateRequest = todo!();
match default_api::copy_template_to_app(&configuration, template_id, app_id, copy_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!("copy_template_to_app failed: {:?}", e.error_messages());
}
Err(e) => eprintln!("copy_template_to_app failed: {:?}", e),
}
}
components:
schemas:
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.
````