List Administrative Boundaries
GET /api/v2/boundaries.json
GET https://api.textit.in/api/v2/boundaries.json
Authorization: Token
Log in to use the Explorer

    
List Broadcasts
GET /api/v2/broadcasts.json
Query String Parameters
id A broadcast ID to filter by, ex: 123456 (optional)
before Only return broadcasts created before this date, ex: 2015-01-28T18:00:00.000 (optional)
after Only return broadcasts created after this date, ex: 2015-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v2/broadcasts.json
Authorization: Token
Log in to use the Explorer

    
Send Broadcasts
POST /api/v2/broadcasts.json
Post Body Fields
text The text of the message you want to send (required)
urns The URNs of contacts you want to send to (optional)
contacts The UUIDs of contacts you want to send to (optional)
groups The UUIDs of contact groups you want to send to (optional)
channel The UUID of the channel you want to use for sending (optional)
POST https://api.textit.in/api/v2/broadcasts.json
Authorization: Token
Log in to use the Explorer

    
List Campaigns
GET /api/v2/campaigns.json
Query String Parameters
uuid A campaign UUID to filter by (optional)
GET https://api.textit.in/api/v2/campaigns.json
Authorization: Token
Log in to use the Explorer

    
Add or Update Campaigns
POST /api/v2/campaigns.json
Query String Parameters
uuid UUID of the campaign to be updated (optional)
Post Body Fields
name The name of the campaign (required)
group The UUID of the contact group operated on by the campaign (required)
POST https://api.textit.in/api/v2/campaigns.json
Authorization: Token
Log in to use the Explorer

    
List Campaign Events
GET /api/v2/campaign_events.json
Query String Parameters
uuid A campaign event UUID to filter by (optional)
campaign A campaign UUID or name to filter (optional)
GET https://api.textit.in/api/v2/campaign_events.json
Authorization: Token
Log in to use the Explorer

    
Add or Update Campaign Events
POST /api/v2/campaign_events.json
Query String Parameters
uuid The UUID of the campaign event to update (optional)
Post Body Fields
campaign The UUID of the campaign this event belongs to (optional)
relative_to The key of the contact field this event is relative to. (string) (required)
offset The offset from the relative_to field value (integer, positive or negative) (required)
unit The unit of the offset (one of "minutes, "hours", "days", "weeks") (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) (required)
message The message that should be sent to the contact when this event is triggered (string) (optional)
flow The UUID of the flow that the contact should start when this event is triggered (string) (optional)
POST https://api.textit.in/api/v2/campaign_events.json
Authorization: Token
Log in to use the Explorer

    
Delete Campaign Events
DELETE /api/v2/campaign_events.json
Query String Parameters
uuid The UUID of the campaign event to delete (optional)
DELETE https://api.textit.in/api/v2/campaign_events.json
Authorization: Token
Log in to use the Explorer

    
List Channels
GET /api/v2/channels.json
Query String Parameters
uuid A channel UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional)
address A channel address to filter by. ex: +250783530001 (optional)
GET https://api.textit.in/api/v2/channels.json
Authorization: Token
Log in to use the Explorer

    
List Channel Events
GET /api/v2/channel_events.json
Query String Parameters
id An event ID to filter by. ex: 12345 (optional)
contact A contact UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional)
before Only return events created before this date, ex: 2015-01-28T18:00:00.000 (optional)
after Only return events created after this date, ex: 2015-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v2/channel_events.json
Authorization: Token
Log in to use the Explorer

    
List Contacts
GET /api/v2/contacts.json
Query String Parameters
uuid A contact UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional)
urn A contact URN to filter by. ex: tel:+250788123123 (optional)
group A group name or UUID to filter by. ex: Customers (optional)
deleted Whether to return only deleted contacts. ex: false (optional)
before Only return contacts modified before this date, ex: 2015-01-28T18:00:00.000 (optional)
after Only return contacts modified after this date, ex: 2015-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v2/contacts.json
Authorization: Token
Log in to use the Explorer

    
Add or Update Contacts
POST /api/v2/contacts.json
Query String Parameters
uuid UUID of the contact to be updated (optional)
urn URN of the contact to be updated. ex: tel:+250788123123 (optional)
Post Body Fields
name List of UUIDs of this contact's groups. (optional)
language Preferred language of the contact (3-letter ISO code). ex: fre, eng (optional)
urns List of URNs belonging to the contact. (optional)
groups List of UUIDs of groups that the contact belongs to. (optional)
fields Custom fields as a JSON dictionary. (optional)
POST https://api.textit.in/api/v2/contacts.json
Authorization: Token
Log in to use the Explorer

    
Delete Contacts
DELETE /api/v2/contacts.json
Query String Parameters
uuid UUID of the contact to be deleted (optional)
urn URN of the contact to be deleted. ex: tel:+250788123123 (optional)
DELETE https://api.textit.in/api/v2/contacts.json
Authorization: Token
Log in to use the Explorer

    
Update Multiple Contacts
POST /api/v2/contact_actions.json
Post Body Fields
contacts The UUIDs of the contacts to update (required)
action One of the following strings: add, remove, block, unblock, interrupt, archive, delete (required)
group The UUID or name of a contact group (optional)
POST https://api.textit.in/api/v2/contact_actions.json
Authorization: Token
Log in to use the Explorer

    
Export Definitions
GET /api/v2/definitions.json
Query String Parameters
flow One or more flow UUIDs to include (optional)
campaign One or more campaign UUIDs to include (optional)
dependencies Whether to include dependencies of the requested items. ex: false (optional)
GET https://api.textit.in/api/v2/definitions.json
Authorization: Token
Log in to use the Explorer

    
List Fields
GET /api/v2/fields.json
Query String Parameters
key A field key to filter by. ex: nick_name (optional)
GET https://api.textit.in/api/v2/fields.json
Authorization: Token
Log in to use the Explorer

    
Add or Update Fields
POST /api/v2/fields.json
Query String Parameters
key Key of an existing field to update (optional)
Post Body Fields
label The label of the field (required)
value_type The value type of the field (required)
POST https://api.textit.in/api/v2/fields.json
Authorization: Token
Log in to use the Explorer

    
List Flows
GET /api/v2/flows.json
Query String Parameters
uuid A flow UUID filter by. ex: 5f05311e-8f81-4a67-a5b5-1501b6d6496a (optional)
GET https://api.textit.in/api/v2/flows.json
Authorization: Token
Log in to use the Explorer

    
List Flow Starts
GET /api/v2/flow_starts.json
Query String Parameters
id Only return the flow start with this id (optional)
after Only return flow starts modified after this date (optional)
before Only return flow starts modified before this date (optional)
GET https://api.textit.in/api/v2/flow_starts.json
Authorization: Token
Log in to use the Explorer

    
Start Contacts in a Flow
POST /api/v2/flow_starts.json
Post Body Fields
flow The UUID of the flow to start (required)
groups The UUIDs of any contact groups you want to start (optional)
contacts The UUIDs of any contacts you want to start (optional)
urns The URNS of any contacts you want to start (optional)
restart_participants Whether to restart any participants already in the flow (optional)
extra Any extra parameters to pass to the flow start (optional)
POST https://api.textit.in/api/v2/flow_starts.json
Authorization: Token
Log in to use the Explorer

    
List Contact Groups
GET /api/v2/groups.json
Query String Parameters
uuid A contact group UUID to filter by (optional)
name A contact group name to filter by (optional)
GET https://api.textit.in/api/v2/groups.json
Authorization: Token
Log in to use the Explorer

    
Add or Update Contact Groups
POST /api/v2/groups.json
Query String Parameters
uuid The UUID of the contact group to update (optional)
Post Body Fields
name The name of the contact group (required)
POST https://api.textit.in/api/v2/groups.json
Authorization: Token
Log in to use the Explorer

    
Delete Contact Groups
DELETE /api/v2/groups.json
Query String Parameters
uuid The UUID of the contact group to delete (required)
DELETE https://api.textit.in/api/v2/groups.json
Authorization: Token
Log in to use the Explorer

    
List Message Labels
GET /api/v2/labels.json
Query String Parameters
uuid A message label UUID to filter by (optional)
name A message label name to filter by (optional)
GET https://api.textit.in/api/v2/labels.json
Authorization: Token
Log in to use the Explorer

    
Add or Update Message Labels
POST /api/v2/labels.json
Query String Parameters
uuid The UUID of the message label to update (optional)
Post Body Fields
name The name of the message label (required)
POST https://api.textit.in/api/v2/labels.json
Authorization: Token
Log in to use the Explorer

    
Delete Message Labels
DELETE /api/v2/labels.json
Query String Parameters
uuid The UUID of the message label to delete (required)
DELETE https://api.textit.in/api/v2/labels.json
Authorization: Token
Log in to use the Explorer

    
List Messages
GET /api/v2/messages.json
Query String Parameters
id A message ID to filter by, ex: 123456 (optional)
broadcast A broadcast ID to filter by, ex: 12345 (optional)
contact A contact UUID to filter by, ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional)
folder A folder name to filter by, one of: inbox, flows, archived, outbox, sent, incoming (optional)
label A label name or UUID to filter by, ex: Spam (optional)
before Only return messages created before this date, ex: 2015-01-28T18:00:00.000 (optional)
after Only return messages created after this date, ex: 2015-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v2/messages.json
Authorization: Token
Log in to use the Explorer

    
Update Multiple Messages
POST /api/v2/message_actions.json
Post Body Fields
messages The ids of the messages to update (required)
action One of the following strings: label, unlabel, archive, restore, delete (required)
label The UUID or name of a message label (optional)
POST https://api.textit.in/api/v2/message_actions.json
Authorization: Token
Log in to use the Explorer

    
View Current Org
GET /api/v2/org.json
GET https://api.textit.in/api/v2/org.json
Authorization: Token
Log in to use the Explorer

    
List Resthooks
GET /api/v2/resthooks.json
GET https://api.textit.in/api/v2/resthooks.json
Authorization: Token
Log in to use the Explorer

    
List Resthook Events
GET /api/v2/resthook_events.json
GET https://api.textit.in/api/v2/resthook_events.json
Authorization: Token
Log in to use the Explorer

    
List Resthook Subscribers
GET /api/v2/resthook_subscribers.json
GET https://api.textit.in/api/v2/resthook_subscribers.json
Authorization: Token
Log in to use the Explorer

    
Add Resthook Subscriber
POST /api/v2/resthook_subscribers.json
Post Body Fields
resthook The slug for the resthook you want to subscribe to (required)
target_url The URL that will be called when the resthook is triggered. (required)
POST https://api.textit.in/api/v2/resthook_subscribers.json
Authorization: Token
Log in to use the Explorer

    
Delete Resthook Subscriber
DELETE /api/v2/resthook_subscribers.json
Query String Parameters
id The id of the subscriber to delete (required)
DELETE https://api.textit.in/api/v2/resthook_subscribers.json
Authorization: Token
Log in to use the Explorer

    
List Flow Runs
GET /api/v2/runs.json
Query String Parameters
id A run ID to filter by, ex: 123456 (optional)
flow A flow UUID to filter by, ex: f5901b62-ba76-4003-9c62-72fdacc1b7b7 (optional)
contact A contact UUID to filter by, ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional)
responded Whether to only return runs with contact responses (optional)
before Only return runs modified before this date, ex: 2015-01-28T18:00:00.000 (optional)
after Only return runs modified after this date, ex: 2015-01-28T18:00:00.000 (optional)
GET https://api.textit.in/api/v2/runs.json
Authorization: Token
Log in to use the Explorer