Skip to main content
POST
/
api
/
v2
/
lists
cURL
curl "https://app.tatango.com/api/v2/lists/" -d '{"list":{"name":"My awesome list","message_yes":"ACME Retail: Reply YES for recurring autodialed SMS/MMS marketing msgs. No purchase rqd. Msg&data rates may apply. Terms apply 12345-info.com","message_help":"ACME Retail: Recurring SMS/MMS msgs. Text STOP 2 end. Msg&data rates may apply. Terms apply 12345-info.com","message_stop":"ACME Retail: You have been unsubscribed and will not receive any more messages.","message_reply":"ACME Retail: Thank you for your response. Reply STOP to end, HELP for help. Msg&data rates may apply. Terms apply 12345-info.com","message_already_subscribed":"ACME Retail: You already agreed to recurring SMS/MMS msgs. Txt STOP 2 end, HELP 4 help. Msg&data rates may apply. Terms apply 12345-info.com","first_optin_message":"ACME Retail: You agreed to receive recurring SMS/MMS msgs. Txt STOP 2 end, HELP 4 help. Msg&data rates may apply. Terms apply 12345-info.com","second_optin_message":"ACME Retail: Welcome back! You agreed to receive recurring SMS/MMS msgs. Txt STOP 2 end, HELP 4 help. Msg&data rates may apply. Terms apply 12345-info.com","email_digest":"[email protected]","email_subscribe":true,"email_unsubscribe":true}}' -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u [email protected]:my_api_key \
  -H "Host: example.org" \
  -H "Cookie: "
{
  "status": "List created",
  "list": {
    "id": 11,
    "name": "My awesome list",
    "email_digest": "[email protected]",
    "email_subscribe": true,
    "email_unsubscribe": true,
    "first_optin_message": "ACME Retail: You already agreed to recurring SMS/MMS msgs. Txt STOP 2 end, HELP 4 help. Msg & data rates may apply. Terms apply 12345-info.com",
    "second_optin_message": "ACME Retail: Welcome back! You agreed to receive recurring SMS/MMS msgs. Txt STOP 2 end, HELP 4 help. Msg&data rates may apply. Terms apply 12345-info.com",
    "message_help": "ACME Retail: Recurring SMS/MMS msgs. Text STOP 2 end. Msg&data rates may apply. Terms apply 12345-info.com. Msging help: [email protected]",
    "message_stop": "ACME Retail: You have been unsubscribed and will not receive any more messages.",
    "message_reply": "ACME Retail: Thank you for your response. Reply STOP to end, HELP for help. Msg&data rates may apply. Terms apply 12345-info.com",
    "message_already_subscribed": "ACME Retail: Reply YES for recurring autodialed SMS/MMS marketing msgs. No purchase rqd. Msg&data rates may apply. Terms apply 12345-info.com",
    "message_yes": "ACME Retail: Recurring SMS/MMS msgs. Text STOP 2 end. Msg&data rates may apply. Terms apply 12345-info.com. Msging help: [email protected]",
    "keyword_names": [
      "JOIN",
      "SAVE",
      "COUPONS",
      "SALE"
    ],
    "counts": {
      "subscribers": 0,
      "unsubscribed": 0,
      "cleaned": 0
    },
    "opt_in_type": "single",
    "opt_in_requests": []
  }
}
Note: the following settings cannot be modified via the API:
  • API Confirmation Resend Block Timeout
  • Resubscribers

​
FAQs

What are the limitations for a keyword?
  • A keyword must contain at least two characters and no more than 15 characters.
  • Keywords are not case sensitive. FOO will match foo, FOO, and Foo.
  • You can’t use obscene words. We’re not going to spell them out here.
Are keywords case sensitive?
  • No. The system checks for duplicate keywords by transforming all keywords to uppercase before performing matching algorithms.
What happens if the keyword isn’t available?
  • The response from the API will be a 422 error with the response body looking like this:
{"status":"error","error":"invalid keyword names: EXISTINGKW"}
Can I check if a keyword is available?
  • Yes. By utilizing this endpoint. The response will either be:
{"status":"OK","keyword_name":"available"}
or
{"status":"OK","keyword_name":"unavailable","error":"Name is in use"}
Can I add multiple keywords to a list?
  • Yes. The keyword_names parameter would need to be an array, like this:
{"keyword_names":["TEST","KEYWORD","NAMES"]}
What is a REPLY Response?
  • REPLY Response is the response sent to the subscriber if they respond to the message with the word REPLY.

​
Request URL

POST https://app.tatango.com/api/v2/lists/

Authorizations

​
Authorization
string
header
required

Tatango authenticates API requests by validating an API key passed via HTTP Basic Authentication. Use your login email as the username and your API key as the password.

Body

application/json
​
list
object
required

Response

200 - application/json

List created

​
status
string
required
Example:

"List created"

​
list
object
required