j
Push Messaging API
1
Use the push endpoints to programmatically manage push notification send definitions and send push notifications.
This table lists the use cases that the Transactional Push API supports.
| Supported Use Case | HTTP Verb | URI |
|---|---|---|
| Get push messages | GET | /push/v1/messages |
| Create push message | POST | /push/v1/message |
| Get push message by ID | GET | /push/v1/message/{messageId} |
| Update a push message | PUT | /push/v1/message/{messageId} |
| Delete a push message | DELETE | /push/v1/message/{messageId} |
| Get locations | GET | /push/v1/location |
| Create a location | POST | /push/v1/location |
| Get a location | GET | /push/v1/location/{locationId} |
| Update a location | PUT | /push/v1/location/{locationId} |
| Delete a location | DELETE | /push/v1/location/{locationId} |
| Get apps | GET | /push/v1/application |
| Get an app by ID | GET | /push/v1/application/{appId} |
| Get app keys | GET | /push/v1/application/{appId}/key |
| Update app keys | PUT | /push/v1/application/{appId}/key |
| Delete all app keys | DELETE | /push/v1/application/{appId}/key |
| Delete an app key | DELETE | /push/v1/application/{appId}/key/{key} |
| Refresh a list | POST | /push/v1/contacts/refreshList/{listId} |
| Get list refresh status | GET | /push/v1/contacts/refreshList/{listId}/status/{tokenId} |
| Send a message to all app users | POST | /push/v1/messageApp/{messageId}/send |
| Send a message to tagged users | POST | /push/v1/messageTag/{messageId}/send |
| Send a message to a list | POST | /push/v1/messageList/{messageId}/send |
| Send a batch of messages | POST | /push/v1/messageBatch/{messageid}/send |
| Send a message to specific devices | POST | /push/v1/messageContact/{messageId}/send |
| Get status for a message sent to all users | GET | /push/v1/messageApp/{messageId}/deliveries/{tokenId} |
| Get status for a message sent using tags | GET | /push/v1/messageTag/{messageId}/deliveries/{tokenId} |
| Get status for a message sent to a list | GET | /push/v1/messageList/{messageId}/deliveries/{tokenId} |
| Get status for a message sent to specific contacts | GET | /push/v1/messageContact/{messageId}/deliveries/{tokenId} |
Append the operation endpoint addresses to this base URL, replacing {subdomain} with the unique subdomain for your Marketing Cloud Engagement tenant:
https://{subdomain}.rest.marketingcloudapis.com
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!