Model

Unsubscribed unsubscribed {
    "_id": {
        "autogenerated": "true"
    },
    "email": {
        "type": "string",
        "unique": "true",
        "required": "true"
    }
}

Methods

Create new

POST /unsubscribed-list req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}/unsubscribed-list,
    headers: {},
    json: true,
    body: {}
}

Responses Success - status 201

{}

Error - status 400

{
    error_message
}

Retrieve multiple

GET /unsubscribed-list

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/unsubscribed-list',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

[
   unsubscribed_list
]

Error - status 500

{
    error_message
}

• Example usages: `/unsubscribed-list - Get list of all unsubscribers

Retrieve single

GET /unsubscribed_list/:id

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/unsubscribed-list/{{unsubscribed._id}},
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{
   unsubscribed
}

Not found - status 404

{}

Error - status 500

{
    error_message
}

• Example usages: /unsubscribed-list/:id - Retrives a specific unsubscriber

Update single

PATCH /unsubscribed-list/:id?

method: 'PATCH'
{
    url: 'https://{{your-builderly-domain}}/unsubscribed-list/{{unsubscribed._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{ unsubscribed }

Error - status 400

{
    error_message
}

Not found - status 404

{}

Delete single

DELETE /unsubscribed-list/:id

method: 'DELETE'
{
    url: 'https://{{your-builderly-domain}}/unsubscribed-list/{{unsubscribed._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{ unsubscribed }

Not found - status 404

{}

Error - status 500

{
    error_message
}