API Explorer
All operations work against live data
List Archives
GET
/api/v2/archives.json
Query String Parameters
| archive_type | An archive_type to filter by, like: run, message (optional) |
| period | A period to filter by: daily, monthly (optional) |
GET
https://flows.weni.ai/api/v2/archives.json
Authorization:
Token
List Administrative Boundaries
GET
/api/v2/boundaries.json
GET
https://flows.weni.ai/api/v2/boundaries.json
Authorization:
Token
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://flows.weni.ai/api/v2/broadcasts.json
Authorization:
Token
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) |
POST
https://flows.weni.ai/api/v2/broadcasts.json
Authorization:
Token
List Campaigns
GET
/api/v2/campaigns.json
Query String Parameters
| uuid | A campaign UUID to filter by (optional) |
GET
https://flows.weni.ai/api/v2/campaigns.json
Authorization:
Token
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://flows.weni.ai/api/v2/campaigns.json
Authorization:
Token
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://flows.weni.ai/api/v2/campaign_events.json
Authorization:
Token
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://flows.weni.ai/api/v2/campaign_events.json
Authorization:
Token
Delete Campaign Events
DELETE
/api/v2/campaign_events.json
Query String Parameters
| uuid | The UUID of the campaign event to delete (optional) |
DELETE
https://flows.weni.ai/api/v2/campaign_events.json
Authorization:
Token
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://flows.weni.ai/api/v2/channels.json
Authorization:
Token
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://flows.weni.ai/api/v2/channel_events.json
Authorization:
Token
List Classifiers
GET
/api/v2/classifiers.json
Query String Parameters
| uuid | A classifier UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional) |
| before | Only return classifiers created before this date, ex: 2015-01-28T18:00:00.000 (optional) |
| after | Only return classifiers created after this date, ex: 2015-01-28T18:00:00.000 (optional) |
GET
https://flows.weni.ai/api/v2/classifiers.json
Authorization:
Token
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) |
| search | A contact URN to filter by. ex: tel:+250788123123 or by a contact name (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) |
| order_by | Expect a date field (created_on or modified_on) to filter, ex: order_by=created_on (optional) |
| limit | Return objects numbers according to limit, ex: limit=50 (optional) |
GET
https://flows.weni.ai/api/v2/contacts.json
Authorization:
Token
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://flows.weni.ai/api/v2/contacts.json
Authorization:
Token
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://flows.weni.ai/api/v2/contacts.json
Authorization:
Token
List Contacts(lean)
GET
/api/v2/contacts_lean.json
Query String Parameters
| uuid | A contact UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional) |
| search | A contact URN to filter by. ex: tel:+250788123123 or by a contact name (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) |
| order_by | Expect a date field (created_on or modified_on) to filter, ex: order_by=created_on (optional) |
| limit | Return objects numbers according to limit, ex: limit=50 (optional) |
GET
https://flows.weni.ai/api/v2/contacts_lean.json
Authorization:
Token
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_messages, delete, archive (required) |
| group | The UUID or name of a contact group (optional) |
POST
https://flows.weni.ai/api/v2/contact_actions.json
Authorization:
Token
List Templates for contacts
GET
/api/v2/contact_templates.json
Query String Parameters
| contact | A Contact UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional) |
| group | A Group UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (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://flows.weni.ai/api/v2/contact_templates.json
Authorization:
Token
List ElasticSearch contacts
GET
/api/v2/contacts_elastic.json
Query String Parameters
| project_uuid | Return objects from a project, ex: project_uuid=09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (required) |
| name | Only return contacts with this name, ex: name=John (optional) |
| number | Return contacts with part or literal number, ex: number=12345 (optional) |
| page_size | Only return number of contacts with this page size, ex: page_size=10 (optional) |
| page_number | Return the number of the page, ex: page_number=1 (optional) |
GET
https://flows.weni.ai/api/v2/contacts_elastic.json
Authorization:
Token
Filter Templates for contacts context
GET
/api/v2/filter_templates.json
Query String Parameters
| template | Only return contacts for this template, ex: template=template_test (optional) |
| before | Only return contacts for this template before the date, ex: before=2024-01-01 (optional) |
| after | Only return contacts for this template after the data, ex: after=2023-01-01 (optional) |
GET
https://flows.weni.ai/api/v2/filter_templates.json
Authorization:
Token
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://flows.weni.ai/api/v2/definitions.json
Authorization:
Token
List Fields
GET
/api/v2/fields.json
Query String Parameters
| key | A field key to filter by. ex: nick_name (optional) |
GET
https://flows.weni.ai/api/v2/fields.json
Authorization:
Token
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://flows.weni.ai/api/v2/fields.json
Authorization:
Token
List Flows
GET
/api/v2/flows.json
Query String Parameters
| uuid | A flow UUID filter by. ex: 5f05311e-8f81-4a67-a5b5-1501b6d6496a (optional) |
| before | Only return flows modified before this date, ex: 2017-01-28T18:00:00.000 (optional) |
| after | Only return flows modified after this date, ex: 2017-01-28T18:00:00.000 (optional) |
GET
https://flows.weni.ai/api/v2/flows.json
Authorization:
Token
List Flows Labels
GET
/api/v2/flows_labels.json
GET
https://flows.weni.ai/api/v2/flows_labels.json
Authorization:
Token
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://flows.weni.ai/api/v2/flow_starts.json
Authorization:
Token
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://flows.weni.ai/api/v2/flow_starts.json
Authorization:
Token
List Globals
GET
/api/v2/globals.json
Query String Parameters
| before | Only return globals modified before this date, ex: 2015-01-28T18:00:00.000 (optional) |
| after | Only return globals modified after this date, ex: 2015-01-28T18:00:00.000 (optional) |
| key | A global key filter by (optional) |
GET
https://flows.weni.ai/api/v2/globals.json
Authorization:
Token
Add or Update Globals
POST
/api/v2/globals.json
Query String Parameters
| key | Key of an existing global to update (optional) |
Post Body Fields
| name | the Name value of the global (optional) |
| value | the new value of the global (required) |
POST
https://flows.weni.ai/api/v2/globals.json
Authorization:
Token
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://flows.weni.ai/api/v2/groups.json
Authorization:
Token
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://flows.weni.ai/api/v2/groups.json
Authorization:
Token
Delete Contact Groups
DELETE
/api/v2/groups.json
Query String Parameters
| uuid | The UUID of the contact group to delete (required) |
DELETE
https://flows.weni.ai/api/v2/groups.json
Authorization:
Token
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://flows.weni.ai/api/v2/labels.json
Authorization:
Token
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://flows.weni.ai/api/v2/labels.json
Authorization:
Token
Delete Message Labels
DELETE
/api/v2/labels.json
Query String Parameters
| uuid | The UUID of the message label to delete (required) |
DELETE
https://flows.weni.ai/api/v2/labels.json
Authorization:
Token
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://flows.weni.ai/api/v2/messages.json
Authorization:
Token
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://flows.weni.ai/api/v2/message_actions.json
Authorization:
Token
List Products
GET
/api/v2/products.json
GET
https://flows.weni.ai/api/v2/products.json
Authorization:
Token
List Resthooks
GET
/api/v2/resthooks.json
GET
https://flows.weni.ai/api/v2/resthooks.json
Authorization:
Token
List Resthook Events
GET
/api/v2/resthook_events.json
GET
https://flows.weni.ai/api/v2/resthook_events.json
Authorization:
Token
List Resthook Subscribers
GET
/api/v2/resthook_subscribers.json
GET
https://flows.weni.ai/api/v2/resthook_subscribers.json
Authorization:
Token
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://flows.weni.ai/api/v2/resthook_subscribers.json
Authorization:
Token
Delete Resthook Subscriber
DELETE
/api/v2/resthook_subscribers.json
Query String Parameters
| id | The id of the subscriber to delete (required) |
DELETE
https://flows.weni.ai/api/v2/resthook_subscribers.json
Authorization:
Token
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://flows.weni.ai/api/v2/runs.json
Authorization:
Token
List Templates
GET
/api/v2/templates.json
Query String Parameters
| name | A template name to filter by, ex: MyTemplate (optional) |
| uuid | Only return template with this UUID (optional) |
| status | Only return templates with this status, ex: R (optional) |
GET
https://flows.weni.ai/api/v2/templates.json
Authorization:
Token
List Ticketers
GET
/api/v2/ticketers.json
Query String Parameters
| uuid | A ticketer UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional) |
| before | Only return ticketers created before this date, ex: 2015-01-28T18:00:00.000 (optional) |
| after | Only return ticketers created after this date, ex: 2015-01-28T18:00:00.000 (optional) |
GET
https://flows.weni.ai/api/v2/ticketers.json
Authorization:
Token
List Tickets
GET
/api/v2/tickets.json
Query String Parameters
| contact | A contact UUID to filter by, ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional) |
GET
https://flows.weni.ai/api/v2/tickets.json
Authorization:
Token
Update Multiple Tickets
POST
/api/v2/ticket_actions.json
Post Body Fields
| tickets | The UUIDs of the tickets to update (required) |
| action | One of the following strings: assign, add_note, change_topic, close, reopen (required) |
| assignee | The email address of a user (optional) |
| note | The note text (optional) |
POST
https://flows.weni.ai/api/v2/ticket_actions.json
Authorization:
Token
List Topics
GET
/api/v2/topics.json
GET
https://flows.weni.ai/api/v2/topics.json
Authorization:
Token
Add or Update Topics
POST
/api/v2/topics.json
Query String Parameters
| uuid | The UUID of the topic to update (optional) |
Post Body Fields
| name | The name of the topic (required) |
POST
https://flows.weni.ai/api/v2/topics.json
Authorization:
Token
List Users
GET
/api/v2/users.json
GET
https://flows.weni.ai/api/v2/users.json
Authorization:
Token
View Workspace
GET
/api/v2/workspace.json
GET
https://flows.weni.ai/api/v2/workspace.json
Authorization:
Token
List Intelligences
GET
/api/v2/intelligences.json
GET
https://flows.weni.ai/api/v2/intelligences.json
Authorization:
Token
List External Services
GET
/api/v2/external_services.json
Query String Parameters
| uuid | An external serice UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (optional) |
| before | Only return external services created before this date, ex: 2023-01-28T18:00:00.000 (optional) |
| after | Only return external services created after this date, ex: 2023-01-28T18:00:00.000 (optional) |
GET
https://flows.weni.ai/api/v2/external_services.json
Authorization:
Token
List Channel Stats
GET
/api/v2/channel_stats.json
Query String Parameters
| uuid | A channel UUID to filter by. ex: 09d23a05-47fe-11e4-bfe9-b8f6b119e9ab (required) |
GET
https://flows.weni.ai/api/v2/channel_stats.json
Authorization:
Token
List Contacts Analytics
GET
/api/v2/analytics/contacts/.json
Query String Parameters
| 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 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://flows.weni.ai/api/v2/analytics/contacts/.json
Authorization:
Token