Skip to main content

/api/v1/subscribers/dashboard/email/

  • Updated

The /subscribers/dashboard/email/ endpoint is used to manage email subscribers. The following parameters are supported on this endpoint:

INPUT PARAMETERS
dashboard
string

The resource_uri of the dashboard that contains the service to which the email address is being subscribed.

email
string

The resource_uri of the email address being subscribed to the service.

service
string

The resource_uri of the service to which the email address is being subscribed.

confirmed
boolean
(optional)

Whether or not the subscription is confirmed. Defaults to false.

locked
boolean
(optional)

Whether or not the subscription (email address) is locked. Defaults to false.

When an email address is locked on a dashboard, only administrators can add/remove subscriptions for that email address.

Important points:

  • If locked is set to false, or not included (in which case it is set to false by default) and existing subscriptions exist on the dashboard with the email address with locked set to true, then the subscription will be added as locked.
  • If locked is set to true, and existing subscriptions exist on the dashboard with the email address provided, then all existing subscriptions on the dashboard with the email address provided will be set to locked.

 

Examples

List Subscribers (List method, GET)

curl --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" https://www.statusdashboard.com/api/v1/subscribers/dashboard/email/

{
    "meta": {
        "limit": 10,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 3
    },
    "objects": [
        {
            "dashboard": "/api/v1/dashboard/11/",
            "confirmed": true,
            "locked": false,
            "email": {
                "email": "user1@company1.com",
                "resource_uri": "/api/v1/email/1001/"
            },
            "resource_uri": "/api/v1/subscribers/dashboard/email/2001/", 
            "service": "resource_uri": "/api/v1/service/150/"
        },
        {
            "dashboard": "/api/v1/dashboard/11/",
            "confirmed": true,
            "locked": false,
            "email": {
                "email": "user1@company1.com",
                "resource_uri": "/api/v1/email/1001/"
            },
            "resource_uri": "/api/v1/subscribers/dashboard/email/2002/", 
            "service": "resource_uri": "/api/v1/service/151/"
        },
        {
            "dashboard": "/api/v1/dashboard/11/",
            "confirmed": true,
            "locked": false,
            "email": {
                "email": "user2@company2.com",
                "resource_uri": "/api/v1/email/1002/"
            },
            "resource_uri": "/api/v1/subscribers/dashboard/email/2003/", 
            "service": "resource_uri": "/api/v1/service/152/"
        }
    ]
}

Upon success, you'll receive back an HTTP 200 (OK) indicating that the API call succeeded.

Add a Subscription (List method, POST)

curl --header "Content-Type: application/json" --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" -X POST --data '{"dashboard":"/api/v1/dashboard/11/","email":"/api/v1/email/1001/","service":"/api/v1/service/150/","confirmed":true}' https://www.statusdashboard.com/api/v1/subscribers/dashboard/email/

{
    "dashboard": "/api/v1/dashboard/11/",
    "confirmed": true,
    "locked": false, 
    "email": {
        "email": "user1@company1.com",
        "resource_uri": "/api/v1/email/1001/"
    },
    "resource_uri": "/api/v1/subscribers/dashboard/email/2001/", 
    "service": "resource_uri": "/api/v1/service/150/"
}

Upon success, you'll receive back an HTTP 201 (created) along with details about the resource you just created.

Delete a Subscription (Detail method, DELETE)

curl --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" -X DELETE https://www.statusdashboard.com/api/v1/subscribers/dashboard/email/2001/

Upon success, you'll receive back an HTTP 204 (No Content) indicating that the request was fulfilled but there is no data to display.

Related articles