List Android phones
GET /api/v1/relayers.json
Query Parameters
relayer One or more channel ids to filter by. (repeatable) ex: 235,124 (optional)
phone One or more phone number to filter by. (repeatable) ex: +250788123123,+250788456456 (optional)
before Only return channels which were last seen before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return channels which were last seen after this date. ex: 2012-01-28T18:00:00.000 (optional)
country Only channels which are active in countries with these country codes. (repeatable) ex: RW (optional)
GET https://api.textit.in/api/v1/relayers.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Attach a Channel to your account using a claim code
POST /api/v1/relayers.json
Post Body
claim_code The 9 character claim code displayed by the Android application after startup. ex: FJUQOGIEF (required)
phone The phone number of the channel. ex: +250788123123 (required)
name A friendly name you want to assign to this channel. ex: MTN Rwanda (optional)
POST https://api.textit.in/api/v1/relayers.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
Delete Android phones
DELETE /api/v1/relayers.json
Query Parameters
relayer Only delete channels with these ids. (repeatable) ex: 235,124 (optional)
phone Only delete channels with these phones numbers. (repeatable) ex: +250788123123,+250788456456 (optional)
before Only delete channels which were last seen before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only delete channels which were last seen after this date. ex: 2012-01-28T18:00:00.000 (optional)
country Only delete channels which are active in countries with these country codes. (repeatable) ex: RW (optional)
DELETE https://api.textit.in/api/v1/relayers.json
        Authorization: Token 
        
DELETE query parameters - View Full Documentation Log in to use the Explorer

    
List Contacts
GET /api/v1/contacts.json
Query Parameters
uuid One or more UUIDs to filter by. (repeatable) ex: 27fb583b-3087-4778-a2b3-8af489bf4a93 (optional)
urns One or more URNs to filter by. ex: tel:+250788123123,twitter:ben (optional)
group_uuids One or more group UUIDs to filter by. (repeatable) ex: 6685e933-26e1-4363-a468-8f7268ab63a9 (optional)
after only contacts which have changed on this date or after. ex: 2012-01-28T18:00:00.000 (optional)
before only contacts which have changed on this date or before. ex: 2012-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v1/contacts.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Add or update a Contact
POST /api/v1/contacts.json
Post Body
name The name of the contact. ex: Ben Haggerty (optional)
language The 3 letter iso code for the preferred language of the contact. ex: fre, eng (optional)
urns The URNs of the contact. ex: ["tel:+250788123123"] (required)
group_uuids The UUIDs of groups this contact should be part of, as a string array. ex: ["6685e933-26e1-4363-a468-8f7268ab63a9"] (optional)
fields Any fields to set on the contact, as a JSON dictionary. ex: { "Delivery Date": "2012-10-10 5:00" } (optional)
POST https://api.textit.in/api/v1/contacts.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
Delete Contacts
DELETE /api/v1/contacts.json
Query Parameters
uuid One or more UUIDs to filter by. (repeatable) ex: 27fb583b-3087-4778-a2b3-8af489bf4a93 (optional)
urns One or more URNs to filter by. ex: tel:+250788123123,twitter:ben (optional)
group_uuids One or more group UUIDs to filter by. (repeatable) ex: 6685e933-26e1-4363-a468-8f7268ab63a9 (optional)
DELETE https://api.textit.in/api/v1/contacts.json
        Authorization: Token 
        
DELETE query parameters - View Full Documentation Log in to use the Explorer

    
Update one or more contacts
POST /api/v1/contact_actions.json
Post Body
contacts A JSON array of one or more strings, each a contact UUID. (required)
action One of the following strings: add, remove, block, unblock, expire, archive, delete (required)
group The name of a contact group if the action is add or remove (optional)
label_uuid The UUID of a contact group if the action is add or remove (optional)
POST https://api.textit.in/api/v1/contact_actions.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
List Contact Groups
GET /api/v1/groups.json
Query Parameters
name The name of the Contact Group to return. ex: Reporters (optional)
uuid The UUID of the Contact Group to return. (repeatable) ex: 5f05311e-8f81-4a67-a5b5-1501b6d6496a (optional)
GET https://api.textit.in/api/v1/groups.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
List Contact Fields
GET /api/v1/fields.json
Query Parameters
key The key of the Contact Field to return. ex: state (optional)
GET https://api.textit.in/api/v1/fields.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Add or update a Contact Field
POST /api/v1/fields.json
Post Body
key The unique key of the field, required when updating a field, generated for new fields. ex: "nick_name" (optional)
label The label of the field. ex: "Nick name" (optional)
value_type The value type code. ex: T, N, D, S, I (optional)
POST https://api.textit.in/api/v1/fields.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
List recent messages
GET /api/v1/messages.json
Query Parameters
id One or more message ids to filter by. (repeatable) ex: 234235,230420 (optional)
contact One or more contact UUIDs to filter by. (repeatable) ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional)
group_uuids One or more contact group UUIDs to filter by. (repeatable) ex: 0ac92789-89d6-466a-9b11-95b0be73c683 (optional)
status One or more status states to filter by. (repeatable) ex: Q,S,D (optional)
direction One or more directions to filter by. (repeatable) ex: I,O (optional)
archived Filter returned messages based on whether they are archived. ex: Y (optional)
type One or more message types to filter by (inbox or flow). (repeatable) ex: I,F (optional)
urn One or more URNs to filter messages by. (repeatable) ex: tel:+250788123123 (optional)
label One or more message labels to filter by. (repeatable) ex: Clogged Filter (optional)
flow One or more flow ids to filter by. (repeatable) ex: 11851 (optional)
broadcast One or more broadcast ids to filter by. (repeatable) ex: 23432,34565 (optional)
before Only return messages before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return messages after this date. ex: 2012-01-28T18:00:00.000 (optional)
relayer Only return messages that were received or sent by these channels. (repeatable) ex: 515,854 (optional)
GET https://api.textit.in/api/v1/messages.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Update one or more messages
POST /api/v1/message_actions.json
Post Body
messages A JSON array of one or more integers, each a message id. (required)
action One of the following strings: label, unlabel, archive, unarchive, delete (required)
label The name of a label if the action is label or unlabel (optional)
label_uuid The UUID of a label if the action is label or unlabel (optional)
POST https://api.textit.in/api/v1/message_actions.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
List recent broadcasts
GET /api/v1/broadcasts.json
Query Parameters
id One or more message ids to filter by (repeatable). ex: 234235,230420 (optional)
status One or more status states to filter by (repeatable). ex: Q,S,D (optional)
before Only return messages before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return messages after this date. ex: 2012-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v1/broadcasts.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Send one or more messages
POST /api/v1/broadcasts.json
Post Body
urns A JSON array of one or more strings, each a contact URN. (optional)
contacts A JSON array of one or more strings, each a contact UUID. (optional)
groups A JSON array of one or more strings, each a group UUID. (optional)
text The text of the message you want to send (max length 480 chars) (required)
channel The id of the channel to use for sending (optional)
POST https://api.textit.in/api/v1/broadcasts.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
List Message Labels
GET /api/v1/labels.json
Query Parameters
name The name of the message label to return. ex: Priority (optional)
uuid The UUID of the message label to return. (repeatable) ex: fdd156ca-233a-48c1-896d-a9d594d59b95 (optional)
GET https://api.textit.in/api/v1/labels.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Add or Update a Message Label
POST /api/v1/labels.json
Post Body
uuid The UUID of the message label. ex: "fdd156ca-233a-48c1-896d-a9d594d59b95" (required)
name The name of the message label. ex: "Screened" (optional)
POST https://api.textit.in/api/v1/labels.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
List recent incoming and outgoing Calls
GET /api/v1/calls.json
Query Parameters
call One or more call ids to filter by. ex: 2335,2320 (optional)
call_type One or more types of calls to filter by. (repeatable) ex: mo_miss (optional)
phone One or more phone numbers to filter by in E164 format. (repeatable) ex: +250788123123 (optional)
before Only return messages before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return messages after this date. ex: 2012-01-28T18:00:00.000 (optional)
relayer Only return messages that were received or sent by these channels. ex: 515,854 (optional)
GET https://api.textit.in/api/v1/calls.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
List Flows
GET /api/v1/flows.json
Query Parameters
flow One or more flow ids to filter by. (repeatable) ex: 234235,230420 (optional)
before Only return flows which were created before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return flows which were created after this date. ex: 2012-01-28T18:00:00.000 (optional)
label Only return flows with this label. (repeatable) ex: Polls (optional)
archived Filter returned flows based on whether they are archived. ex: Y (optional)
GET https://api.textit.in/api/v1/flows.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
List Flow Runs
GET /api/v1/runs.json
Query Parameters
run One or more run ids to filter by. (repeatable) ex: 1234,1235 (optional)
flow_uuid One or more flow UUIDs to filter by. (repeatable) ex: f5901b62-ba76-4003-9c62-72fdacc1b7b7 (optional)
contact One or more contact UUIDs to filter by. (repeatable) ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional)
group_uuids One or more group UUIDs to filter by.(repeatable) ex: 6685e933-26e1-4363-a468-8f7268ab63a9 (optional)
before Only return runs which were modified before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return runs which were modified after this date. ex: 2012-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v1/runs.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Add one or more contacts to a Flow
POST /api/v1/runs.json
Post Body
flow_uuid The uuid of the flow to start the contact(s) on, the flow cannot be archived (required)
phone A JSON array of one or more strings, each a phone number in E164 format (required)
contact A JSON array of one or more strings, each a contact UUID (optional)
extra A dictionary of key/value pairs to include as the @extra parameters in the flow (max of twenty values of 255 chars or less) (optional)
POST https://api.textit.in/api/v1/runs.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
List Campaigns
GET /api/v1/campaigns.json
Query Parameters
uuid One or more campaign UUIDs to filter by. (repeatable) ex: f14e4ff0-724d-43fe-a953-1d16aefd1c00 (optional)
before Only return flows which were created before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return flows which were created after this date. ex: 2012-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v1/campaigns.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Add or update a Campaign
POST /api/v1/campaigns.json
Post Body
uuid The UUID of the campaign to update. (optional, new campaign will be created if left out) ex: f14e4ff0-724d-43fe-a953-1d16aefd1c00 (optional)
name The name of the campaign. ex: "Reminders" (required)
group_uuid The UUID of the contact group the campaign should operate against. ex: "7ae473e8-f1b5-4998-bd9c-eb8e28c92fa9" (required)
POST https://api.textit.in/api/v1/campaigns.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
List Campaign Events
GET /api/v1/events.json
Query Parameters
uuid One or more event UUIDs to filter by. (repeatable) ex: 6a6d7531-6b44-4c45-8c33-957ddd8dfabc (optional)
campaign_uuid One or more campaign UUIDs to filter by. (repeatable) ex: f14e4ff0-724d-43fe-a953-1d16aefd1c00 (optional)
before Only return flows which were created before this date. ex: 2012-01-28T18:00:00.000 (optional)
after Only return flows which were created after this date. ex: 2012-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v1/events.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer

    
Add or update a Campaign Event
POST /api/v1/events.json
Post Body
uuid The UUID of the event to update. (optional, new event will be created if left out) ex: 6a6d7531-6b44-4c45-8c33-957ddd8dfab (optional)
campaign_uuid The UUID of the campaign this event is part of. (optional, only used when creating a new campaign) ex: f14e4ff0-724d-43fe-a953-1d16aefd1c00 (optional)
relative_to The name of the Contact field this event is relative to. (string) ex: "Last Fix" (required)
offset The offset, as an integer to the relative_to field (integer, positive or negative) ex: 15 (required)
unit The unit of the offset, one of M for minutes, H for hours, D for days or W for weeks (string) ex: "M" (required)
delivery_hour The hour this event should be triggered, or -1 if the event should be sent at the same hour as our date (integer, -1 or 0-23) ex: "16" (required)
message The message that should be sent to the contact when this event is triggered. (string) ex: "It is time to raise the roof." (optional)
flow_uuid If not message is included, then the UUID of the flow that the contact should start when this event is triggered (string) ex: 6db50de7-2d20-4cce-b0dd-3f38b7a52ff9 (optional)
POST https://api.textit.in/api/v1/events.json
        Authorization: Token 
        
POST body - View Full Documentation Log in to use the Explorer

    
Delete a Campaign Event from a Campaign
DELETE /api/v1/events.json
Query Parameters
uuid Only delete events with these UUIDs. (repeatable) ex: 6a6d7531-6b44-4c45-8c33-957ddd8dfabc (optional)
campaign_uuid Only delete events that are part of these campaigns. ex: f14e4ff0-724d-43fe-a953-1d16aefd1c00 (optional)
DELETE https://api.textit.in/api/v1/events.json
        Authorization: Token 
        
DELETE query parameters - View Full Documentation Log in to use the Explorer

    
List the Administrative Boundaries
GET /api/v1/boundaries.json
Query Parameters
GET https://api.textit.in/api/v1/boundaries.json
        Authorization: Token 
        
GET query parameters - View Full Documentation Log in to use the Explorer