Brands

Limited brand information is available through the API. Currently, we do not support any POST requests on this resource.

Retrieve Brand Information
Retrieve Users from Brand
Retrieve Credit Usage from Brand

Retrieve Brand Information

Returns several pieces of data regarding your Brand. The information returned will provide you with insights on your Brand as a whole. This information was used to register your sending number.

GET https://dev.slicktext.com/v1/brands

Example Response:


            
                
            
{
    "brand_id": 1234567890,
    "_account_id": 987654321,
    "tax_id": 98765421,
    "legal_name": “SlickText”,
    "name": "SlickText",
    "short_name": "SlickText",
    "logo": null,
    "website": "http://www.slicktext.com",
    "address": "301 E 2nd St #304",
    "city": "Jamestown",
    "state": "NY",
    "zip": "14701",
    "country": "US",
    "contact_first_name": "Johnny",
    "contact_last_name": "SlickText",
    "contact_email": "johnny@slicktext.com",
    "contact_phone": "+17165551212",
    "industry": "professionalServicesMarketing",
    "use_case": "nonMarketing",
    "prohibited_content": 0,
    "message_credit_limit": null,
    "message_credit_limit_percentage": 100,
    "age_requirement": 0,
    "age_requirement_message": "To subscribe, please respond with your date of birth in the format mm/dd/yyyy.",
    "age_requirement_ineligible_message": "Sorry, you must be at least years of age to subscribe.",
    "force_double_opt_in": 0,
    "double_opt_in_message": "To complete your subscription to SlickText text alerts, reply YES.",
    "opt_in_message": "Thanks for subscribing to SlickText text alerts.",
    "opt_in_exists_message": "You're already subscribed to SlickText text alerts.",
    "re_opt_in_message": "You've resubscribed to SlickText text alerts.",
    "terms_link": "http://l.sltxt.io/6/1679091c5a",
    "inbox_enabled": 1,
    "opt_out_intel_enabled": 1,
    "opt_out_intel_action": null,
    "opt_out_intel_message": null,
    "time_to_cart_abandonment_value": 4,
    "time_to_cart_abandonment_unit": "hour",
    "attribution_model": "last_touch",
    "message_view_attribution_value": 24,
    "message_view_attribution_unit": "hour",
    "message_click_attribution_value": 14,
    "message_click_attribution_unit": "day",
    "delete_bad_numbers": 1,
    "delete_bad_numbers_failures": 3,
    "created": "2023-08-11 18:52:25",
    "last_updated": "2024-08-21 20:19:15"
}

Retrieve Users of a Specific Brand

By default, the first set of 50 users will be returned, but you can modify this number with limit and offset values in the query string. The max limit for a single request is 10,000.

When retrieving multiple users, you may also want to include additional criteria in the query string to filter the results by. Any field that is included in the resources is available for use as a filter. These are exact matches; they are case-sensitive and do not allow wildcards.

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

Example Response:


            
                
            
{
   "data": [
       {
           "user_id": 113,
           "first_name": "Johnny",
           "last_name": "SlickText",
           "email": "johnny@slicktext.com",
           "mobile_number": "+16155551234",
           "city": “Nashville”,
           "state": “TN”,
           "zip": “37203”,
           "country": “United States”,
           "profile_image": “https://someurl.com/image”
           "timezone": "America/New_York",
           "2fa_enabled": 0,
           "created": "2024-01-17 20:24:05"
       }
   ],
   "pagingData": {
       "prevPage": null,
       "currentPage": null,
       "nextPage": null,
       "currentPageString": null,
       "hasMore": false
   }
}

Retrieve Credit Usage for a Specific Brand

Retrieves the credit for the brand for the current billing period. This includes subscription credits, rollovers, and purchased messages.

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

Example Response:


            
                
            
{
    "brand_id": 123456789,
    "brand_name": "SlickText",
    "total_credits": 10000,
    "credits_used": 750,
    "credits_available": 9250,
    "message_credit_limit": null,
    "message_credit_limit_percentage": 100
}