# Create Sending
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/v1/messages/{service}/{message_id}/sendings:
post:
summary: Create Sending
deprecated: false
description: Creates (and schedules, if requested) Sending for given Message.
tags:
- API Reference/Messaging API/Sendings
parameters:
- name: service
in: path
description: 'See: [Mesaging Services](doc-354677#services)'
required: true
example: generic
schema:
type: string
- name: message_id
in: path
description: ''
required: true
example: 1
schema:
type: integer
- 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-Loyalty-Club-Slug
in: header
description: LoyaltyClub for API context. [Details](doc-342138)
required: false
example: '{{LOYALTY_CLUB_SLUG}}'
schema:
type: string
default: '{{LOYALTY_CLUB_SLUG}}'
- 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}}
- name: X-Client-Authorization
in: header
description: '[Token](doc-342128) Authorization.'
example: '{{API_TOKEN}}'
schema:
type: string
default: '{{API_TOKEN}}'
requestBody:
content:
application/json:
schema:
type: object
properties:
sending:
$ref: '#/components/schemas/Sending%3A%3APayload'
x-apidog-orders:
- sending
required:
- sending
x-apidog-ignore-properties: []
examples: {}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
x-apidog-orders:
- sending
properties:
sending:
$ref: '#/components/schemas/Sending'
required:
- sending
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: Success
'404':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
error:
type: string
examples:
- Record not found
x-apidog-orders:
- error
required:
- error
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: Record Not Found
'422':
description: ''
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
- Invalid parameters
const: Invalid parameters
details:
type: object
properties: {}
x-apidog-orders: []
description: 'See: [Params Validation](doc-341637)'
additionalProperties: true
x-apidog-ignore-properties: []
required:
- error
- details
x-apidog-orders:
- error
- details
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: Invalid Parameters
security: []
x-apidog-folder: API Reference/Messaging API/Sendings
x-apidog-status: released
x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511364-run
components:
schemas:
Sending::Payload:
type: object
properties:
draft:
type: boolean
default: false
description: >-
If true, the Sending is created with "draft" status - it is not
scheduled for execution, even if schedule is present
priority:
type: integer
minimum: 1
maximum: 10
description: Requires `Messages:Api:Sendings:SetPriority` permit
channels_preference:
type: array
items:
type: string
enum:
- sms
- email
- push
x-apidog-enum:
- value: sms
name: ''
description: ''
- value: email
name: ''
description: ''
- value: push
name: ''
description: ''
examples:
- sms
- email
description: >-
Channels to be used for delivering the Message and their preferred
order. See: [Channels preference](doc-354473#channels-preference)
schedule:
oneOf:
- &ref_6
$ref: '#/components/schemas/Immediate'
- &ref_7
$ref: '#/components/schemas/Absolute'
- &ref_8
$ref: '#/components/schemas/Relative'
- type: 'null'
description: 'See: [Sending schedule](doc-354473#schedule)'
audience:
oneOf:
- $ref: '#/components/schemas/Inline'
- $ref: '#/components/schemas/Reference'
- type: 'null'
description: >-
Audience that should receive the Sending. See: [Audience
recipients](doc-354473#audience-recipients)
recipients:
type: array
items: &ref_9
properties:
member_id:
description: ID of the MPC [Member](doc-342131)
anyOf:
- &ref_0
$ref: '#/components/schemas/id'
- type: 'null'
email:
description: Email address of the recipient
anyOf:
- &ref_1
$ref: '#/components/schemas/email'
- type: 'null'
properties:
type: object
properties: {}
x-apidog-orders: []
description: Recipient-specific merge-tags
additionalProperties: true
examples:
- first_name: Piotr
nullable: true
msisdn:
description: Phone number of the recipient
anyOf:
- &ref_2
$ref: '#/components/schemas/msisdn'
- type: 'null'
app_token:
type: string
examples:
- bFkT5fzhdWJMJswPo3
description: App token of the recipient
nullable: true
additionalProperties: false
x-apidog-orders:
- member_id
- email
- msisdn
- app_token
- properties
required:
- member_id
- email
- properties
- msisdn
- app_token
$ref: '#/components/schemas/Recipient'
description: >-
Inline recipients that should receive the Sending. See: [Inline
recipients](doc-354473#inline-recipients)
properties:
type: object
properties: {}
x-apidog-orders: []
description: >-
Sending-wide merge-properties for [templating
system](doc-354486#liquid-template-language)
additionalProperties: true
title: ''
examples:
- date: 20.01.25
x-apidog-ignore-properties: []
additionalProperties: false
x-apidog-orders:
- draft
- priority
- channels_preference
- schedule
- audience
- recipients
- properties
required:
- properties
x-apidog-ignore-properties: []
x-apidog-folder: ''
msisdn:
type: string
description: '[E.164 MSISDN](https://en.wikipedia.org/wiki/E.164) '
examples:
- '4740769126'
x-apidog-folder: ''
email:
type: string
format: email
examples:
- somebody@example.com
x-apidog-folder: ''
id:
type: integer
description: Primary identifier of the record
format: uint64
readOnly: true
examples:
- 1
x-apidog-folder: ''
Recipient:
type: object
properties:
member_id:
description: ID of the MPC [Member](doc-342131)
anyOf:
- *ref_0
- type: 'null'
email:
description: Email address of the recipient
anyOf:
- *ref_1
- type: 'null'
msisdn:
description: Phone number of the recipient
anyOf:
- *ref_2
- type: 'null'
app_token:
type: string
examples:
- bFkT5fzhdWJMJswPo3
description: App token of the recipient
nullable: true
properties:
type: object
properties:
language: &ref_3
$ref: '#/components/schemas/language'
description: >-
[Language tag](doc-341959#suported-language-tags). See:
[Internationalized
content](doc-354486#internationalized-content)
x-apidog-orders:
- 01K4JHPKVR6DW20ZYYS8REVH2X
description: >-
Recipient-specific arbitrary properties, can be used as merge
properties for [templating
system](doc-354486#liquid-template-language)
additionalProperties: true
examples:
- first_name: Piotr
x-apidog-refs:
01K4JHPKVR6DW20ZYYS8REVH2X: &ref_16
$ref: '#/components/schemas/language1'
x-apidog-ignore-properties:
- language
nullable: true
additionalProperties: false
x-apidog-orders:
- member_id
- email
- msisdn
- app_token
- properties
required:
- member_id
- email
- msisdn
- app_token
- properties
x-apidog-ignore-properties: []
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_3
x-apidog-orders:
- language
x-apidog-ignore-properties: []
x-apidog-folder: ''
Reference:
type: object
properties:
type:
type: string
const: reference
id:
type: integer
description: For reference type - ID of audience the sending should be sent to
format: uint64
minimum: 1
required:
- type
additionalProperties: false
x-apidog-orders:
- type
- id
x-apidog-ignore-properties: []
x-apidog-folder: ''
Inline:
type: object
properties:
type:
type: string
const: inline
conditions:
type: array
items:
type: object
properties:
condition_group:
type: string
examples:
- member_properties
field:
type: string
examples:
- first_name
operator:
type: string
examples:
- match
value:
type: string
examples:
- Piotr
additionalProperties: true
x-apidog-orders:
- condition_group
- field
- operator
- value
required:
- condition_group
- field
- operator
- value
x-apidog-ignore-properties: []
description: >-
For inline type - conditions. See: [DMP
docs](https://dmp.boostcom.no/docs/#conditions)
required:
- type
additionalProperties: false
x-apidog-orders:
- type
- conditions
x-apidog-ignore-properties: []
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_4
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_5
$ref: '#/components/schemas/Base'
x-apidog-ignore-properties:
- prescheduled
x-apidog-folder: ''
Base:
type: object
properties:
prescheduled: *ref_4
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_4
x-apidog-orders:
- type
- at
- 01K4ABXG887KQBS3M7DFT0DHQ6
required:
- type
- at
x-apidog-refs:
01K4ABXG887KQBS3M7DFT0DHQ6: *ref_5
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: ''
Sending:
type: object
properties:
id: *ref_0
created_at: &ref_20
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_21
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: &ref_22
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: &ref_23
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_0
- &ref_24
type: 'null'
transmitted_at: &ref_25
type: string
description: Time at which the Sending was fully transmitted
format: date-time
examples:
- '2020-09-18T09:14:05.391Z'
nullable: true
status: &ref_26
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: &ref_27
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_0
- &ref_28
type: 'null'
recipients_count: &ref_29
type: integer
examples:
- 100
readOnly: true
description: Number of [inline recipients](doc-354473#inline-recipients)
nullable: true
dispatches_count: &ref_30
type: integer
examples:
- 100
readOnly: true
description: |-
Number of dispatches built. Null when Sending transmission
has not started yet
nullable: true
members_count: &ref_31
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_6
- *ref_7
- *ref_8
- &ref_32
type: 'null'
description: Params that Sending was [scheduled](doc-354473#schedule) with
channels_preference: &ref_33
type: string
description: Provided [Channels preference](doc-354473#channels-preference)
nullable: true
message_id: *ref_0
channel:
anyOf:
- $ref: '#/components/schemas/Channel'
- type: 'null'
description: >-
Channel the Sending was sent with. Present only when the Message is
single channel.
recipients:
type: array
items: *ref_9
description: '[Inline recipients](doc-354473#inline-recipients) of the Sending'
x-apidog-orders:
- 01K4D8DJXP6NW36V4YNQKGWPCQ
- message_id
- channel
- recipients
x-apidog-refs:
01K4D8DJXP6NW36V4YNQKGWPCQ:
$ref: '#/components/schemas/Sending%3A%3ACore'
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
- message_id
- channel
- recipients
x-apidog-ignore-properties:
- 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
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_15
$ref: '#/components/schemas/Template%3A%3ACore'
readOnly: true
- type: object
properties:
type:
type: string
const: inline
definition:
type: object
properties:
id: *ref_0
type: &ref_17
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_10
$ref: '#/components/schemas/Plain'
- &ref_11
$ref: '#/components/schemas/Email'
- &ref_12
$ref: '#/components/schemas/BeeEmail'
- &ref_13
$ref: '#/components/schemas/Push'
- &ref_14
$ref: '#/components/schemas/Generic'
translations:
type: array
items:
oneOf:
- *ref_10
- *ref_11
- *ref_12
- *ref_13
- *ref_14
description: >-
See: [Internationalized
content](doc-354486#internationalized-content)
nullable: true
wrapper_id:
anyOf:
- *ref_0
- &ref_18
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 detected in the contect
thumbnail_url: &ref_19
type: string
deprecated: true
examples:
- https://img.placewise.com/image.png
readOnly: true
nullable: true
x-apidog-orders:
- 01K485G8ZF8MRMW1SSNZ49ZAKP
description: >-
Definition of Template to assign. See: [Template
Model](doc-354486)
x-apidog-refs:
01K485G8ZF8MRMW1SSNZ49ZAKP: *ref_15
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: ''
Generic:
type: object
properties:
language: *ref_3
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_16
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
Push:
type: object
properties:
language: *ref_3
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_16
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
BeeEmail:
type: object
properties:
language: *ref_3
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_16
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
Email:
type: object
properties:
language: *ref_3
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_16
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
Plain:
type: object
properties:
language: *ref_3
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_16
x-apidog-ignore-properties:
- language
x-apidog-folder: ''
Template::Core:
type: object
properties:
id: *ref_0
type: *ref_17
content:
oneOf:
- *ref_10
- *ref_11
- *ref_12
- *ref_13
- *ref_14
translations:
type: array
items:
oneOf:
- *ref_10
- *ref_11
- *ref_12
- *ref_13
- *ref_14
description: >-
See: [Internationalized
content](doc-354486#internationalized-content)
nullable: true
wrapper_id:
anyOf:
- *ref_0
- *ref_18
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_19
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: ''
id2:
type: object
properties:
id: *ref_0
x-apidog-orders:
- id
required:
- id
x-apidog-ignore-properties: []
x-apidog-folder: ''
Sending::Core:
type: object
properties:
id: *ref_0
created_at: *ref_20
updated_at: *ref_21
scheduled_at: *ref_22
scheduled_by: *ref_23
reporting_id:
description: Identifier of the Sending in the [MPC Reporting](doc-354454)
anyOf:
- *ref_0
- *ref_24
transmitted_at: *ref_25
status: *ref_26
status_type: *ref_27
audience_id:
description: >-
ID of [audience](doc-354473#audience-recipients) the sending is
directed to
anyOf:
- *ref_0
- *ref_28
recipients_count: *ref_29
dispatches_count: *ref_30
members_count: *ref_31
scheduled_with:
oneOf:
- *ref_6
- *ref_7
- *ref_8
- *ref_32
description: Params that Sending was [scheduled](doc-354473#schedule) with
channels_preference: *ref_33
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: ''
Base record attributes:
type: object
properties:
id: *ref_0
created_at: *ref_20
updated_at: *ref_21
x-apidog-orders:
- id
- created_at
- updated_at
required:
- id
- created_at
- updated_at
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes: {}
servers:
- url: https://api.mpc.dev.placewise.com
description: Staging
security: []
```