Notification

This section of the documentation describes how notification such as delivery or abuse report are sent to Sendbound.

REQUIREMENT
The base URL for all API requests is https://platform.sendbound.com/api/v1
REQUIREMENT
The API token MUST be included as a query parameter in all subsequent requests. The token value is assigned to the api_token parameter as a query parameter.

Notify

Send a delivery or abuse report to the application. It could be a success / bounce / feedback or abuse report

 POST /notification

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

{
  "message_id":"201637442604422402.6199642caf7f3@example.com",
  "type":"bounce",
  "bounce_type":"hard",
  "description":"Email+address+does+not+exist"
}

curl --location --request POST 'https://platform.sendbound.com/api/v1/notification?api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD' \
--header 'Content-Type: application/json' \
--data-raw '{
  "message_id":"201637442604422402.6199642caf7f3@example.com",
  "type":"bounce",
  "bounce_type":"hard",
  "description":"Email+address+does+not+exist"
}'

{
  "status": 1,
  "message": "Success"
}

Query Parameters

api_token

Kindly reference here to obtain the API token.

Request Parameters

message_id

Message's id

type

One of 4 types: sent | bounced | reported | failed

bounce_type

Required if type is bounced

report_type

Required if type is reported

description

Notification message

Response Parameters

status

This describes the status of the notification 1 means success, 0 means failure.

message

Notification response message

Examples

curl -X POST -H "accept:application/json" -G \
https://platform.sendbound.com/api/v1/notification \
-d api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=sent


curl -X POST -H "accept:application/json" -G \
https://platform.sendbound.com/api/v1/notification \
-d api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=bounced \
-d bounce_type=hard \
-d description=Email+address+does+not+exist


curl -X POST -H "accept:application/json" -G \
https://platform.sendbound.com/api/v1/notification \
-d api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=abuse \
-d report_type=hard \
-d description=Email+address+does+not+exist


curl -X POST -H "accept:application/json" -G \
https://platform.sendbound.com/api/v1/notification \
-d api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=spam \
-d report_type=hard \
-d description=Email+address+does+not+exist


curl -X POST -H "accept:application/json" -G \
https://platform.sendbound.com/api/v1/notification \
-d api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=failed \
-d description=Email+address+does+not+exist
Subscribers Files