Keywords

The keywords resource allows you to Retrieve and Delete keywords. The following actions can be performed on this resource...

Retrieve All Keywords
Retrieve a Specific Keyword
Delete a Keyword

Retrieve All Keywords

Retrieves all keywords associated with a specific brand.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/keywords

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will return only active keywords.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/keywords?active=1

Example Response:


            
                
            
{
    "data": [
        {
            "keyword_id": 2222,
            "_brand_id": 123456789,
            "word": "Join",
            "description": "Allows contacts to join my brand",
            "create_contacts": 1,
            "use_alternate_responses": 0,
            "double_opt_in": 0,
            "auto_response_message": "Thanks for subscribing to SlickText text alerts.",
            "auto_response_message_media_url": null,
            "opt_in_exists_message": "You're already subscribed to SlickText text alerts.",
            "re_opt_in_message": "You've resubscribed to SlickText text alerts.",
            "double_opt_in_message": "To complete your subscription to SlickText text alerts, reply YES.",
            "active": 1,
            "created": "2024-01-01 18:53:04",
            "last_updated": "2024-01-02 20:18:49",
            "deleted": null
        }
    ],
    "pagingData": {
        "prevPage": null,
        "currentPage": null,
        "nextPage": null,
        "currentPageString": null,
        "hasMore": false
    }
}

Retrieve a Specific Keyword

Retrieves all keywords associated with a specific brand where keyword ID is equal to {id}. The keyword ID can be found using the retrieve all keywords endpoint.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/keywords/{{id}}

Example Response:


            
                
            
{
    "keyword_id": 2222,
    "_brand_id": 123456789,
    "deleted": null,
    "word": "Join",
    "description": null,
    "create_contacts": 1,
    "use_alternate_responses": 1,
    "double_opt_in": 0,
    "auto_response_message": "Thanks for subscribing to SlickText-BK text alerts.",
    "auto_response_message_media_url": null,
    "opt_in_exists_message": "You're already subscribed to SlickText-BK text alerts.",
    "re_opt_in_message": "Welcome Back!  You've resubscribed to SlickText-BK text alerts.",
    "double_opt_in_message": "To complete your subscription to SlickText text alerts, reply YES.",
    "active": 1,
    "created": "2024-10-30 13:13:03",
    "last_updated": "2024-10-30 13:13:08",
    "contact_list_ids": [
        10
    ]
}

Delete a Keyword

Deletes an existing keyword with the keyword ID equal to {id}. The keyword ID can be found using the retrieve all keywords endpoint. Using this action, the keyword is simply removed completely from the brand.

DELETE https://dev.slicktext.com/v1/brands/{{brand_id}}/keywords/{{id}}

Example Response:

[]