Get Destination

Retrieve information about destinations related to an app's inbox or messaging CDP.

GET https://api.ants.tech/access/api/app-inbox/destination/:id

Query Parameters

NameTypeDescription

_network_id*

Number

For example, 33167

{
    "code": 200,
    "message": "Success",
    "data": {
        "entries": [
            {
                "destination_id": "1300598",
                "destination_name": "Create default destination smart inbox",
                "destination_name_multilang": "{\"EN\":\"Create default destination smart inbox\",\"DEFAULT_LANG\":\"EN\"}",
                "portal_id": "33167",
                "catalog_id": "1271788",
                "destination_setting": {
                    "method": "send",
                    "customerId": "#{customer.customer_id||\"\"}",
                    "frequencyCapping": {
                        "value": 2,
                        "version": "2.0",
                        "timeUnit": "daily",
                        "onJourneyId": false,
                        "onScheduleId": false,
                        "onDestination": true
                    },
                    "smartInboxConfigs": {
                        "APIToken": "f5e88aae-d005-4fbc-995c-98b8df1e3ea1",
                        "customColors": [
                            "#f7da64",
                            "#8912dd",
                            "#ed1515",
                            "#230439",
                            "#d11a66",
                            "#ffbd64",
                            "#f1ab96",
                            "#824ccd",
                            "#5858e9",
                            "#57b8c2"
                        ],
                        "webviewSettings": {
                            "toggle": {
                                "type": "popup",
                                "iconType": "systemIcon",
                                "position": "right",
                                "systemIcon": "fas bell",
                                "uploadIcon": "",
                                "iconStyling": {
                                    "color": "#ffffff",
                                    "fontSize": 20
                                },
                                "badgeStyling": {
                                    "color": "#ffffff",
                                    "width": 20,
                                    "fontSize": 12,
                                    "colorAlpha": 100,
                                    "fontFamily": "Roboto",
                                    "fontWeight": 700,
                                    "backgroundColor": "#ff0000"
                                },
                                "slideDirection": "slide-up",
                                "contentAnimation": {
                                    "animationType": "none",
                                    "animationDelay": 0,
                                    "animationDuration": 1000,
                                    "animationIterationCount": 1,
                                    "animationIterationStyle": "infinite"
                                },
                                "notificationSpacing": {
                                    "top": "auto",
                                    "left": "auto",
                                    "right": 25,
                                    "bottom": 25,
                                    "positionSuffix": "px",
                                    "linkedPositionInput": false
                                }
                            },
                            "notificationBox": {
                                "bubble": {
                                    "template": [
                                        {
                                            "id": "announcements",
                                            "label": "Announcements"
                                        },
                                        {
                                            "id": "coupon",
                                            "label": "Coupon"
                                        },
                                        {
                                            "id": "order_verfied",
                                            "label": "Order Verified"
                                        }
                                    ]
                                },
                                "header": {
                                    "color": "#000000",
                                    "content": "Notification",
                                    "fontSize": 16,
                                    "colorAlpha": 100,
                                    "fontFamily": "Roboto",
                                    "fontWeight": 400,
                                    "backgroundColor": "#ffffff",
                                    "backgroundColorAlpha": 100
                                },
                                "category": {
                                    "type": "round",
                                    "normal": {
                                        "color": "#005eb8",
                                        "fontSize": 10,
                                        "colorAlpha": 100,
                                        "fontFamily": "Roboto",
                                        "fontWeight": 700,
                                        "borderColor": "#005eb8",
                                        "borderRadius": 20,
                                        "backgroundColor": "#ffffff",
                                        "borderColorAlpha": 100,
                                        "backgroundColorAlpha": 100
                                    },
                                    "clicked": {
                                        "color": "#ffffff",
                                        "fontSize": 10,
                                        "colorAlpha": 100,
                                        "fontFamily": "Roboto",
                                        "fontWeight": 700,
                                        "borderColor": "#ffffff",
                                        "borderRadius": 20,
                                        "backgroundColor": "#005eb8",
                                        "borderColorAlpha": 100,
                                        "backgroundColorAlpha": 100
                                    },
                                    "content": "All",
                                    "isShowGeneralTab": true
                                },
                                "container": {
                                    "width": 260,
                                    "height": 500,
                                    "borderRadius": 3,
                                    "backgroundColor": "#ffffff",
                                    "backgroundColorAlpha": 100
                                },
                                "unreadIndicator": {
                                    "borderColor": "#ffffff",
                                    "backgroundColor": "#68e63e",
                                    "borderColorAlpha": 0,
                                    "backgroundColorAlpha": 100
                                },
                                "messageIndicator": {
                                    "color": "#ffffff",
                                    "content": "&num_new_message&",
                                    "fontSize": 12,
                                    "colorAlpha": 100,
                                    "fontFamily": "Roboto",
                                    "fontWeight": 700,
                                    "borderColor": "#ffffff",
                                    "borderRadius": 20,
                                    "backgroundColor": "#005eb8",
                                    "borderColorAlpha": 100,
                                    "backgroundColorAlpha": 100
                                }
                            }
                        }
                    }
                },
                "status": "1",
                "description": "Create default destinatioin smart inbox description",
                "description_multilang": "{\"EN\":\"Create default destinatioin smart inbox description\",\"DEFAULT_LANG\":\"EN\"}",
                "properties": null,
                "c_user_id": "1600080515",
                "u_user_id": "1600080515",
                "ctime": "2023-08-30T07:34:35.133Z",
                "utime": "2023-08-30T07:34:35.133Z",
                "schedule_destination_setting": null,
                "last_sync_offset": "0",
                "last_sync_time": null,
                "next_sync_time": null
            }
        ]
    }
}

Last updated