Update Message

PUT

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

API Permit:Messages:Api:Messages:Update

API Context:Loyalty Club

Authorizations:UserToken

Request

Path Params

Query Params

Header Params

Body Params application/json

Example

{
    "message": {
        "name": "My Message",
        "shorten_urls": true,
        "track_in_shortener": true,
        "marketing": null,
        "campaign_id": 1,
        "channels": [
            {
                "type": "sms",
                "from_email": "sender@example.com",
                "from_name": "Infinity",
                "sender": {
                    "type": "alphanumeric",
                    "value": "INFINITY"
                }
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request PUT 'https://api.mpc.dev.placewise.com/v1/messages/generic/1?archived=' \
--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 '{
    "message": {
        "name": "My Message",
        "shorten_urls": true,
        "track_in_shortener": true,
        "marketing": null,
        "campaign_id": 1,
        "channels": [
            {
                "type": "sms",
                "from_email": "sender@example.com",
                "from_name": "Infinity",
                "sender": {
                    "type": "alphanumeric",
                    "value": "INFINITY"
                }
            }
        ]
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "message": {
        "id": 1,
        "name": "My Message",
        "shorten_urls": true,
        "track_in_shortener": true,
        "marketing": null,
        "campaign_id": 1,
        "channels": [
            {
                "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"
                }
            }
        ],
        "created_at": "2022-11-05T16:25:58.099512Z",
        "updated_at": "2022-11-15T16:25:58.099512Z",
        "archived_at": "2022-11-15T16:25:58.099512Z",
        "status": "active",
        "sendings_status": "draft",
        "sendings_count": 3,
        "latest_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"
        }
    }
}

🟠404Record Not Found

🟠422Invalid Parameters

Show Message

Duplicate Message