{"info":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","description":"

Getting Started with the TLKR API

\n

Welcome to the TLKR API! This section will guide you through the initial steps to use our API, ensuring you have everything you need to start sending and managing SMS messages through your applications.

\n

Generating Your API Key

\n

To authenticate with the TLKR API, you'll need an API key. Follow these steps to generate one:

\n
    \n
  1. Log in to your TLKR user portal.
    2. \n
  2. Go to the API keys section.
    3. \n
  3. Click on the button to generate a new API key.
    4. \n
\n

Once generated, your API key will be your gateway to integrating with the TLKR API.

\n

Using Your API Key

\n

To make API calls, append your API key to the request URL as a parameter. Here's how you can do it:

\n

https://api.tlkr.io/account/balance?apikey=your_api_key_here

\n

Authentication and Access

\n

Keep your API key secure to prevent unauthorized access. If you make an API call without a valid API key, or if the key is incorrect, the API will return a 401 Unauthorized status code. This indicates that the request has not been completed due to invalid authentication credentials.

\n

Rate Limiting

\n

The API implements rate limiting to ensure fair usage:

\n\n

Summary

\n

With your API key set up and understood how to use it within your API calls, you are now ready to explore the full potential of the TLKR API. This will allow you to seamlessly integrate SMS messaging capabilities into your applications and services.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"47846688","collectionId":"50371a9a-1392-4068-9fbe-d249d59c9bb3","publishedId":"2sB3dWqmSA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-20T04:01:38.000Z"},"item":[{"name":"Account","item":[{"name":"Get Account Balance","id":"38591785-8b17-4935-823c-6684e2302134","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/account/balance","description":"

This endpoint makes an HTTP GET request to retrieve the account balance from the specified URL. The response will be in JSON format and will include a \"success\" indicator, the \"balance\" data, and an optional \"message\" field.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["account","balance"],"host":["api","tlkr","io"],"query":[],"variable":[]}},"response":[{"id":"0f9c02ce-850f-4ffd-8e20-4b3fca190520","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/account/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"balance\": 0\n },\n \"message\": \"Account balance retrieved\"\n}"}],"_postman_id":"38591785-8b17-4935-823c-6684e2302134"},{"name":"Get Account Usage","id":"23a5d132-2764-47f7-9161-26b2c66785e1","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/account/usage?start_date=2025-01-01&end_date=2025-01-31","description":"

Get comprehensive account usage statistics including message counts, campaign stats, and daily breakdown.

\n

Query Parameters

\n\n

Response

\n

Returns usage statistics including:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["account","usage"],"host":["api","tlkr","io"],"query":[{"description":{"content":"

(Optional) Start date for the usage period (YYYY-MM-DD). Defaults to 30 days ago.

\n","type":"text/plain"},"key":"start_date","value":"2025-01-01"},{"description":{"content":"

(Optional) End date for the usage period (YYYY-MM-DD). Defaults to today.

\n","type":"text/plain"},"key":"end_date","value":"2025-01-31"},{"disabled":true,"description":{"content":"

(Optional) Team UUID to get usage for. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"f1a66f76-dd96-4002-9cb0-b0780238b1a8","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.tlkr.io/account/usage?start_date=2025-01-01&end_date=2025-01-31","protocol":"https","host":["api","tlkr","io"],"path":["account","usage"],"query":[{"key":"start_date","value":"2025-01-01"},{"key":"end_date","value":"2025-01-31"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"period\": {\n \"start\": \"2025-01-01\",\n \"end\": \"2025-01-31\"\n },\n \"messages\": {\n \"sent\": 15000,\n \"delivered\": 14200,\n \"failed\": 300,\n \"filtered\": 500,\n \"received\": 2500,\n \"mms\": 1200\n },\n \"campaigns\": {\n \"total\": 12,\n \"completed\": 10,\n \"pending\": 2\n },\n \"segments\": {\n \"total\": 8\n },\n \"daily\": [\n {\n \"date\": \"2025-01-01\",\n \"sent\": 500,\n \"delivered\": 480,\n \"filtered\": 15,\n \"received\": 80,\n \"mms\": 40\n }\n ]\n },\n \"message\": \"Account usage retrieved successfully\"\n}"}],"_postman_id":"23a5d132-2764-47f7-9161-26b2c66785e1"}],"id":"980f1d47-83f3-44f0-b8fb-3d2328ad7b8d","_postman_id":"980f1d47-83f3-44f0-b8fb-3d2328ad7b8d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Teams","item":[{"name":"Create Team","id":"658ed166-6300-41dc-b61d-70ff718b2a83","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"My New Team","description":"

(Required) Name of the team to create

\n","type":"text"}]},"url":"https://api.tlkr.io/teams/create","description":"

Create a new team under your account. The new team will inherit Twilio credentials from your personal team.

\n

Note: This is a heavy operation with rate limiting of 10 requests per minute.

\n

Request Body

\n\n

Response

\n

Returns the created team details including:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["teams","create"],"host":["api","tlkr","io"],"query":[],"variable":[]}},"response":[{"id":"991f5d32-cab5-43e1-8003-e7e1833fa234","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"My New Team","type":"text"}]},"url":"https://api.tlkr.io/teams/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"team\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"My New Team\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\"\n },\n \"team_api_token\": \"1|abc123def456ghi789jkl012mno345pqr678stu901vwx234yz\"\n },\n \"message\": \"Team created successfully\"\n}"}],"_postman_id":"658ed166-6300-41dc-b61d-70ff718b2a83"},{"name":"List Teams","id":"42adff86-e62a-43aa-b876-7e1730c69794","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/teams","description":"

List all teams owned by the authenticated user.

\n

Response

\n

Returns an array of teams with:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["teams"],"host":["api","tlkr","io"],"query":[],"variable":[]}},"response":[{"id":"4a578da7-ac20-4b85-acf5-c975a5631002","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/teams"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"teams\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Personal Team\",\n \"created_at\": \"2024-01-01T00:00:00+00:00\"\n },\n {\n \"id\": \"660f9511-f30c-52e5-b827-557766551111\",\n \"name\": \"My New Team\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\"\n }\n ]\n },\n \"message\": \"Teams retrieved successfully\"\n}"}],"_postman_id":"42adff86-e62a-43aa-b876-7e1730c69794"},{"name":"Get Team","id":"c8161d47-6d4c-44e1-bf29-5f6e58a92401","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/teams/:id","description":"

Get details of a specific team by ID (UUID).

\n

Path Parameters

\n\n

Response

\n

Returns team details including:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["teams",":id"],"host":["api","tlkr","io"],"query":[],"variable":[{"id":"2a9ade0a-3803-4110-b98f-dd3a1e34b1aa","description":{"content":"

(Required) Team ID (UUID)

\n","type":"text/plain"},"type":"any","value":"550e8400-e29b-41d4-a716-446655440000","key":"id"}]}},"response":[{"id":"8facdf88-47e6-4642-9a8b-401a08cb4f0c","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/teams/550e8400-e29b-41d4-a716-446655440000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"My New Team\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-15T10:30:00+00:00\"\n },\n \"message\": \"Team retrieved successfully\"\n}"}],"_postman_id":"c8161d47-6d4c-44e1-bf29-5f6e58a92401"},{"name":"Delete Team","id":"104c25eb-edff-4d9a-a000-9826e89eb854","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/teams/:id","description":"

Delete a team by ID (UUID).

\n

Restrictions

\n\n

Path Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["teams",":id"],"host":["api","tlkr","io"],"query":[],"variable":[{"id":"dba91e11-72f6-4fff-865e-ac6488192d82","description":{"content":"

(Required) Team ID (UUID)

\n","type":"text/plain"},"type":"any","value":"550e8400-e29b-41d4-a716-446655440000","key":"id"}]}},"response":[{"id":"69f22897-88fa-4547-aa55-58bd4f1eacba","name":"Successful Response","originalRequest":{"method":"DELETE","header":[],"url":"https://api.tlkr.io/teams/550e8400-e29b-41d4-a716-446655440000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [],\n \"message\": \"Team deleted successfully\"\n}"}],"_postman_id":"104c25eb-edff-4d9a-a000-9826e89eb854"}],"id":"3cb467ec-4ba4-4dc4-8982-cdef2f151a17","_postman_id":"3cb467ec-4ba4-4dc4-8982-cdef2f151a17","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Numbers","item":[{"name":"List Available Numbers","id":"8e0a48ff-be5e-4ccf-9104-8060981ce25f","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/numbers/available","description":"

List available toll-free numbers that can be purchased.

\n

Query Parameters

\n\n

Response

\n

Returns an array of available toll-free numbers with SMS and MMS capabilities.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["numbers","available"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Filter numbers containing this pattern

\n","type":"text/plain"},"key":"contains","value":"800"},{"disabled":true,"description":{"content":"

(Optional) Number of results (1-20, default: 10)

\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"8a9b28c8-3b13-4b48-a2c0-bd73739d5e0a","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/numbers/available"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"numbers\": [\n {\n \"phone_number\": \"+18005551234\",\n \"friendly_name\": \"(800) 555-1234\",\n \"sms\": true,\n \"mms\": true\n },\n {\n \"phone_number\": \"+18885559876\",\n \"friendly_name\": \"(888) 555-9876\",\n \"sms\": true,\n \"mms\": true\n }\n ]\n },\n \"message\": \"Available numbers retrieved successfully\"\n}"}],"_postman_id":"8e0a48ff-be5e-4ccf-9104-8060981ce25f"}],"id":"005322a5-7cf7-4201-a976-839218d75bd5","_postman_id":"005322a5-7cf7-4201-a976-839218d75bd5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Brands","item":[{"name":"Create Brand","id":"cd28834d-19c7-4fec-93f8-14745617e4ce","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"My Brand","description":"

(Required) Name of the brand

\n","type":"text"},{"key":"phone_number","value":"+18005551234","description":"

(Required) Phone number from GET /numbers/available (E.164 format)

\n","type":"text"},{"key":"ein","value":"12-3456789","description":"

(Required) Employer Identification Number (XX-XXXXXXX format)

\n","type":"text"},{"key":"business_name","value":"My Business LLC","description":"

(Optional) Legal business name

\n","type":"text","disabled":true},{"key":"business_address","value":"123 Main St","description":"

(Optional) Business street address

\n","type":"text","disabled":true},{"key":"business_city","value":"New York","description":"

(Optional) Business city

\n","type":"text","disabled":true},{"key":"business_state","value":"NY","description":"

(Optional) Business state (2-letter code)

\n","type":"text","disabled":true},{"key":"business_postal_code","value":"10001","description":"

(Optional) Business postal code

\n","type":"text","disabled":true},{"key":"business_email","value":"contact@mybusiness.com","description":"

(Optional) Business contact email

\n","type":"text","disabled":true},{"key":"business_phone","value":"+15559876543","description":"

(Optional) Business phone number

\n","type":"text","disabled":true},{"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000","description":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text","disabled":true}]},"url":"https://api.tlkr.io/brands/create","description":"

Create a new brand by purchasing a toll-free number.

\n

Note: This is a heavy operation with rate limiting of 10 requests per minute.

\n

Workflow

\n
    \n
  1. Call GET /numbers/available to list available toll-free numbers
    2. \n
  2. Call this endpoint with the selected phone_number
    3. \n
  3. Call POST /brands/{id}/verify to submit toll-free verification
    4. \n
\n

Request Body

\n\n

Response

\n

Returns the created brand with status draft. Submit verification to activate.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["brands","create"],"host":["api","tlkr","io"],"query":[],"variable":[]}},"response":[{"id":"e783177f-f824-45e1-a440-fc732106ccd2","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"My Brand","type":"text"},{"key":"phone_number","value":"+18005551234","type":"text"},{"key":"ein","value":"12-3456789","type":"text"}]},"url":"https://api.tlkr.io/brands/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"brand\": {\n \"id\": 1,\n \"name\": \"My Brand\",\n \"number\": \"+18005551234\",\n \"status\": \"draft\",\n \"provider\": \"twilio\",\n \"ein\": \"12-3456789\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-15T10:30:00+00:00\"\n }\n },\n \"message\": \"Brand created successfully. Number purchased. Submit verification to activate.\"\n}"}],"_postman_id":"cd28834d-19c7-4fec-93f8-14745617e4ce"},{"name":"List Brands","id":"7b84dd67-0342-4656-bebe-3c2bb57f429a","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/brands","description":"

List all brands/numbers for the authenticated team.

\n

Query Parameters

\n\n

Response

\n

Returns an array of brands with registration status and details.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["brands"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"3589b471-8d01-424b-bd9b-1bfa3e3d3d0d","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/brands"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"brands\": [\n {\n \"id\": 1,\n \"name\": \"My Brand\",\n \"number\": \"+15551234567\",\n \"status\": \"approved\",\n \"provider\": \"twilio\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-16T14:20:00+00:00\"\n }\n ]\n },\n \"message\": \"Brands retrieved successfully\"\n}"}],"_postman_id":"7b84dd67-0342-4656-bebe-3c2bb57f429a"},{"name":"Get Brand","id":"656e627d-a4b3-43b5-86d1-55e995de759e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/brands/:id","description":"

Get details of a specific brand by ID.

\n

Path Parameters

\n\n

Query Parameters

\n\n

Response

\n

Returns full brand details including registration status.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["brands",":id"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[{"id":"3a7d21e9-8870-40c2-bb5b-715bfad0ae01","description":{"content":"

(Required) ID of the brand

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"ef339116-fa90-487c-a412-14145b3a4b0f","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/brands/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"brand\": {\n \"id\": 1,\n \"name\": \"My Brand\",\n \"number\": \"+15551234567\",\n \"status\": \"approved\",\n \"provider\": \"twilio\",\n \"use_case\": [\"MARKETING\"],\n \"business_name\": \"My Business LLC\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-16T14:20:00+00:00\"\n }\n },\n \"message\": \"Brand retrieved successfully\"\n}"}],"_postman_id":"656e627d-a4b3-43b5-86d1-55e995de759e"},{"name":"Verify Brand","id":"857433b4-c726-4ac2-9120-34161b829263","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"website","value":"https://example.com","description":"

(Required) Business website URL

\n","type":"text"},{"key":"use_case[]","value":"MARKETING","description":"

(Required) Use case category. Valid values: TWO_FACTOR_AUTHENTICATION, ACCOUNT_NOTIFICATIONS, CUSTOMER_CARE, CHARITY_NONPROFIT, DELIVERY_NOTIFICATIONS, FRAUD_ALERT_MESSAGING, EVENTS, HIGHER_EDUCATION, K12, MARKETING, POLLING_AND_VOTING_NON_POLITICAL, POLITICAL_ELECTION_CAMPAIGNS, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT

\n","type":"text"},{"key":"usage_summary","value":"Marketing messages and promotional offers to opted-in customers","description":"

(Required) Description of how messages will be used (min 10 chars)

\n","type":"text"},{"key":"sample_message","value":"Hi {name}, check out our latest deals at example.com! Reply STOP to unsubscribe.","description":"

(Required) Sample message content (min 10 chars)

\n","type":"text"},{"key":"optin_image_urls[]","value":"https://cdn.example.com/optin-screenshot.png","description":"

(Required) URL(s) of opt-in screenshots

\n","type":"text"},{"key":"optin_type","value":"WEB_FORM","description":"

(Required) How users opt in. Values: VERBAL, WEB_FORM, PAPER_FORM, VIA_TEXT, MOBILE_QR_CODE

\n","type":"text"},{"key":"volume","value":"10,000","description":"

(Required) Expected monthly message volume. Valid values: 1, 10, 1,000, 10,000, 100,000, 250,000, 500,000, 750,000, 1,000,000

\n","type":"text"},{"key":"additional_info","value":"","description":"

(Optional) Additional information for verification

\n","type":"text","disabled":true},{"key":"contact_first_name","value":"John","description":"

(Optional) Contact first name

\n","type":"text","disabled":true},{"key":"contact_last_name","value":"Doe","description":"

(Optional) Contact last name

\n","type":"text","disabled":true},{"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000","description":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text","disabled":true}]},"url":"https://api.tlkr.io/brands/:id/verify","description":"

Submit toll-free verification for a brand.

\n

Note: This is a heavy operation with rate limiting of 10 requests per minute.

\n

Prerequisites

\n\n

Request Body

\n\n

Response

\n

Returns the updated brand with status pending. Verification typically takes 1-3 business days.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["brands",":id","verify"],"host":["api","tlkr","io"],"query":[],"variable":[{"id":"8f762432-2492-419a-a2c5-3b54c924a6d5","description":{"content":"

(Required) Brand ID

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"9433bcd1-a73c-460c-a068-48833ba5c909","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"website","value":"https://example.com","type":"text"},{"key":"use_case[]","value":"MARKETING","type":"text"},{"key":"usage_summary","value":"Marketing messages and promotional offers","type":"text"},{"key":"sample_message","value":"Hi {name}, check out our latest deals!","type":"text"},{"key":"optin_image_urls[]","value":"https://cdn.example.com/optin.png","type":"text"},{"key":"optin_type","value":"WEB_FORM","type":"text"},{"key":"volume","value":"10,000","type":"text"}]},"url":"https://api.tlkr.io/brands/1/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"brand\": {\n \"id\": 1,\n \"name\": \"My Brand\",\n \"number\": \"+18005551234\",\n \"status\": \"pending\",\n \"provider\": \"twilio\",\n \"ein\": \"12-3456789\",\n \"use_case\": [\"MARKETING\"],\n \"usage_summary\": \"Marketing messages and promotional offers\",\n \"optin_type\": \"WEB_FORM\",\n \"volume\": \"10,000\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-15T11:00:00+00:00\"\n }\n },\n \"message\": \"Verification submitted successfully. Status is now pending.\"\n}"}],"_postman_id":"857433b4-c726-4ac2-9120-34161b829263"}],"id":"4a849bce-9f05-40a7-8f83-5c5fe23b560d","_postman_id":"4a849bce-9f05-40a7-8f83-5c5fe23b560d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Campaigns","item":[{"name":"Create Campaign","id":"02e20818-d6c0-4aa1-a796-c0f5d946860e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"January Sale Campaign","description":"

(Required) Name of the campaign

\n","type":"text"},{"key":"brand_id","value":"1","description":"

(Required) ID of the brand/number to send from

\n","type":"text"},{"key":"message","value":"Hi [name], check out our January sale! [link] Reply STOP to opt out.","description":"

(Required) Message content. Supports tokens: [name], [first_name], [last_name], [link]

\n","type":"text"},{"key":"url","value":"https://mysite.com/sale","description":"

(Optional) URL for [link] token replacement

\n","type":"text"},{"key":"media","value":"https://mysite.com/images/sale.jpg","description":"

(Optional) Media URL for MMS

\n","type":"text"},{"key":"tags","value":"buyer,vip","description":"

(Optional) Comma-separated tags to target

\n","type":"text"},{"key":"segments","value":"1,2","description":"

(Optional) Comma-separated segment IDs to include

\n","type":"text"},{"key":"suppress_tags","value":"unsubscribed","description":"

(Optional) Comma-separated tags to exclude

\n","type":"text"},{"key":"suppress_segments","value":"3","description":"

(Optional) Comma-separated segment IDs to exclude

\n","type":"text"},{"key":"suppress_campaigns","value":"5,6","description":"

(Optional) Comma-separated campaign IDs - exclude contacts who received these

\n","type":"text"},{"key":"send_at","value":"2025-01-20 10:00:00","description":"

(Optional) Schedule send time (YYYY-MM-DD HH:MM:SS). Omit to send immediately.

\n","type":"text"},{"key":"send_type","value":"normal","description":"

(Optional) Send type: normal, staggered

\n","type":"text"},{"key":"max_contacts","value":"10000","description":"

(Optional) Maximum contacts to send to

\n","type":"text"},{"key":"team_id","value":"1","description":"

(Optional) Team ID. Only for owner API keys.

\n","type":"text","disabled":true}]},"url":"https://api.tlkr.io/campaigns/create","description":"

Create and optionally schedule a new campaign.

\n

Note: This is a heavy operation with rate limiting of 10 requests per minute.

\n

Request Body

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns","create"],"host":["api","tlkr","io"],"query":[],"variable":[]}},"response":[{"id":"a3025963-2832-43ab-888b-92cc99d2f05c","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"January Sale Campaign","type":"text"},{"key":"brand_id","value":"1","type":"text"},{"key":"message","value":"Hi [name], check out our January sale! [link] Reply STOP to opt out.","type":"text"},{"key":"url","value":"https://mysite.com/sale","type":"text"}]},"url":"https://api.tlkr.io/campaigns/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"campaign\": {\n \"id\": 100,\n \"name\": \"January Sale Campaign\",\n \"status\": \"pending\",\n \"message\": \"Hi [name], check out our January sale! [link] Reply STOP to opt out.\",\n \"url\": \"https://mysite.com/sale\",\n \"send_at\": \"2025-01-20T10:00:00+00:00\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\"\n }\n },\n \"message\": \"Campaign created successfully\"\n}"}],"_postman_id":"02e20818-d6c0-4aa1-a796-c0f5d946860e"},{"name":"Lookup Campaigns","id":"cc049fe3-46fb-47c3-8d64-239007e42229","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"campaign_id","value":"100","description":"

(Optional) Id of campaign

\n","type":"text"},{"key":"name","value":"product","description":"

(Optional) Text to search for in campaign name

\n","type":"text"},{"key":"status","value":"complete","description":"

(Optional) Campaign status, must be 'draft', 'pending', 'failed', or 'complete'

\n","type":"text"},{"key":"page","value":"1","description":"

(Optional) Page number for results (Default 1)

\n","type":"text"},{"key":"amount","value":"100","description":"

(Optional) Amount of results per page (Default 10, max 100)

\n","type":"text"},{"key":"team_id","value":"1","description":"

(Optional) Team ID. Only for owner API keys.

\n","type":"text","disabled":true}]},"url":"https://api.tlkr.io/campaigns/lookup","description":"

This endpoint allows you to search for campaigns using various optional parameters. You can search by campaign ID, name, status, and paginate the results. The amount parameter allows you to control the number of results per page. The response will include details of the campaigns matching the search criteria.

\n

Request Body Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns","lookup"],"host":["api","tlkr","io"],"query":[],"variable":[]}},"response":[{"id":"371f1064-e0eb-4be5-94d2-9aa409bab0b4","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"status","value":"complete","type":"text"}]},"url":"https://api.tlkr.io/campaigns/lookup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_campaigns\": 1,\n \"campaigns\": [\n {\n \"campaign_id\": 100,\n \"name\": \"The Best Product for Home Defense\",\n \"status\": \"complete\",\n \"number\": \"8888888888\",\n \"url\": \"https://mysite.com/?sub=[code]\",\n \"message\": \"My Site: NEW Product for Home Defense [name]!\\n\\nProtection In The Palm of Your Hand:\\n\\n[link]\\n\\nReply STOP 2 End.\",\n \"media\": \"\",\n \"revenue\": 1000,\n \"conversions\": 22,\n \"sent\": 67457,\n \"filtered\": 2125,\n \"unsubscribed\": 171,\n \"send_at\": \"2024-03-22 17:18:00\",\n \"sent_at\": \"2024-03-22 17:18:02\",\n \"completed_at\": \"2024-03-22 18:06:44\",\n \"failed\": false,\n \"delivered\": 64946,\n \"updated_at\": \"2024-03-29T19:48:43.000000Z\",\n \"created_at\": \"2024-03-22T17:18:00.000000Z\"\n }\n ]\n },\n \"message\": \"Campaign lookup successful\"\n}"}],"_postman_id":"cc049fe3-46fb-47c3-8d64-239007e42229"},{"name":"Get Campaign","id":"c2db8dd6-6844-4c61-bc96-55662319b694","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/campaigns/:id","description":"

Get details of a specific campaign by ID.

\n

Path Parameters

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns",":id"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[{"id":"1ab1131a-1a86-4133-a949-4ea68260efdd","description":{"content":"

(Required) ID of the campaign

\n","type":"text/plain"},"type":"any","value":"100","key":"id"}]}},"response":[{"id":"33882b8f-6097-4925-b10f-55351895cba2","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/campaigns/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"campaign\": {\n \"id\": 100,\n \"name\": \"January Sale Campaign\",\n \"status\": \"complete\",\n \"message\": \"Hi [name], check out our January sale! [link] Reply STOP to opt out.\",\n \"url\": \"https://mysite.com/sale\",\n \"sent\": 5000,\n \"delivered\": 4850,\n \"filtered\": 100,\n \"clicked\": 250,\n \"conversions\": 50,\n \"revenue\": 2500.00,\n \"send_at\": \"2025-01-20T10:00:00+00:00\",\n \"sent_at\": \"2025-01-20T10:00:02+00:00\",\n \"completed_at\": \"2025-01-20T10:45:30+00:00\",\n \"created_at\": \"2025-01-15T10:30:00+00:00\"\n }\n },\n \"message\": \"Campaign retrieved successfully\"\n}"}],"_postman_id":"c2db8dd6-6844-4c61-bc96-55662319b694"},{"name":"Cancel Campaign","id":"960bde95-35ea-4533-9641-1f9ce2870600","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/campaigns/:id/cancel","description":"

Cancel a scheduled or in-progress campaign.

\n

Note: Completed campaigns cannot be cancelled.

\n

Path Parameters

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns",":id","cancel"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[{"id":"ab0c19fc-9fa3-444c-86c7-5d3b8de05db3","description":{"content":"

(Required) ID of the campaign to cancel

\n","type":"text/plain"},"type":"any","value":"100","key":"id"}]}},"response":[{"id":"b78c73ac-7ecc-4d64-8444-5d705dda5a32","name":"Successful Response","originalRequest":{"method":"POST","header":[],"url":"https://api.tlkr.io/campaigns/100/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"campaign\": {\n \"id\": 100,\n \"name\": \"January Sale Campaign\",\n \"status\": \"cancelled\",\n \"cancelled_at\": \"2025-01-18T14:30:00+00:00\"\n }\n },\n \"message\": \"Campaign cancelled successfully\"\n}"}],"_postman_id":"960bde95-35ea-4533-9641-1f9ce2870600"}],"id":"20a65ffe-a2e8-4d40-8d61-4ce88b4e0edb","_postman_id":"20a65ffe-a2e8-4d40-8d61-4ce88b4e0edb","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Segments","item":[{"name":"Create Segment","id":"88a57f2a-83ff-4fb8-8344-fa755c6fd07b","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"VIP Buyers in California\",\n \"match\": \"all\",\n \"filters\": [\n {\n \"filter\": \"tag\",\n \"compare\": \"=\",\n \"value\": \"vip\"\n },\n {\n \"filter\": \"state\",\n \"compare\": \"=\",\n \"value\": \"CA\"\n }\n ]\n}"},"url":"https://api.tlkr.io/segments/create","description":"

Create a new segment with filter criteria.

\n

Request Body (JSON)

\n\n

Filter Types & Value Formats

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FilterValue FormatExample
tagTag name (string)\"vip\", \"buyer\"
state2-letter US state code\"CA\", \"NY\", \"TX\"
country2-letter ISO country code\"US\", \"CA\", \"GB\"
timezoneIANA timezone string\"America/New_York\", \"America/Los_Angeles\", \"America/Chicago\"
clickedCampaign internal_id (integer)1, 5, 10
convertedCampaign internal_id (integer)1, 5, 10
sentCampaign internal_id (integer)1, 5, 10
max_contactsMaximum count (integer)1000, 5000
\n

Compare Operators

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
OperatorDescription
=Equals
!=Not equals
<Less than (for numeric filters)
>Greater than (for numeric filters)
\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["segments","create"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"02642eb4-5e0f-4916-a464-e84652a07517","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"VIP Buyers in California\",\n \"match\": \"all\",\n \"filters\": [\n {\n \"filter\": \"tag\",\n \"compare\": \"=\",\n \"value\": \"vip\"\n },\n {\n \"filter\": \"state\",\n \"compare\": \"=\",\n \"value\": \"CA\"\n }\n ]\n}"},"url":"https://api.tlkr.io/segments/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"segment\": {\n \"id\": 1,\n \"name\": \"VIP Buyers in California\",\n \"match\": \"all\",\n \"filters\": [\n {\n \"filter\": \"tag\",\n \"compare\": \"=\",\n \"value\": \"vip\"\n },\n {\n \"filter\": \"state\",\n \"compare\": \"=\",\n \"value\": \"CA\"\n }\n ],\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-15T10:30:00+00:00\"\n }\n },\n \"message\": \"Segment created successfully\"\n}"}],"_postman_id":"88a57f2a-83ff-4fb8-8344-fa755c6fd07b"},{"name":"List Segments","id":"f3a5deb3-413b-4026-8cc1-044f51fdf1f3","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/segments","description":"

List all segments for the authenticated team.

\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["segments"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"115f14da-f7e0-4342-b983-de9aaeeab480","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/segments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"segments\": [\n {\n \"id\": 1,\n \"name\": \"VIP Buyers in California\",\n \"match\": \"all\",\n \"filters\": [\n {\n \"type\": \"tag\",\n \"operator\": \"contains\",\n \"value\": \"vip\"\n },\n {\n \"type\": \"state\",\n \"operator\": \"equals\",\n \"value\": \"CA\"\n }\n ],\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-15T10:30:00+00:00\"\n }\n ]\n },\n \"message\": \"Segments retrieved successfully\"\n}"}],"_postman_id":"f3a5deb3-413b-4026-8cc1-044f51fdf1f3"},{"name":"Get Segment","id":"75a6f83c-a9f6-47c9-a092-ab8416776593","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/segments/:id","description":"

Get details of a specific segment by ID.

\n

Path Parameters

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["segments",":id"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[{"id":"f5b7160c-dd44-4546-9c35-b94273a16291","description":{"content":"

(Required) ID of the segment

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"e382e891-97f8-441b-8820-add298e077a0","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/segments/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"segment\": {\n \"id\": 1,\n \"name\": \"VIP Buyers in California\",\n \"match\": \"all\",\n \"filters\": [\n {\n \"type\": \"tag\",\n \"operator\": \"contains\",\n \"value\": \"vip\"\n },\n {\n \"type\": \"state\",\n \"operator\": \"equals\",\n \"value\": \"CA\"\n }\n ],\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-15T10:30:00+00:00\"\n }\n },\n \"message\": \"Segment retrieved successfully\"\n}"}],"_postman_id":"75a6f83c-a9f6-47c9-a092-ab8416776593"},{"name":"Update Segment","id":"c8439186-3f98-4b8c-b168-52b04ed4c56e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"VIP Buyers - West Coast\",\n \"match\": \"any\",\n \"filters\": [\n {\n \"filter\": \"state\",\n \"compare\": \"=\",\n \"value\": \"CA\"\n },\n {\n \"filter\": \"state\",\n \"compare\": \"=\",\n \"value\": \"WA\"\n },\n {\n \"filter\": \"state\",\n \"compare\": \"=\",\n \"value\": \"OR\"\n }\n ]\n}"},"url":"https://api.tlkr.io/segments/:id","description":"

Update an existing segment.

\n

Path Parameters

\n\n

Request Body (JSON)

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["segments",":id"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[{"id":"20076af2-61cd-4eb6-81dc-43a1aa585f06","description":{"content":"

(Required) ID of the segment to update

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"41b0593a-9630-467f-a14b-50ff1449d8e1","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"VIP Buyers - West Coast\"\n}"},"url":"https://api.tlkr.io/segments/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"segment\": {\n \"id\": 1,\n \"name\": \"VIP Buyers - West Coast\",\n \"match\": \"all\",\n \"filters\": [\n {\n \"type\": \"tag\",\n \"operator\": \"contains\",\n \"value\": \"vip\"\n },\n {\n \"type\": \"state\",\n \"operator\": \"equals\",\n \"value\": \"CA\"\n }\n ],\n \"created_at\": \"2025-01-15T10:30:00+00:00\",\n \"updated_at\": \"2025-01-16T14:20:00+00:00\"\n }\n },\n \"message\": \"Segment updated successfully\"\n}"}],"_postman_id":"c8439186-3f98-4b8c-b168-52b04ed4c56e"},{"name":"Delete Segment","id":"4e175600-935a-49b3-999e-351bab544fc9","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/segments/:id","description":"

Delete a segment by ID.

\n

Path Parameters

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["segments",":id"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[{"id":"e9a16be1-d9ac-4420-8ecb-f844923aebef","description":{"content":"

(Required) ID of the segment to delete

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"562309b3-068b-4778-8611-3e0bdd2b8cd6","name":"Successful Response","originalRequest":{"method":"DELETE","header":[],"url":"https://api.tlkr.io/segments/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [],\n \"message\": \"Segment deleted successfully\"\n}"}],"_postman_id":"4e175600-935a-49b3-999e-351bab544fc9"}],"id":"b75ccab5-6473-47e9-ab12-ab5857931ce0","_postman_id":"b75ccab5-6473-47e9-ab12-ab5857931ce0","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Stats","item":[{"name":"Get Message Stats","id":"16cf7ce7-c6b7-4ef4-b9bc-eec2aa8a05fb","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/stats/messages?start_date=2025-01-01&end_date=2025-01-31","description":"

Get detailed message statistics for a time period.

\n

Query Parameters

\n\n

Response

\n

Returns message counts including:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["stats","messages"],"host":["api","tlkr","io"],"query":[{"description":{"content":"

(Optional) Start date (YYYY-MM-DD)

\n","type":"text/plain"},"key":"start_date","value":"2025-01-01"},{"description":{"content":"

(Optional) End date (YYYY-MM-DD)

\n","type":"text/plain"},"key":"end_date","value":"2025-01-31"},{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"51ed40e2-f728-46cd-997f-0ea4d1729691","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.tlkr.io/stats/messages?start_date=2025-01-01&end_date=2025-01-31","protocol":"https","host":["api","tlkr","io"],"path":["stats","messages"],"query":[{"key":"start_date","value":"2025-01-01"},{"key":"end_date","value":"2025-01-31"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"period\": {\n \"start_date\": \"2025-01-01T00:00:00+00:00\",\n \"end_date\": \"2025-01-31T23:59:59+00:00\"\n },\n \"counts\": {\n \"total\": 18000,\n \"sent\": 800,\n \"sending\": 0,\n \"delivered\": 14200,\n \"failed\": 300,\n \"filtered\": 500,\n \"received\": 2500,\n \"mms\": 1200\n }\n },\n \"message\": \"Message statistics retrieved successfully\"\n}"}],"_postman_id":"16cf7ce7-c6b7-4ef4-b9bc-eec2aa8a05fb"},{"name":"Get Campaign Stats","id":"bd2ec8c8-8250-4c92-8c87-1be74fae59c0","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/stats/campaigns?start_date=2025-01-01&end_date=2025-01-31","description":"

Get campaign statistics for a time period.

\n

Query Parameters

\n\n

Response

\n

Returns campaign statistics:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["stats","campaigns"],"host":["api","tlkr","io"],"query":[{"description":{"content":"

(Optional) Start date (YYYY-MM-DD)

\n","type":"text/plain"},"key":"start_date","value":"2025-01-01"},{"description":{"content":"

(Optional) End date (YYYY-MM-DD)

\n","type":"text/plain"},"key":"end_date","value":"2025-01-31"},{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"344f1b44-6339-4bb4-872a-5f416300f479","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.tlkr.io/stats/campaigns?start_date=2025-01-01&end_date=2025-01-31","protocol":"https","host":["api","tlkr","io"],"path":["stats","campaigns"],"query":[{"key":"start_date","value":"2025-01-01"},{"key":"end_date","value":"2025-01-31"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"period\": {\n \"start_date\": \"2025-01-01T00:00:00+00:00\",\n \"end_date\": \"2025-01-31T23:59:59+00:00\"\n },\n \"counts\": {\n \"total\": 12,\n \"completed\": 10,\n \"in_progress\": 0,\n \"scheduled\": 1,\n \"draft\": 1\n },\n \"aggregates\": {\n \"messages_sent\": 150000,\n \"messages_delivered\": 142000,\n \"messages_filtered\": 5000,\n \"clicks\": 7500,\n \"conversions\": 1200,\n \"revenue\": 24000.00,\n \"credits_used\": 155000\n }\n },\n \"message\": \"Campaign statistics retrieved successfully\"\n}"}],"_postman_id":"bd2ec8c8-8250-4c92-8c87-1be74fae59c0"}],"id":"dd94c511-403b-4c73-8e0b-92ae11ad2f46","_postman_id":"dd94c511-403b-4c73-8e0b-92ae11ad2f46","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Get Webhook Settings","id":"ffd68188-08d3-41e6-979c-3a306c53cfde","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/webhooks","description":"

Get current webhook configuration for the team.

\n

Query Parameters

\n\n

Response

\n

Returns configured webhook URLs:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["webhooks"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"e824c1df-5189-4dd3-af07-3d5eab5ee056","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.tlkr.io/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"webhooks\": {\n \"inbound_webhook_url\": \"https://myapp.com/webhooks/sms-inbound\",\n \"registration_webhook_url\": \"https://myapp.com/webhooks/registration-status\"\n }\n },\n \"message\": \"Webhook URLs retrieved successfully\"\n}"}],"_postman_id":"ffd68188-08d3-41e6-979c-3a306c53cfde"},{"name":"Set Webhook URLs","id":"23aa602f-905c-435a-a8e6-1f69d013428f","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"inbound_webhook_url","value":"https://myapp.com/webhooks/sms-inbound","description":"

(Optional) URL to receive incoming SMS messages

\n","type":"text"},{"key":"registration_webhook_url","value":"https://myapp.com/webhooks/registration-status","description":"

(Optional) URL to receive number registration status changes

\n","type":"text"}]},"url":"https://api.tlkr.io/webhooks","description":"

Set or update webhook URLs for the team.

\n

Request Body

\n\n

Query Parameters

\n\n
\n

Webhook Payloads

\n

Webhooks are sent as POST requests with Content-Type: application/json.

\n

Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderDescription
Content-Typeapplication/json
X-Webhook-EventEvent type (inbound_message or registration_status_changed)
X-Team-IDYour team's UUID
\n
\n

Inbound Message Webhook

\n

Sent when an SMS/MMS is received on one of your brand numbers.

\n
{\n    \"event\": \"inbound_message\",\n    \"timestamp\": \"2025-01-15T10:30:00+00:00\",\n    \"data\": {\n        \"message_id\": 12345,\n        \"from\": \"+15551234567\",\n        \"to\": \"+18005559876\",\n        \"body\": \"Hey, I have a question about my order\",\n        \"media\": \"https://cdn.tlkr.io/media/123/image.jpg\",\n        \"status\": \"received\",\n        \"contact\": {\n            \"id\": 456,\n            \"phone\": \"+15551234567\",\n            \"name\": \"John\",\n            \"email\": \"john@example.com\"\n        },\n        \"brand\": {\n            \"id\": 1,\n            \"name\": \"My Brand\",\n            \"number\": \"+18005559876\"\n        },\n        \"received_at\": \"2025-01-15T10:30:00+00:00\"\n    }\n}\n
\n

Fields:

\n\n
\n

Registration Status Webhook

\n

Sent when a brand's toll-free verification status changes.

\n
{\n    \"event\": \"registration_status_changed\",\n    \"timestamp\": \"2025-01-15T10:30:00+00:00\",\n    \"data\": {\n        \"brand_id\": 1,\n        \"brand_name\": \"My Brand\",\n        \"brand_number\": \"+18005559876\",\n        \"previous_status\": \"pending\",\n        \"status\": \"active\",\n        \"error_code\": null,\n        \"updated_at\": \"2025-01-15T10:30:00+00:00\"\n    }\n}\n
\n

Fields:

\n\n

Possible Status Values:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["webhooks"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"8869386c-47e9-4423-88c8-964dbd2ee2da","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"inbound_webhook_url","value":"https://myapp.com/webhooks/sms-inbound","type":"text"}]},"url":"https://api.tlkr.io/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"webhooks\": {\n \"inbound_webhook_url\": \"https://myapp.com/webhooks/sms-inbound\",\n \"registration_webhook_url\": null\n }\n },\n \"message\": \"Webhook URLs updated successfully\"\n}"}],"_postman_id":"23aa602f-905c-435a-a8e6-1f69d013428f"},{"name":"Delete Webhook URLs","id":"af5dc4cd-f0d2-4e37-9a2e-e085b1d9dd8c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.tlkr.io/webhooks","description":"

Remove all webhook configuration for the team.

\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["webhooks"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"20419bb6-b8c3-48a8-8149-6a8810688aa6","name":"Successful Response","originalRequest":{"method":"DELETE","header":[],"url":"https://api.tlkr.io/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"webhooks\": {\n \"inbound_webhook_url\": null,\n \"registration_webhook_url\": null\n }\n },\n \"message\": \"Webhook URLs removed successfully\"\n}"}],"_postman_id":"af5dc4cd-f0d2-4e37-9a2e-e085b1d9dd8c"}],"id":"69dd67c3-eafa-4733-8cad-ac42988e6227","description":"

Configure webhook URLs to receive real-time notifications.

\n

Available Webhooks

\n
    \n
  1. Inbound Message Webhook - Triggered when you receive an SMS/MMS
    2. \n
  2. Registration Status Webhook - Triggered when brand verification status changes
    3. \n
\n

See the \"Set Webhook URLs\" endpoint for full payload documentation.

\n","_postman_id":"69dd67c3-eafa-4733-8cad-ac42988e6227","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Contacts","item":[{"name":"Create a Contact","id":"ceaa94ff-7046-4ee0-8f00-caf2ae62e412","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","description":"

(Optional) First name of contact

\n","type":"text"},{"key":"last_name","value":"Doe","description":"

(Optional) Last name of contact

\n","type":"text"},{"key":"phone","value":"5555555555","description":"

(Required) Phone number of contact

\n","type":"text"},{"key":"tags","value":"buyer","description":"

(Optional) Apply new tags to the contact, for multiple tags seperate by comma

\n","type":"text"},{"key":"remove_tags","value":"lead","description":"

(Optional) Only if contact already exists and update is true, for multiple tags seperate by comma

\n","type":"text"},{"key":"update","value":"true","description":"

(Optional) Update the contact if they already exist (Default True)

\n","type":"text"}]},"url":"https://api.tlkr.io/contacts/create","description":"

Create Contact

\n

This endpoint allows you to create a new contact in the system.

\n

Request Body

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["contacts","create"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"027a7df9-1dcf-4317-8a33-aa3266ce9772","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","type":"text"},{"key":"last_name","value":"Doe","type":"text"},{"key":"phone","value":"5555555555","type":"text"},{"key":"tags","value":"tester","type":"text"}]},"url":"https://api.tlkr.io/contacts/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"contact_id\": 178,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+15555555555\",\n \"tags\": [\n \"tester\"\n ],\n \"timezone\": \"America/Los_Angeles\",\n \"state\": \"CA\",\n \"unsubscribed_at\": null,\n \"updated_at\": \"2024-03-31T21:12:30.000000Z\",\n \"created_at\": \"2024-03-31T21:12:30.000000Z\"\n },\n \"message\": \"Contact created successfully\"\n}"}],"_postman_id":"ceaa94ff-7046-4ee0-8f00-caf2ae62e412"},{"name":"Bulk Create Contacts","id":"dde7b320-a882-42c9-814d-83e41e985d4a","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"phone\": \"+15551234567\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"tags\": [\"buyer\", \"vip\"]\n },\n {\n \"phone\": \"+15559876543\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"state\": \"CA\",\n \"tags\": [\"lead\"]\n }\n ],\n \"update_existing\": true\n}"},"url":"https://api.tlkr.io/contacts/bulk","description":"

Create multiple contacts in a single request.

\n

Note: This is a heavy operation with rate limiting of 10 requests per minute. Maximum 100 contacts per request.

\n

Request Body (JSON)

\n\n

Query Parameters

\n\n

Response

\n

Returns summary of:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["contacts","bulk"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"02af8cf8-0cfe-4b98-806f-2d9e57253c29","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"phone\": \"+15551234567\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"tags\": [\"buyer\", \"vip\"]\n },\n {\n \"phone\": \"+15559876543\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"tags\": [\"lead\"]\n }\n ],\n \"update_existing\": true\n}"},"url":"https://api.tlkr.io/contacts/bulk"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"created\": [\n {\n \"contact\": {\n \"id\": 179,\n \"phone\": \"+15551234567\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n }\n ],\n \"updated\": [\n {\n \"contact\": {\n \"id\": 180,\n \"phone\": \"+15559876543\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n }\n }\n ],\n \"failed\": [],\n \"summary\": {\n \"total\": 2,\n \"created\": 1,\n \"updated\": 1,\n \"failed\": 0\n }\n },\n \"message\": \"Bulk contacts processed successfully\"\n}"}],"_postman_id":"dde7b320-a882-42c9-814d-83e41e985d4a"},{"name":"Lookup Contacts","id":"475f5c1d-d646-46b7-8dda-4a3aedf51105","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","description":"

(Optional) First name of contact

\n","type":"text"},{"key":"last_name","value":"Doe","description":"

(Optional) Last name of contact

\n","type":"text"},{"key":"phone","value":"5555555555","description":"

(Optional) Phone number of contact

\n","type":"text"},{"key":"tags","value":"tester","description":"

(Optional) Tags associated with contact, for multiple tags seperate by comma. Results will be matched for all tags included

\n","type":"text"},{"key":"contact_id","value":"178","description":"

(Optional) Id of the contact

\n","type":"text"},{"key":"state","value":"CA","description":"

(Optional) 2 letter state abbreviation

\n","type":"text"},{"key":"page","value":"1","description":"

(Optional) Page number for results (Default 1)

\n","type":"text"},{"key":"amount","value":"20","description":"

(Optional) Amount of results per page (Default 20, max 200)

\n","type":"text"}]},"url":"https://api.tlkr.io/contacts/lookup","description":"

Contacts Lookup

\n

This endpoint is used to look up contacts with optional parameters such as first name, last name, phone number, tags, contact ID, state, page number, and amount of results per page.

\n

Request Body Parameters:

\n\n

Query Parameters:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["contacts","lookup"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"7b6e2e73-0ed8-4716-b385-e27c6bf7ecd0","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"state","value":"CA","type":"text"}]},"url":"https://api.tlkr.io/contacts/lookup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total_contacts\": 1,\n \"contacts\": [\n {\n \"contact_id\": 178,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+15555555555\",\n \"timezone\": \"America/Los_Angeles\",\n \"state\": \"CA\",\n \"tags\": [\n \"tester\"\n ],\n \"unsubscribed_at\": null,\n \"updated_at\": \"2024-03-31T21:12:30.000000Z\",\n \"created_at\": \"2024-03-31T21:12:30.000000Z\"\n }\n ]\n },\n \"message\": \"Contact lookup successful\"\n}"}],"_postman_id":"475f5c1d-d646-46b7-8dda-4a3aedf51105"},{"name":"Update a Contact","id":"b9574cbf-7db6-4483-9c72-27d8fd872f9b","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"contact_id","value":"178","description":"

(Required if phone is not present) Id of the contact to be updated

\n","type":"text"},{"key":"first_name","value":"John","description":"

(Optional) First name of contact to update

\n","type":"text"},{"key":"last_name","value":"Smith","description":"

(Optional) Last name of contact to update

\n","type":"text"},{"key":"phone","value":"5555555555","description":"

(Required if contact_id is not present) Phone number of contact to update

\n","type":"text"},{"key":"tags","value":"tester","description":"

(Optional) Apply new tags to the contact, for multiple tags seperate by comma

\n","type":"text"},{"key":"remove_tags","value":"tested","description":"

(Optional) Tags to remove from contact, for multiple tags seperate by comma

\n","type":"text"},{"key":"merge_tags","value":"true","description":"

(Optional) Merge tags if true, overwrite tags if false (Default true)

\n","type":"text"}]},"url":"https://api.tlkr.io/contacts/update","description":"

This API endpoint allows you to update a contact's information. If the contact_id is not present, you must provide the phone number of the contact to be updated.

\n

Query Parameters:

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["contacts","update"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"a15ff274-70d1-4b66-bc56-9ffd33cce6c9","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"contact_id","value":"178","type":"text"},{"key":"last_name","value":"Smith","type":"text"}]},"url":"https://api.tlkr.io/contacts/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"contact_id\": 178,\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"phone\": \"+15555555555\",\n \"tags\": [\n \"tester\"\n ],\n \"timezone\": \"Etc/Unknown\",\n \"state\": \"CA\",\n \"unsubscribed_at\": null,\n \"updated_at\": \"2024-03-31T21:16:42.299463Z\",\n \"created_at\": \"2024-03-31T21:12:30.000000Z\"\n },\n \"message\": \"Contact updated successfully\"\n}"}],"_postman_id":"b9574cbf-7db6-4483-9c72-27d8fd872f9b"},{"name":"Unsubscribe a Contact","id":"27dbf1e4-4a1e-4dc9-a65a-d7a22b2d3c0d","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"phone","value":"5555555555","description":"

(Required) Phone number of contact

\n","type":"text"}]},"url":"https://api.tlkr.io/contacts/unsubscribe","description":"

This API endpoint allows you to unsubscribe a contact.

\n

Note: Contacts who are unsubscribed can only be resubscribed by texting START.

\n

Request Body

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["contacts","unsubscribe"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"f2bfd314-7e82-4188-a741-147c830da868","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"phone","value":"5555555555","type":"text"}]},"url":"https://api.tlkr.io/contacts/unsubscribe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [],\n \"message\": \"Contact unsubscribed successfully\"\n}"}],"_postman_id":"27dbf1e4-4a1e-4dc9-a65a-d7a22b2d3c0d"}],"id":"92a44332-1609-4823-95a2-3d6b33724370","_postman_id":"92a44332-1609-4823-95a2-3d6b33724370","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Conversions","item":[{"name":"Record a Conversion","id":"3c8a4f4f-9bac-46eb-a76c-ef861d53e08c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"id","value":"AAAAAA","description":"

(Required) Id generated by a short code url

\n","type":"text"},{"key":"amount","value":"20.00","description":"

(Required) Amount the conversion is worth

\n","type":"text"}]},"url":"https://api.tlkr.io/conversion","description":"

API Request Description

\n

This endpoint allows you to submit a POST request to record a conversion.

\n

Note: No auth is needed on this endpoint

\n

Request Body

\n\n","urlObject":{"protocol":"https","path":["conversion"],"host":["api","tlkr","io"],"query":[],"variable":[]}},"response":[{"id":"b84640ac-d948-43ba-8c96-14edb5a11aac","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"AAAAAA","type":"text"},{"key":"amount","value":"20.00","type":"text"}]},"url":"https://api.tlkr.io/conversion"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [],\n \"message\": \"Conversion Succesful\"\n}"}],"_postman_id":"3c8a4f4f-9bac-46eb-a76c-ef861d53e08c"}],"id":"2dd51fab-7d92-4a59-aad2-2e0de0d610b6","_postman_id":"2dd51fab-7d92-4a59-aad2-2e0de0d610b6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}},{"name":"Messages","item":[{"name":"Lookup Messages","id":"3773a7e7-05a7-466a-a36b-94fb18f72ab7","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"contact_id","value":"1","description":"

(Required if phone is not present) Id of contact

\n","type":"text"},{"key":"phone","value":"5555555555","description":"

(Required if contact_id is not present) Phone number of contact

\n","type":"text"},{"key":"brand_id","value":"1","description":"

(Optional) Filter messages by brand ID

\n","type":"text","disabled":true},{"key":"page","value":"1","description":"

(Optional) Page number for results (Default 1)

\n","type":"text"},{"key":"amount","value":"10","description":"

(Optional) Amount of results per page (Default 10, max 100)

\n","type":"text"}]},"url":"https://api.tlkr.io/messages/lookup","description":"

This endpoint is used to look up messages for a contact.

\n

Request Body Parameters

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["messages","lookup"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"04b7e508-36d0-4c5b-b7ef-0495f51ae616","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"contact_id","value":"1","type":"text"}]},"url":"https://api.tlkr.io/messages/lookup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"current_page\": 1,\n \"per_page\": 10,\n \"total_messages\": 1,\n \"messages\": [\n {\n \"contact_id\": 1,\n \"contact_first_name\": \"John\",\n \"contact_last_name\": \"Smith\",\n \"contact_phone\": \"+15555555555\",\n \"brand_id\": 1,\n \"message\": \"My Site: Hey [first_name], check out this awesome new product! \\n\\nhttps://mysite.com\\n\\nReply STOP to unsubscribe\",\n \"status\": \"delivered\",\n \"created_at\": \"2023-07-29 17:33:02\"\n }\n ]\n },\n \"message\": \"Message lookup successful\"\n}"}],"_postman_id":"3773a7e7-05a7-466a-a36b-94fb18f72ab7"},{"name":"Send a Message","id":"15e6024f-7c5f-48b6-95d5-bc323dd17856","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"contact_id","value":"1","description":"

(Required if phone is not present) Id of contact

\n","type":"text"},{"key":"phone","value":"5555555555","description":"

(Required if contact_id is not present) Phone number of contact

\n","type":"text"},{"key":"first_name","value":"John","description":"

(Optional) First name of contact

\n","type":"text"},{"key":"last_name","value":"Smith","description":"

(Optional) Last name of contact

\n","type":"text"},{"key":"tags","value":"tester","description":"

(Optional) Tags associated with contact, for multiple tags seperate by comma

\n","type":"text"},{"key":"message","value":"API Test Message [link]","description":"

(Required) Message body to be sent

\n","type":"text"},{"key":"brand_id","value":"1","description":"

(Optional) The ID of your brand, if your account has multiple brands (Default 1)

\n","type":"text"},{"key":"media_url","value":"https://tlkr.io/images/logo.png","description":"

(Optional) Public URL of media you would like attached to the sms

\n","type":"text"},{"key":"promo_url","value":"https://google.com","description":"

(Optional) If you would like to generate a short code for your promotional url, add [link] token to message body to populate

\n","type":"text"}]},"url":"https://api.tlkr.io/messages/create","description":"

This API endpoint allows you to create and send a message to a contact.

\n

Note: If the contact exists the tags will be added and name updated. If the contact does not exist it will be created.

\n

Request Body Parameters

\n\n

Query Parameters

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}},"urlObject":{"protocol":"https","path":["messages","create"],"host":["api","tlkr","io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Team UUID. Only for owner API keys.

\n","type":"text/plain"},"key":"team_id","value":"550e8400-e29b-41d4-a716-446655440000"}],"variable":[]}},"response":[{"id":"d55e5c90-379d-4568-9ebd-020f869a8563","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"phone","value":"5555555555","type":"text"},{"key":"message","value":"Hello from the API!","type":"text"}]},"url":"https://api.tlkr.io/messages/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [],\n \"message\": \"Message sent successfully\"\n}"}],"_postman_id":"15e6024f-7c5f-48b6-95d5-bc323dd17856"}],"id":"41d8be5d-cdb9-476b-a6e6-c25c2d33005e","_postman_id":"41d8be5d-cdb9-476b-a6e6-c25c2d33005e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]},"isInherited":true,"source":{"_postman_id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","id":"50371a9a-1392-4068-9fbe-d249d59c9bb3","name":"TLKR API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ apikey }}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"135a196c-9527-4e0b-8c7a-1bfb5b5fb505"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"c47fcc41-e0b4-4efe-a267-4945feb49817"}}],"variable":[{"key":"apikey","value":"YOUR_API_KEY"}]}