Create Sending

POST

https://api.mpc.dev.placewise.com/v1/messages/{service}/{message_id}/sendings

API Permit:Messages:Api:Sendings:Create

API Context:Loyalty Club

Authorizations:UserToken

Creates (and schedules, if requested) Sending for given Message.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "sending": {
        "draft": false,
        "priority": 1,
        "channels_preference": [
            "sms"
        ],
        "schedule": {
            "type": "immediate"
        },
        "audience": {
            "type": "inline",
            "conditions": [
                {
                    "condition_group": "member_properties",
                    "field": "first_name",
                    "operator": "match",
                    "value": "Piotr"
                }
            ]
        },
        "recipients": [
            {
                "email": "somebody@example.com",
                "msisdn": "4740769126",
                "app_token": "bFkT5fzhdWJMJswPo3",
                "properties": {
                    "first_name": "Piotr"
                }
            }
        ],
        "properties": {
            "date": "20.01.25"
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/messages/generic/1/sendings' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sending": {
        "draft": false,
        "priority": 1,
        "channels_preference": [
            "sms"
        ],
        "schedule": {
            "type": "immediate"
        },
        "audience": {
            "type": "inline",
            "conditions": [
                {
                    "condition_group": "member_properties",
                    "field": "first_name",
                    "operator": "match",
                    "value": "Piotr"
                }
            ]
        },
        "recipients": [
            {
                "email": "somebody@example.com",
                "msisdn": "4740769126",
                "app_token": "bFkT5fzhdWJMJswPo3",
                "properties": {
                    "first_name": "Piotr"
                }
            }
        ],
        "properties": {
            "date": "20.01.25"
        }
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "sending": {
        "id": 1,
        "created_at": "2022-11-05T16:25:58.099512Z",
        "updated_at": "2022-11-15T16:25:58.099512Z",
        "scheduled_at": "2020-09-18T09:13:59.937Z",
        "transmitted_at": "2020-09-18T09:14:05.391Z",
        "status": "draft",
        "audience_id": 1,
        "recipients_count": 100,
        "dispatches_count": 100,
        "members_count": 100,
        "scheduled_with": {
            "type": "immediate"
        },
        "channels_preference": "string",
        "message_id": 1,
        "channel": {
            "type": "sms",
            "from_email": "sender@example.com",
            "from_name": "Infinity",
            "template": {
                "type": "plain",
                "content": {
                    "language": "string",
                    "body": "Hei {{name}}"
                },
                "translations": [
                    {
                        "language": "string",
                        "body": "Hei {{name}}"
                    }
                ],
                "wrapper_id": 1,
                "merge_properties": [
                    "first_name"
                ],
                "thumbnail_url": "https://img.placewise.com/image.png"
            },
            "sender": {
                "type": "alphanumeric",
                "value": "INFINITY"
            }
        },
        "recipients": [
            {
                "member_id": 1,
                "email": "somebody@example.com",
                "msisdn": "4740769126",
                "app_token": "bFkT5fzhdWJMJswPo3",
                "properties": {
                    "first_name": "Piotr"
                }
            }
        ]
    }
}

🟠404Record Not Found

🟠422Invalid Parameters

Show Sending

Update Sending