Skip to main content
POST
/
templates
/
{template_id}
/
copy_to_app?app_id=
{app_id}
Copy template to another app
curl --request POST \
  --url 'https://api.onesignal.com/templates/{template_id}/copy_to_app?app_id={app_id}' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_app_id": "YOUR_OTHER_APP_ID"
}
'
{
  "success": true
}

​
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.

​
Requirements

  • Organization Membership: Both the app_id and target_app_id must belong to the same Organization.
  • Authorization Required: You must use your 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
  • In the OneSignal Dashboard under Messages > Templates > Options > Copy Template ID
Copy Template ID in OneSignal Dashboard

Copy Template ID

​
2. Get App IDs

Refer to Keys & 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)

Headers

​
Authorization
string
default:Key YOUR_ORGANIZATION_API_KEY
required

Your Organization API key with prefix Key. See Keys & IDs.

Path Parameters

​
template_id
string
default:YOUR_TEMPLATE_ID
required

The template ID in UUID v4 format. See Templates.

Query Parameters

​
app_id
string
default:YOUR_APP_ID
required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

Body

application/json
​
target_app_id
string
default:YOUR_OTHER_APP_ID
required

Specifies the OneSignal app ID that the template will be copied to. Cannot be the same as the app_id.

Response

200

​
success
boolean

Whether the template was copied successfully.