Get List Custom Opt-Out

This API allows you to retrieve the list of Custom Opt-Outs.

To create a new Custom Opt-Out, visit the Custom Opt-Out page in your Cellcast account.

Parameters for getting List Custom Opt-Out

Headers Parameters

Parameters	Description
Authorization	Please add provided Bearer token - linked to your Cellcast account. Check here
Content-Type	application/json

Code Samples

GET https://api.cellcast.com/api/v1/optoutList/listWithAdminOptout

cURL

curl --location 'https://api.cellcast.com/api/v1/api/v1/optoutList/listWithAdminOptout' \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer {{API_KEY}}' \

Replace with the actual API key that you own.

Responses

200 Success

{
    "app_type": "web",
    "app_version": "1.0",
    "maintainence": 0,
    "new_version": 0,
    "force_update": 0,
    "invalid_token": 0,
    "refresh_token": "",
    "show_message": 0,
    "is_enc": false,
    "status": true,
    "message": "Success",
    "message_type": "toast",
    "data": {
        "items": [
            {
                "options": [],
                "isAdmin": true,
                "isDefault": false,
                "_id": "6682440ea000000000000000",
                "title": "Stop Link",
                "description": "We're sorry to see you go! Are you still interested in any of these contents?",
                "addedBy": "637fa4ebb000000000000000",
                "createdBy": "637fa4ebb000000000000000",
                "createdAt": "2024-07-01T05:52:14.342Z",
                "updatedAt": "2024-07-01T05:52:14.342Z",
                "__v": 0
            },
            {
                "options": [],
                "isAdmin": true,
                "isDefault": false,
                "_id": "6671476bb000000000000000",
                "title": "One Click OptOut",
                "description": "To stop receiving messages of this type from us in the future please click the button below.",
                "addedBy": "65e6e8c7b000000000000000",
                "createdBy": "65e6e8c7b000000000000000",
                "createdAt": "2024-06-18T08:38:03.407Z",
                "updatedAt": "2024-06-19T04:52:20.628Z",
                "__v": 0
            },
            {
                "options": [
                    {
                        "option1": "Offer me something better!"
                    },
                    {
                        "option2": "No longer interested in it!"
                    },
                    {
                        "option3": "Don`t want messages!"
                    }
                ],
                "isAdmin": true,
                "isDefault": false,
                "_id": "658580fa9000000000000000",
                "title": "Opt-out",
                "description": "To stop receiving messages of this type from us in the future please enter your number below and choose which option is most relevant to you.",
                "addedBy": "637fa4ebb000000000000000",
                "createdBy": "637fa4ebb000000000000000",
                "createdAt": "2023-12-22T12:28:42.742Z",
                "updatedAt": "2024-02-01T05:21:24.393Z",
                "__v": 0
            }
        ],
        "total": 3,
        "limit": 10,
        "totalPages": 1,
        "current": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": null,
        "nextPage": null
    },
    "error": {}
}

401 Unauthorized

{
  "code": 401,
  "message": "Token expired",
  "stack": "APIError: Token expired ...."
}