SMS API

To begin using Kixie’s SMS API, please send a request to support@kixie.com or contact your account manager.

Your kixie support rep or AM will provide all necessary variables to make a request.

Data you will need

  • businessid
  • api key
  • the kixie email address of the sender
  • a phone number to send the message to
  • A message

Optional

  • Any property within the data object (shown below) can be used as a replacement variable in the message
    • in the example below [lname] would be replaced with Jones
    • replacements are structured as [varname]

Usage Instructions

send a POST request to the following url:

https://apig.kixie.com/app/sms/send?apikey=KIXIE_BUS_API_TOKEN&businessid=BUSINESS_ID

with the body as

    {
    "sender":{
        "email":"EMAIL_of_KIXIE_AGENT"
        },
      "data": {
        "fname": "James",
        "lname": "Jones",
        "name": "James Jones"
        },
        "destination":{
          "phone":"TARGET_PHONE_NUMBER",
          "cc":"US"
          },
          "message":"Hi [lname], Want to improve your SMS-game?
          Here's Kixie's best practice guide for SMS: 
          https://kixie.zendesk.com/hc/en-us/articles/360040209593-SMS-Best-Practices"
          }

Note: Parameters are required to complete the request. Contact support@kixie.com for your businessid and api key if you do not have them.

Advanced

Kixie SMS Variables

You may use variables inside a message if you like. A variable is represented as [varName]

Kixie Default Variables:

  • Customer First Name: [fname]
  • Customer Last Name: [lname]
  • Agent First Name: [ffname]
  • Agent Last Name: [llname]

Example:

Here’s what the message looks like with the variables:

Hi, [fname] [lname].This is [ffname] [ffname] from BestCity.Thanks for visiting our Los Angeles location.

Here is the message after we replace the variables:

Hi, Bruce Wayne. This is Jason Rep from BestCity. Thanks for visiting our Santa Monica location.

Hubspot Custom Fields

Note: These currently only work for Hubspot customers.

You can use the data from any Hubspot field. For example, if you had a custom field on the customer called CITY and wanted to use it in your SMS template.

Then you would construct the message as:

Hi, [fname] [lname].This is [ffname] [llname] from BestCity.Thanks for visiting our [City] location.

We automatically convert the variables before sending. Here’s the message we would send if the CITY was ‘Los Angeles’:

Hi, Bruce Wayne.This is Alex Mann from BestCity.Thanks for visiting our Los Angeles location.