Create a notification

How to create a notification via API

To create a new notification, send a POST request to the /api/notifications endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/notifications

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.flash	boolean	Optional, default is 'false'
attributes.body	object	Optional, default to {}
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.notifiable	object	Required

Example

Request

The following request creates a new notification:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/notifications' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "notifications",
    "attributes": {
      "name": "DDT transport document"
    },
    "relationships": {
      "notifiable": {
        "data": {
          "type": "shipping_methods",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response