Skip to main content
POST
/
api
/
v2
/
shortcodes
/
{ID}
/
test_keyword
cURL
curl "https://app.tatango.com/api/v2/shortcodes/ID/test_keyword" -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u [email protected]:my_api_key \
  -d '{"keyword_name": "TESTKEYWORD"}'
{
  "status": "OK",
  "keyword_name": "available"
}

​
Request URL

POST https://app.tatango.com/api/v2/shortcodes/{ID}/test_keyword

​
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 and 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"}
What happens if the keyword isn’t available?
  • Yes. By utilizing this endpoint. The response will either be:
    • 200 OK with the response body looking like this: {"status":"OK","keyword_name":"available"}
    • 200 OK with the response body looking like this: {"status":"OK","keyword_name":"unavailable","error":"Name is in use"}.

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.

Path Parameters

​
ID
string
required

ID of the shortcode

Body

application/json
​
keyword_name
string
required

Keyword name to test

Response

Keyword availability check result

​
status
string
required
Example:

"OK"

​
keyword_name
enum<string>
required
Available options:
available,
unavailable
Example:

"available"

​
error
string
Example:

"Name is in use"