# List Messages Overview
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/v1/campaigns/messages_overview:
get:
summary: List Messages Overview
deprecated: false
description: ''
tags:
- API Reference/Messaging API/Messages
parameters:
- name: status
in: query
description: Delivery status for the requested messages
required: false
example: ''
schema:
type: string
enum:
- draft
- scheduled
- preparing
- prepared
- transmitting
- transmitted
- cancelled
- failed
- skipped
x-apidog-enum:
- value: draft
name: ''
description: ''
- value: scheduled
name: ''
description: ''
- value: preparing
name: ''
description: ''
- value: prepared
name: ''
description: ''
- value: transmitting
name: ''
description: ''
- value: transmitted
name: ''
description: ''
- value: cancelled
name: ''
description: ''
- value: failed
name: ''
description: ''
- value: skipped
name: ''
description: ''
- name: status_type
in: query
description: Delivery status type for the requested messages
required: false
example: ''
schema:
type: string
enum:
- draft
- scheduled
- finished
x-apidog-enum:
- value: draft
name: ''
description: ''
- value: scheduled
name: ''
description: ''
- value: finished
name: ''
description: ''
- name: audience_ids
in: query
description: Audience IDs for the requested messages
required: false
example: ''
schema:
type: array
items:
type: string
- name: campaign_ids
in: query
description: Campaign IDs for the requested messages
required: false
example: ''
schema:
type: array
items:
type: string
- name: message_ids
in: query
description: IDs for the requested messages
required: false
example: ''
schema:
type: array
items:
type: string
- name: scheduled_at_start
in: query
description: Start of the scheduled_at window for the requested messages
required: false
example: ''
schema:
type: string
format: date
examples:
- '2025-12-01'
- name: scheduled_at_end
in: query
description: End of the scheduled_at window for the requested messages
required: false
example: ''
schema:
type: string
format: date
examples:
- '2025-12-31'
- name: search
in: query
description: Search term for message names or campaign names
required: false
example: ''
schema:
type: string
examples:
- test
maxLength: 255
- name: channels
in: query
description: Channel types of the requested messages
required: false
example:
- ''
schema:
type: array
items:
type: string
- name: null_position
in: query
description: When present, changes the position of null values in sorting
required: false
schema:
type: string
enum:
- FIRST
- LAST
x-apidog-enum:
- value: FIRST
name: ''
description: ''
- value: LAST
name: ''
description: ''
examples:
- LAST
nullable: true
- name: per_page
in: query
description: >-
Number of results to be returned per request. See: [API
Pagination](doc-341638)
example: 10
schema:
type: integer
default: '10'
- name: page_no
in: query
description: 'Number of results page. See: [API Pagination](doc-341638)'
example: 1
schema:
type: integer
minimum: 1
default: '1'
- name: sort_by[]
in: query
description: 'See: [Sorting params](doc-341639)'
example: id
schema:
type: string
default: id
- name: sort_directions[]
in: query
description: 'See: [Sorting params](doc-341639)'
example: DESC
schema:
type: string
enum:
- ASC
- DESC
examples:
- ASC
- DESC
default: DESC
x-apidog-enum:
- value: ASC
name: ''
description: ''
- value: DESC
name: ''
description: ''
- name: with_archived
in: query
description: When true, also archived record will be treated as accessible
example: 'false'
schema:
type: boolean
default: 'false'
- name: only_archived
in: query
description: When true, only archived record will be treated as accessible
example: 'false'
schema:
type: boolean
default: 'false'
- name: Content-Type
in: header
description: '[Details](doc-341635)'
required: true
example: application/json
schema:
type: string
default: application/json
const: application/json
- name: X-User-Agent
in: header
description: Arbitrary identifier of your client. [Details](doc-341635)
required: true
example: '{{X_USER_AGENT}}'
schema:
type: string
default: '{{X_USER_AGENT}}'
- name: X-Product-Name
in: header
description: API Product for API context. [Details](doc-341635)
required: true
example: '{{PRODUCT_NAME}}'
schema:
type: string
default: '{{PRODUCT_NAME}}'
- name: X-Customer
in: header
description: Customer for API context. [Details](doc-342139)
required: false
example: '{{CUSTOMER_ID}}'
schema:
type: string
default: '{{CUSTOMER_ID}}'
- name: Authorization
in: header
description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
required: false
example: Bearer {{_OAUTH_TOKEN}}
schema:
type: string
default: Bearer {{_OAUTH_TOKEN}}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
name:
type: string
description: Arbitrary name for internal identification
examples:
- My Message
nullable: true
shorten_urls:
type: boolean
description: >
Should sendings for this message have URLs shortened
with MPC Shortener?
default: true
nullable: true
track_in_shortener:
type: boolean
description: >
(NOT IMPLEMENTED) Should members opening shortened
URLs be tracked
default: true
deprecated: true
nullable: true
marketing:
type: boolean
default: null
description: >-
Does Message has marketing purposes? See: [Marketing
purpose](doc-354471#marketing-purpose)
nullable: true
campaign_id:
type: integer
description: >-
ID of [Campaign](doc-355433) (applicable to selected
[services](api-3927095))
minimum: 1
format: uint64
nullable: true
channels:
type: array
items:
properties:
type:
type: string
enum:
- sms
- email
- push
x-apidog-enum:
- value: sms
name: ''
description: ''
- value: email
name: ''
description: ''
- value: push
name: ''
description: ''
examples:
- sms
sender:
oneOf:
- type: object
properties:
type:
type: string
const: alphanumeric
examples:
- alphanumeric
value:
type: string
minLength: 2
maxLength: 11
examples:
- INFINITY
x-apidog-orders:
- type
- value
required:
- type
- value
- type: object
properties:
type:
type: string
const: international
examples:
- international
value:
type: string
examples:
- '4740485124'
description: '[MSISDN](doc-341641#msisdn)'
x-apidog-orders:
- type
- value
required:
- type
- value
description: >-
See: [Channel
attributes](doc-354471#channel-attributes)
from_email:
type: string
description: >-
See: [Channel
attributes](doc-354471#channel-attributes)
format: email
examples:
- sender@example.com
nullable: true
from_name:
type: string
description: >-
See: [Channel
attributes](doc-354471#channel-attributes)
examples:
- Infinity
nullable: true
template:
oneOf:
- &ref_0
$ref: '#/components/schemas/Template%3A%3ACore'
readOnly: true
- type: object
properties:
type:
type: string
const: inline
definition:
type: object
properties: {}
x-apidog-orders:
- 01K485G8ZF8MRMW1SSNZ49ZAKP
description: >-
Definition of Template to assign. See:
[Template Model](doc-354486)
x-apidog-refs:
01K485G8ZF8MRMW1SSNZ49ZAKP: *ref_0
nullable: true
x-apidog-orders:
- type
- definition
required:
- type
writeOnly: true
- type: object
properties:
type:
type: string
const: reference
id:
type: integer
description: ID of Template to assign
minimum: 1
format: uint64
x-apidog-orders:
- type
- id
x-apidog-refs: {}
required:
- type
- id
writeOnly: true
description: 'See: [Template Model](doc-354486)'
x-apidog-orders:
- type
- from_email
- from_name
- template
- sender
required:
- type
- template
x-apidog-refs: {}
$ref: '#/components/schemas/Channel'
description: |
Channels the message is sent with
campaign:
type: object
properties:
id:
type: integer
format: uint64
name:
type: string
x-apidog-orders:
- id
- name
required:
- id
- name
x-apidog-ignore-properties: []
sending:
$ref: '#/components/schemas/Sending%3A%3ACore'
customer_id:
$ref: '#/components/schemas/id.customer_id'
x-apidog-refs: {}
x-apidog-orders:
- name
- shorten_urls
- track_in_shortener
- marketing
- campaign_id
- channels
- campaign
- sending
- customer_id
required:
- name
- shorten_urls
- track_in_shortener
- marketing
- campaign_id
- campaign
- sending
- customer_id
x-apidog-ignore-properties: []
x-apidog-orders:
- message
required:
- message
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: Success
security: []
x-apidog-folder: API Reference/Messaging API/Messages
x-apidog-status: released
x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-4020083-run
components:
schemas:
id.customer_id:
type: integer
format: uint64
readOnly: true
examples:
- 447
description: Customer the record is assigned to
x-apidog-folder: ''
Sending::Core:
type: object
properties:
id: &ref_1
$ref: '#/components/schemas/id'
description: Primary identifier of the record
readOnly: true
created_at: &ref_4
type: string
description: Time at which the record was created
format: date-time
readOnly: true
examples:
- '2022-11-15T16:25:58.099512Z'
updated_at: &ref_5
type: string
description: Time at which the record was updated for the last time
format: date-time
readOnly: true
examples:
- '2022-11-15T16:25:58.099512Z'
scheduled_at:
type: string
description: >-
Time at which the Sending should be executed. Resolved from
[schedule](doc-354473#schedule)
format: date-time
examples:
- '2020-09-18T09:13:59.937Z'
nullable: true
scheduled_by:
type: string
description: ID of a user that scheduled the Sending
format: uuid
readOnly: true
examples:
- 327a9f1b-e620-4e6b-b06e-041589bffde2
nullable: true
reporting_id:
description: Identifier of the Sending in the [MPC Reporting](doc-354454)
anyOf:
- *ref_1
- type: 'null'
transmitted_at:
type: string
description: Time at which the Sending was fully transmitted
format: date-time
examples:
- '2020-09-18T09:14:05.391Z'
nullable: true
status:
type: string
description: 'See: [Sendings status](doc-354473#sending-status)'
enum:
- draft
- scheduled
- preparing
- prepared
- transmitting
- transmitted
- skipped
- cancelled
- failed
x-apidog-enum:
- value: draft
name: ''
description: ''
- value: scheduled
name: ''
description: ''
- value: preparing
name: ''
description: ''
- value: prepared
name: ''
description: ''
- value: transmitting
name: ''
description: ''
- value: transmitted
name: ''
description: ''
- value: skipped
name: ''
description: ''
- value: cancelled
name: ''
description: ''
- value: failed
name: ''
description: ''
examples:
- scheduled
status_type:
type: string
description: 'See: [Sendings status](doc-354473#sending-status)'
examples:
- scheduled
enum:
- draft
- scheduled
- finished
x-apidog-enum:
- value: draft
name: ''
description: ''
- value: scheduled
name: ''
description: ''
- value: finished
name: ''
description: ''
audience_id:
description: >-
ID of [audience](doc-354473#audience-recipients) the sending is
directed to
anyOf:
- *ref_1
- type: 'null'
recipients_count:
type: integer
examples:
- 100
readOnly: true
description: Number of [inline recipients](doc-354473#inline-recipients)
nullable: true
dispatches_count:
type: integer
examples:
- 100
readOnly: true
description: |-
Number of dispatches built. Null when Sending transmission
has not started yet
nullable: true
members_count:
type: integer
title: ''
examples:
- 100
readOnly: true
description: >-
Number of distinct members to whom Message has been sent to. Null
when Sending has not started yet
nullable: true
scheduled_with:
oneOf:
- $ref: '#/components/schemas/Immediate'
- $ref: '#/components/schemas/Absolute'
- $ref: '#/components/schemas/Relative'
- type: 'null'
description: Params that Sending was [scheduled](doc-354473#schedule) with
channels_preference:
type: string
description: Provided [Channels preference](doc-354473#channels-preference)
nullable: true
x-apidog-orders:
- 01K4D7E81VBHFWRCE2A4ZCJWJF
- scheduled_at
- scheduled_by
- reporting_id
- transmitted_at
- status
- status_type
- audience_id
- recipients_count
- dispatches_count
- members_count
- scheduled_with
- channels_preference
readonly: true
required:
- id
- created_at
- updated_at
- scheduled_at
- scheduled_by
- reporting_id
- transmitted_at
- status
- status_type
- audience_id
- recipients_count
- dispatches_count
- members_count
- scheduled_with
- channels_preference
readOnly: true
x-apidog-refs:
01K4D7E81VBHFWRCE2A4ZCJWJF:
$ref: '#/components/schemas/Base%20record%20attributes'
x-apidog-ignore-properties:
- id
- created_at
- updated_at
x-apidog-folder: ''
Relative:
type: object
properties:
type:
type: string
const: relative
in:
type: string
description: Time period, see [here](doc-354473#format-of--parameter)
pattern: ^\d+ (second|minute|hour|day|week|month|year)s?$
examples:
- 30 minutes
prescheduled: &ref_2
type: boolean
description: >-
For relative and absolute types - preparation starts 5 minutes
before transmission
default: false
x-apidog-orders:
- type
- in
- 01K4ABXVYNQ6E8JVRESDNASGG2
required:
- type
- in
x-apidog-refs:
01K4ABXVYNQ6E8JVRESDNASGG2: &ref_3
$ref: '#/components/schemas/Base'
x-apidog-ignore-properties:
- prescheduled
x-apidog-folder: ''
Base:
type: object
properties:
prescheduled: *ref_2
x-apidog-orders:
- prescheduled
x-apidog-ignore-properties: []
x-apidog-folder: ''
Absolute:
type: object
properties:
type:
type: string
const: absolute
at:
description: Defines exact time the sending should be executed at
$ref: '#/components/schemas/date_time'
prescheduled: *ref_2
x-apidog-orders:
- type
- at
- 01K4ABXG887KQBS3M7DFT0DHQ6
required:
- type
- at
x-apidog-refs:
01K4ABXG887KQBS3M7DFT0DHQ6: *ref_3
x-apidog-ignore-properties:
- prescheduled
x-apidog-folder: ''
date_time:
type: string
format: date-time
examples:
- '2022-11-09T16:25:58.099512Z'
x-apidog-folder: ''
Immediate:
type: object
properties:
type:
type: string
const: immediate
x-apidog-orders:
- type
required:
- type
x-apidog-refs: {}
x-apidog-ignore-properties: []
x-apidog-folder: ''
id:
type: integer
description: Primary identifier of the record
format: uint64
readOnly: true
examples:
- 1
x-apidog-folder: ''
Base record attributes:
type: object
properties:
id: *ref_1
created_at: *ref_4
updated_at: *ref_5
x-apidog-orders:
- id
- created_at
- updated_at
required:
- id
- created_at
- updated_at
x-apidog-ignore-properties: []
x-apidog-folder: ''
Template::Core:
type: object
properties:
id: *ref_1
type: &ref_13
type: string
enum:
- plain
- email
- bee_email
- push
- generic
x-apidog-enum:
- value: plain
name: ''
description: ''
- value: email
name: ''
description: ''
- value: bee_email
name: ''
description: ''
- value: push
name: ''
description: ''
- value: generic
name: ''
description: ''
description: 'See: [Template types](doc-354486#types)'
content:
oneOf:
- &ref_6
$ref: '#/components/schemas/Plain'
- &ref_7
$ref: '#/components/schemas/Email'
- &ref_8
$ref: '#/components/schemas/BeeEmail'
- &ref_9
$ref: '#/components/schemas/Push'
- &ref_10
$ref: '#/components/schemas/Generic'
translations:
type: array
items:
oneOf:
- *ref_6
- *ref_7
- *ref_8
- *ref_9
- *ref_10
description: >-
See: [Internationalized
content](doc-354486#internationalized-content)
nullable: true
wrapper_id:
anyOf:
- *ref_1
- &ref_14
type: 'null'
description: >-
ID of a [Standalone Template](doc-354680) that should
[wrap](doc-354486#template-wrapping) this one
merge_properties:
type: array
items:
type: string
examples:
- first_name
- last_name
readOnly: true
description: >-
List of all the [merge-properties](doc-354486#merge-properties)
detected in the contect
thumbnail_url: &ref_15
type: string
deprecated: true
examples:
- https://img.placewise.com/image.png
readOnly: true
nullable: true
x-apidog-orders:
- 01K7EGRYVSWH7VRS1YHWZRRRJW
- type
- content
- translations
- wrapper_id
- merge_properties
- thumbnail_url
additional_properties: false
required:
- id
- type
- content
- translations
- wrapper_id
- merge_properties
- thumbnail_url
readOnly: true
x-apidog-refs:
01K7EGRYVSWH7VRS1YHWZRRRJW:
$ref: '#/components/schemas/id2'
additionalProperties: false
x-apidog-ignore-properties:
- id
x-apidog-folder: ''
Generic:
type: object
properties:
language: &ref_11
$ref: '#/components/schemas/language'
description: >-
[Language tag](doc-341959#suported-language-tags). See:
[Internationalized content](doc-354486#internationalized-content)
body:
type: string
title: ''
examples:
- Hi {{name}}
subject:
type: string
examples:
- Welcome!
nullable: true
preheader:
type: string
nullable: true
url:
type: string
description: |
URL to be used by mobile app for redirecting the user
nullable: true
image_url:
type: string
description: |
URL of image to be displayed within push
nullable: true
data:
type: object
examples:
- https://example.placewise.com/image.png
properties: {}
x-apidog-orders: []
title: ''
description: |
Additional data to be passed to mobile app
x-apidog-ignore-properties: []
nullable: true
android_payload:
type: object
properties: {}
x-apidog-orders: []
description: >-
Additional android-specific payload [see
more](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidnotification)
x-apidog-ignore-properties: []
nullable: true
ios_payload:
type: object
properties: {}
x-apidog-orders: []
description: >-
Additional ios-specific payload [see
more](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification#2943363)
x-apidog-ignore-properties: []
nullable: true
footer:
type: string
examples:
- 'To unsubscribe, send STOP to 2242 '
x-apidog-orders:
- 01K4D99PJ86J7BM5QPDVSBC1X1
- body
- subject
- preheader
- url
- image_url
- data
- android_payload
- ios_payload
- footer
required:
- body
- subject
- preheader
- url
- image_url
- data
- android_payload
- ios_payload
x-apidog-refs:
01K4D99PJ86J7BM5QPDVSBC1X1: &ref_12
$ref: '#/components/schemas/language1'
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
language:
type: string
description: 'See: [Supported language tags](doc-341959#suported-language-tags)'
x-apidog-folder: ''
language1:
type: object
properties:
language: *ref_11
x-apidog-orders:
- language
x-apidog-ignore-properties: []
x-apidog-folder: ''
Push:
type: object
properties:
language: *ref_11
body:
type: string
title: ''
examples:
- Hi {{name}}
subject:
type: string
examples:
- Welcome!
nullable: true
url:
type: string
description: |
URL to be used by mobile app for redirecting the user
nullable: true
image_url:
type: string
description: |
URL of image to be displayed within push
nullable: true
data:
type: object
examples:
- foo: bar
properties: {}
x-apidog-orders: []
title: ''
description: Additional data to be passed to mobile app
x-apidog-ignore-properties: []
nullable: true
android_payload:
type: object
properties: {}
x-apidog-orders: []
description: >-
Additional android-specific payload [see
more](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidnotification)
x-apidog-ignore-properties: []
nullable: true
ios_payload:
type: object
properties: {}
x-apidog-orders: []
description: >-
Additional ios-specific payload [see
more](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification#2943363)
x-apidog-ignore-properties: []
nullable: true
x-apidog-orders:
- 01K4D99802FW050SST12634SE7
- body
- subject
- url
- image_url
- data
- android_payload
- ios_payload
required:
- body
- subject
- url
- image_url
- data
- android_payload
- ios_payload
x-apidog-refs:
01K4D99802FW050SST12634SE7: *ref_12
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
BeeEmail:
type: object
properties:
language: *ref_11
body:
type: string
title: ''
examples:
- Hei {{name}}
readOnly: true
subject:
type: string
examples:
- Welcome!
nullable: true
preheader:
type: string
examples:
- Something informative
nullable: true
thumbnail:
type: object
properties:
url:
type: string
description: Auto-generated preview of the email body
examples:
- https://example.placewise.com/image.png
readOnly: true
x-apidog-orders:
- url
required:
- url
readOnly: true
x-apidog-ignore-properties: []
bee_json:
type: object
properties: {}
examples:
- foo: bar
x-apidog-orders: []
description: JSON generated by [Beefree](https://docs.beefree.io/beefree-sdk)
x-apidog-ignore-properties: []
nullable: true
x-apidog-orders:
- 01K4D98T2CBAPKZQ6J0NX89ST6
- body
- subject
- preheader
- thumbnail
- bee_json
required:
- body
- subject
- preheader
- thumbnail
- bee_json
x-apidog-refs:
01K4D98T2CBAPKZQ6J0NX89ST6: *ref_12
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
Email:
type: object
properties:
language: *ref_11
body:
type: string
title: ''
examples:
- Hei {{name}}
subject:
type: string
examples:
- Welcome!
nullable: true
preheader:
type: string
examples:
- Something informative
nullable: true
thumbnail:
type: object
properties:
url:
type: string
description: Auto-generated preview of the email body
examples:
- https://example.placewise.com/image.png
readOnly: true
x-apidog-orders:
- url
required:
- url
readOnly: true
x-apidog-ignore-properties: []
x-apidog-orders:
- 01K4D980ZER3D14Q0JFA9BSQCC
- body
- subject
- preheader
- thumbnail
required:
- body
- subject
- preheader
- thumbnail
x-apidog-refs:
01K4D980ZER3D14Q0JFA9BSQCC: *ref_12
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
Plain:
type: object
properties:
language: *ref_11
body:
type: string
title: ''
examples:
- Hei {{name}}
footer:
type: string
examples:
- 'To unsubscribe, send STOP to 2242 '
x-apidog-orders:
- 01K4JHYK3FA0PJJVS6FMVM6HCY
- body
- footer
required:
- body
x-apidog-refs:
01K4JHYK3FA0PJJVS6FMVM6HCY: *ref_12
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
id2:
type: object
properties:
id: *ref_1
x-apidog-orders:
- id
required:
- id
x-apidog-ignore-properties: []
x-apidog-folder: ''
Channel:
properties:
type:
type: string
enum:
- sms
- email
- push
x-apidog-enum:
- value: sms
name: ''
description: ''
- value: email
name: ''
description: ''
- value: push
name: ''
description: ''
examples:
- sms
include_footer:
type: boolean
description: >-
(SMS-only) Should a [predefined](api-3511372) footer be added to the
content of sent messages?
default: false
nullable: true
sender:
oneOf:
- type: object
properties:
from_email:
type: string
description: 'See: [Channel attributes](doc-354471#channel-attributes)'
format: email
examples:
- sender@example.com
nullable: true
from_name:
type: string
description: 'See: [Channel attributes](doc-354471#channel-attributes)'
examples:
- Infinity
nullable: true
x-apidog-orders:
- from_email
- from_name
required:
- from_email
- from_name
x-apidog-ignore-properties: []
- type: object
properties:
type:
type: string
const: international
examples:
- international
value:
type: string
examples:
- '4740485124'
description: '[MSISDN](doc-341641#msisdn)'
x-apidog-orders:
- type
- value
required:
- type
- value
x-apidog-ignore-properties: []
- type: 'null'
description: 'See: [Channel attributes](doc-354471#channel-attributes)'
template:
oneOf:
- *ref_0
- type: object
properties:
type:
type: string
const: inline
definition:
type: object
properties:
id: *ref_1
type: *ref_13
content:
oneOf:
- *ref_6
- *ref_7
- *ref_8
- *ref_9
- *ref_10
translations:
type: array
items:
oneOf:
- *ref_6
- *ref_7
- *ref_8
- *ref_9
- *ref_10
description: >-
See: [Internationalized
content](doc-354486#internationalized-content)
nullable: true
wrapper_id:
anyOf:
- *ref_1
- *ref_14
description: >-
ID of a [Standalone Template](doc-354680) that should
[wrap](doc-354486#template-wrapping) this one
merge_properties:
type: array
items:
type: string
examples:
- first_name
- last_name
readOnly: true
description: List of all the merge-properties detected in the contect
thumbnail_url: *ref_15
x-apidog-orders:
- 01K485G8ZF8MRMW1SSNZ49ZAKP
description: >-
Definition of Template to assign. See: [Template
Model](doc-354486)
x-apidog-refs:
01K485G8ZF8MRMW1SSNZ49ZAKP: *ref_0
required:
- id
- type
- content
- translations
- wrapper_id
- merge_properties
- thumbnail_url
x-apidog-ignore-properties:
- id
- type
- content
- translations
- wrapper_id
- merge_properties
- thumbnail_url
nullable: true
x-apidog-orders:
- type
- definition
required:
- type
writeOnly: true
x-apidog-ignore-properties: []
- type: object
properties:
type:
type: string
const: reference
id:
type: integer
description: ID of Template to assign
minimum: 1
format: uint64
x-apidog-orders:
- type
- id
x-apidog-refs: {}
required:
- type
- id
writeOnly: true
x-apidog-ignore-properties: []
description: 'See: [Template Model](doc-354486#template-model)'
x-apidog-orders:
- type
- include_footer
- sender
- template
required:
- type
- template
x-apidog-refs: {}
type: object
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes: {}
servers:
- url: https://api.mpc.dev.placewise.com
description: Staging
security: []
```