Create Template
POST /v2/partner/templates
Required scopes
partner:templates:write
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | createTemplate |
| Tags | Campaigns |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| — | |||
| — |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | template |
| team_id * | id | UUID v4. |
| name * | string | |
| use_case | string | |
| status * | enum (6) | draftscheduledlaunchedpausedarchivedexpired |
| is_archived * | boolean | |
| is_locked * | boolean | |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| launched_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| archived_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| deadline_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| objective_ids * | id[] | |
| page_ids * | id[] | |
| message_ids * | id[] |
Responses
201
Created
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | template |
| team_id * | id | UUID v4. |
| name * | string | |
| use_case | string | |
| status * | enum (6) | draftscheduledlaunchedpausedarchivedexpired |
| is_archived * | boolean | |
| is_locked * | boolean | |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| launched_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| archived_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| deadline_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| objective_ids * | id[] | |
| page_ids * | id[] | |
| message_ids * | id[] |
401
409
Idempotency conflict or invalid state transition.
schema
422
Schema validation failed.
schema
Example request
POST https://api.digitalonboarding.com/v2/partner/templates
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }