Skip to main content

Nexus API

Create deliverable

Creating a deliverable resource for a notification will place that deliverable in a queue to be delivered on a specific channel. As such, each deliverable should have its content tailored for that particular channel (e.g., HTML email). Deliverables are not guaranteed to be delivered. Zero or one deliverable per channel is acceptable.

Providing an unknown channel type will result in a 400 Bad Request response status.

Each channel has its own data dependency requirements. These requirements will not be enforced by the API, but may cause failure to deliver your notification to the user if not met.

  • Email deliverables require the user having an email address configured and verified by the user.
  • Push deliverables require the user having paired one or more mobile devices to receive notifications.
  • SMS deliverables require the user having a phone number configured and verified by the user.

In-app deliverables are immediately available to the user the next time they login. Delivery of other deliverable content is scheduled as opposed to real-time.

POST
/notifications/{notification_guid}/deliverables

Path Parameters

FieldRequiredType

notification_guid

The unique identifier for the notification. Defined by MX.

Required
String

Request Body

FieldRequiredType

deliverable

Required
DeliverableNotificationRequest
Loading...