Team SMS API

The Business/Team SMS API allows you to send Team SMS messages through a POST request. This enables you to send the first message to a customer using Team SMS, directly from your own systems or automations. You can access your API Key and Business ID in the Kixie Dashboard under Manage > Account Settings > Edit All > Integrations. You must be on the Professional Billing Tier or higher to access this API. Contact your Account Manager or Kixie Support via live chat to have the API enabled for your account.

Endpoint

Send a POST request to the following URL. Set Content-Type: application/json in your request headers.

JSON

POST https://apig.kixie.com/app/event?apikey=<api-key-here>

Request Body

JSON

curl --location --request POST 'https://apig.kixie.com/app/event?apikey=xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
  "businessid": "xxxxx",
  "target": "xxxxxxxxxx",
  "eventname": "bizsms",
  "id": 12345,
  "fromNumber": "14242299682",
  "message": "Hello world",
  "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}'

Parameters

businessid (required) — Your Kixie Business ID, found in Account Settings.

target (required) — The phone number you want to send the Team SMS message to.

eventname (required) — Must be set to "bizsms" for Team SMS.

id (required) — The Team SMS ID found in the Kixie Dashboard under Manage > Numbers > Team SMS.

fromNumber (optional) — If multiple phone numbers are associated with the Team SMS ID, specify which one to send from. If omitted, Kixie uses the first number attached to the Team SMS ID.

message (required) — The content of the Team SMS message you want to send.

apikey (required) — Your Kixie API key.