Notifications

Get, add or remove contacts (sms or email) to be notified when the status of a tracking has changed.

Pro Tip!

You can always use/:tracking_id to replace /:slug/:tracking_number
e.g. DELETE /notifications/:tracking_id


POST /notifications/:slug/:tracking_number/add

Headers

aftership-api-key: YOUR_API_KEY
Content-Type: application/json

Parameters

Optional Parameters
ParameterTypeDescription
emailsArray or StringEmail address(es) to receive email notifications.
Accept either array or comma separated as input.
smsesArray or StringPhone number(s) to receive sms notifications. Enter+andarea codebefore phone number.
Accept either array or comma separated as input.

Body

{
    "notification": {
        "emails": ["user1@gmail.com","user2@gmail.com","invalid EMail @ Gmail. com"],
        "smses": ["+85291239123", "+85261236123", "Invalid Mobile Phone Number"]
    }
}

Headers

HTTP/1.1 201 Created
Content-Type: application/json
Connection: keep-alive
Date: Mon, 10 Jun 2013 07:38:02 GMT

Attributes

Attributes
AttributeTypeDescription
notificationHash of Notification ObjectHash describes the notification information.
Notification Object
AttributeTypeDescription
emailsArrayEmail address(es) to receive email notifications.
smsesArrayPhone number(s) to receive sms notifications.

Body

{
    "meta": {
        "code": 200
    },
    "data": {
        "notification": {
            "emails": ["user1@gmail.com","user2@gmail.com"],
            "smses": ["+85291239123", "+85261236123"]
        }
    }
}