The WiseCX API allows you to perform 'RESTful' operations such as reading, modifying, adding, or deleting data.
\nAll operations require the 'Authorization' header with the 'Bearer' token. To obtain the JWT token provided by the '/authenticate' endpoint, follow the steps below:
\nThe authentication token has a validity of 3600 seconds, and it is necessary to reauthenticate after this time has passed in order to obtain a new token.
\nThe limit is 5000 requests per minute and a total of 150000 per day, it is not possible to exceed these limits.
\nStatus code:
\n200: Success
\n400: Bad request
\n403: Unauthorized
\n501: Method not implemented
\nThis parameter indicates the fields that will be shown in the response when executing the endpoint. It is used to return only the most relevant fields. If this parameter is omitted, only default fields will be shown.
\nExample:
\n/cases?fields=id,subject,status
This parameter is used to filter and perform more advanced searches on the requested resource.
\nExample:
\n/cases?filtering=[{'field':'case.contact_id','operator':'EQUAL','value':'123'},{'field':'case.status','operator':'IN','value':['opened','solved']}]
In Postman, when using the filtering parameter directly in a URL, curly braces ({ and }) must be URL-encoded, otherwise the request may fail.
\nSo, in Postman, a properly formatted filtering request may look like this:
\nPossible operators:
\nThis parameter indicates the field and direction of sorting in which the resources will be returned. The default order is ascending (asc).
\nExample:
\n/cases?sort=desc&sort_field=id
By default, all listing operations are paginated. The maximum and default limit is set to 100 records.
\n/cases?limit=20&page=5
Authentication is necessary to obtain the JWT token, which should then be added to the request headerAuthorization to access all resources in the API.
To authenticate, you need to perform aGET method request with the x-api-key header and the user parameter. If the request is successful, it will return the JWT authentication token required to consume the API resources.
To authorize and obtain the Token, it is necessary to generate an API Key beforehand from Settings -> Channels -> API.
\n![](\"https://ss.wcx.cloud/a/08wc10/2022-03/lo4PmSYh8g.png\")
\n\nThen, you need to enter a username and finally click on the \"Generate\" button to obtain the API Key, which should be sent in the authentication call.
\n![](\"https://ss.wcx.cloud/a/08wc10/2022-03/2X3a70ijlD.png\")
\n\nThe authentication token has a validity of 3600 seconds (1 hour), and it is necessary to re-execute the authentication after this time has passed to obtain a new token.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","authenticate"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"35daeeee-1663-44a1-a9c7-31ededb4787d","name":"Authenticate","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/authenticate?user=adminUser","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","authenticate"],"query":[{"key":"user","value":"adminUser"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"637"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 08 Jan 2020 17:58:35 GMT"},{"key":"x-amzn-RequestId","value":"2b0042e9-62c9-4731-b088-df1499856359"},{"key":"x-amz-apigw-id","value":"F_i7zGktoAMF9qQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5e16184b-b1ec7f2e61557d1e203f4a36;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 171d7370ca264be0e555ac6695616d94.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"EZE51-C1"},{"key":"X-Amz-Cf-Id","value":"84lEw9XDIImZq8l0gAs8OsoQIdhE-bDvVCUmacBiYnJbzpvdSLSAJg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwidHlwIjoiSldUIn0.VpRGQx9SQXjHMDP0RlMkwBaFqbWfYf99J0Br2HsWaaPO8I7I788Bsg.e4q1pvTDetyfbLGe2k4LRw.5WNO6cp4kDv_5cg_h4FlyCrGnRcod0rvZmBLBBdcG9zvygrVFmXzyCJwzKRNWNff9V87lxImcOcxezVrUWAwj2jTtiruFhc9zd1ojHKMah2EfzQeeik7cGV7WTgavMGwHWXRjqWX-Tv-fYVJUyXG7UHJ6Qw_3yvWf1Ce6xoMJa7AuAMkHmcUUQmGszKxlDlAT9MgV-hLQNppeeq4w0f7EOHA9fsugpREdOXUL96rbHYXN177YKXaNdWqPeLhTSdNn17okIFAEyUp0On.q_r42pvbbQYvjtmjPcobpQ\",\n \"message\": \"Authentication success.\"\n}"}],"_postman_id":"96c5df8b-e29c-4dc3-a8f7-48a53c858f6f"}],"id":"7f4496be-65ef-4d1f-a7dd-650dee0a3302","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"00b270fb-2216-4e20-9c53-fd8620c0ef1c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"706f5c36-1364-4bf8-9387-b78672303f3d"}}],"_postman_id":"7f4496be-65ef-4d1f-a7dd-650dee0a3302","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}}},{"name":"Cases","item":[{"name":"Types","item":[{"name":"Type Retrieval","id":"c7245335-f13a-443a-ac0b-7b2d5b011dc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/cases/types","description":"For retrieving the list of types, you need to perform aGETrequest and specify the desired fields using the fieldsparameter. The possible fields are:
id,name,parent_id
Endpoint types allows to obtain type lists from WiseCX.
For retrieving the list of tags, you need to perform a GET method request and specify desired fields using the 'fields' parameter. The possible fields are:
id,name
The tags endpoint allows retrieving the list of WiseCX labels.
For creating a new case, you need to perform aPOSTmethod request with the following object:
Theactivityobject should be sent as follows:
Object contact:
Objecttemplate:
Objecttemplate_parameter:
Object custom_fields:
Object attachments:
In case of sending theattachmentsobject with the content field, the sum of the files sent in the same request must not exceed 5MB.
contacts_to.source_channel should be Whatsapp and should include atemplateobject in a type user_reply activity. The user_id should be a valid user or leave it at \"0\" if you want the client's response to normally enter the queues.user_reply and it is no longer necesarry to include the templateobject except thecontent.Updating a new Case allows adding new activities to an existing Case and also editing its fields, for this a PUTmethod must be executed with the following object:
The activity object shoud be sent as follows:
Object contact:
Object template:
Object template_parameter:
Object custom_fields:
Object attachments:
contacts_to.contact_toobject is the same one that started the conversation.To obtain the list of Cases, a GET method must be performed indicating the required fieldsthrough the fields parameter.
\n\nIMPORTANT:
\n
Through this endpoint it is only possible to obtain the cases from the last 3 months onwards.
Possible fields are:
\nALLOWED OPERATORS
\nTo see more examples, check Filtros.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","cases"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"9e41e636-928d-46fb-8a7c-a13063be5540","name":"Obtención de Casos","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/cases?fields=id,subject,group_id,user_id,created_at","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","cases"],"query":[{"key":"fields","value":"id,subject,group_id,user_id,created_at"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1273952,\n \"group_id\": 1234,\n \"user_id\": 0,\n \"subject\": \"Caso desde api 1\",\n \"created_at\": \"2020-01-28 18:48:38\"\n },\n {\n \"id\": 1273951,\n \"group_id\": 1234,\n \"user_id\": 0,\n \"subject\": \"Caso desde api 2\",\n \"created_at\": \"2020-01-28 18:45:43\"\n },\n {\n \"id\": 1273950,\n \"group_id\": 1234,\n \"user_id\": 0,\n \"subject\": \"Caso desde api 3\",\n \"created_at\": \"2020-01-28 18:39:42\"\n }\n]"}],"_postman_id":"7c2a51d6-d2ef-4d19-81ea-2d7f6cafa793"},{"name":"Obtaining Case by ID","id":"7652de30-4cd4-403c-8c9b-22440ced9e15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/cases/{{id}}","description":"To obtain the details of a Case, aGET method must be executed indicating the fields that are required through the fields parameter. The possible fields are:
id,number,group_id,user_id,contact_id,status,source_channel,tags,type_id,subject,priority,due_at,custom_fields,created_at,solved_at,closed_at,last_update,channel_account,bot_resolved,bot_attended,summary
To delete the detail of a Case, a DELETE method must be performed indicating the case ID to be deleted.
To obtain the list of Activities associated with a Case, a GET method must be executed indicating thefieldsthat are required using the fields parameter. The possible fields are:
id,case_id,type,user_id,channel,content,contact_from,contacts_to,attachments,recordings,created_at,sending_status
To obtain a particular activity, associated with a Case, aGETmethod must be performed forming the URL of the endpoint with the Case ID and the Activity ID.
The fields that are required must be indicated by means of thefieldsparameter. The possible fields are:
id,case_id,type,user_id,channel,content,contact_from,contacts_to,attachments,recordings,created_at,sending_status
Endpoint cases allows to create, update and obtain WiseCX cases.
To obtain the list of Organizations, a GET method must be performed indicating the fields that are required through the fields parameter. The possible fields are:
id,custom_id,name
ALLOWED OPERATORS
\nTo see more examples, see Filtros.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","contacts","organizations"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"d5995ae0-d4dd-4188-a9a2-cc04a18cbf83","name":"Obtención de Organizaciones","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/contacts/organizations?fields=id,custom_id,name","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","contacts","organizations"],"query":[{"key":"fields","value":"id,custom_id,name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 14,\n \"custom_id\": \"1234\",\n \"name\": \"Test Organización 01\"\n },\n {\n \"id\": 15,\n \"custom_id\": \"1431\",\n \"name\": \"Test Organización 02\"\n },\n {\n \"id\": 16,\n \"custom_id\": \"6789\",\n \"name\": \"Test Organización 03\"\n }]\n}"}],"_postman_id":"ee57af6a-c49a-4da0-8912-5dfea7849575"},{"name":"Organization Creation","id":"b4fa17f1-2cfd-4fb8-94d6-cd93bc7653a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/contacts/organizations/","description":"To create a new Organization, aPOSTmethod must be executed with the following object:
To update an Organization, a PUT method must be executed with the following object:
To remove an organization, a DELETE method must be performed indicating Organization's ID to delete.
The endpoint organizationsallows obtaining WiseCX organizations list.
To get a group list, a GET method must be performed indicatind through the parameter required fields. Possible fields are:
id,code,name
To see examples, check Filtros.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","contacts","groups"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"df47b29d-6257-4dff-834a-b6567f6bdf24","name":"Obtención de Grupos","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/contacts/groups?fields=id,code,name","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","contacts","groups"],"query":[{"key":"fields","value":"id,code,name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 389,\n \"code\": \"BKA0389\",\n \"name\": \"Group 01\"\n },\n {\n \"id\": 390,\n \"code\": \"SRI0390\",\n \"name\": \"Group 02\"\n },\n {\n \"id\": 391,\n \"code\": \"OXC0391\",\n \"name\": \"Group 03\"\n }]\n}"}],"_postman_id":"03e08536-3790-4f19-8aac-811465731897"},{"name":"Group Creation","id":"bcfce5b8-534a-48ce-9ab6-1fa9a341dc0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/contacts/groups/","description":"For creating a new Group, a POST method must be done with the following object:
For inserting an existing Contact to a Group, aPUT method must be executed indicating in the URL path the contact ID and the group ID as appropriate.
For deleting a Contact from a Group, a DELETE method must be made indicating in the URL path the ID Contact and the ID Group as appropiate.
The endpoint groups allows operating with the Contact Groups of Wise CX.
To create a new Contact, aPOSTmethod must be performed with the following object:
Objectcustom_fields:
To update a Contact, a PUT method must be sent with the following object:
Object custom_fields:
To obtain the list of Contacts, a GET must be done indicating the required fields through the fields parameter. The possible fields are:
To check more examples see Filtros.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","contacts",""],"host":["api","wcx","cloud"],"query":[{"key":"fields","value":"id,email,personal_id,phone,name,custom_fields,last_update"},{"key":"limit","value":"100"},{"key":"page","value":"80"}],"variable":[]}},"response":[{"id":"4fdc63a7-abfa-410a-9d80-c6e438498ca0","name":"Obtenención de Contactos","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/contacts/?fields=id,personal_id&sort=desc&sort_field=id&limit=5&page=1","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","contacts",""],"query":[{"key":"fields","value":"id,personal_id"},{"key":"sort","value":"desc"},{"key":"sort_field","value":"id"},{"key":"limit","value":"5"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 6594517,\r\n \"personal_id\": \"\"\r\n },\r\n {\r\n \"id\": 6594516,\r\n \"personal_id\": \"3279964888\"\r\n },\r\n {\r\n \"id\": 6594515,\r\n \"personal_id\": \"812737-7787987987\"\r\n },\r\n {\r\n \"id\": 6594514,\r\n \"personal_id\": \"8127377787987987\"\r\n },\r\n {\r\n \"id\": 6594513,\r\n \"personal_id\": \"7787987987\"\r\n }\r\n ],\r\n \"paging\": {\r\n \"next\": \"https://api.wcx.cloud/core/v1/contacts/v1/contacts/?fields=id,personal_id&limit=5&page=2&sort=desc&sort_field=id\",\r\n \"page\": 2,\r\n \"limit\": 5\r\n }\r\n}"}],"_postman_id":"03087997-09c4-4f1d-8434-f76e09f86c26"},{"name":"Fetching Contact by ID","id":"90347891-d6ad-4d61-83dc-d2fb30949d3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/contacts/{{id}}","description":"To obtain the detail of a Contact, a GET method must be made indicating the fields that are required by means of the fields parameter. The possible fields are:
id,email,personal_id,phone,name,guid,password,custom_fields,last_update
To delete a Contact, a DELETE method must be made indicating the ID of the contact to be deleted.
The contacts endpoint allows managing WiseCX contacts.
To obtain the list of Service Groups, a GET method must be executed. The default fields returned are: id,name,businessHours,users.
You can use the fields parameter to request a subset of fields (e.g. ?fields=id,name,users).
businessHours structureusers structureCreates a new service group allowing to associate users and define whether each one has automatic assignment.
\nResponse: { \"data\": { \"id\": <new_group_id> } } — HTTP 200
To obtain the details of a Service Group, a GET method must be executed indicating the group ID in the URL.
The default fields returned are: id,name,businessHours,users
You can use the fields parameter to request a subset of fields (e.g. ?fields=id,name,users).
businessHours structureusers structureTo assign or update users in a Service Group, a PUT method must be executed indicating the group ID in the URL and sending an array of user objects.
If the list is empty, a summary with all counters at 0 is returned without making any changes.
\nThe response includes a summary with the number of users added, updated and unchanged.
To remove a user from a Service Group, a DELETE method must be executed indicating the group ID and the user ID in the URL.
Returns HTTP 204 No Content if the operation was successful.
To remove multiple users from a Service Group in a single operation, a DELETE method must be executed indicating the group ID in the URL and sending the following object:
Response: { \"data\": { \"removed\": N } } — HTTP 200
To obtain an Open Business, a GET method must be executed. The queue_id parameter can be sent as optional.
The endpoint queues allows obtaining, creating and managing WiseCX Service Groups.
To retrieve the list of Users, make a GET request indicating the required fields via the fields parameter. The possible fields are:
id,user_name,nick,first_name,last_name,is_bot,created_at,last_login,queues
The queues field returns the list of Service Groups the user belongs to. Each object contains:
To retrieve the details of a User, make a GET request with the user id in the URL.
Returned fields: id,user_name,nick,first_name,last_name,is_bot,created_at,last_login,queues
The queues field returns the list of Service Groups the user belongs to, with id, name and auto_assign per group.
To create a new User, make a POST request with the following body:
To assign Service Groups to a User, make a PUT request with the user id in the URL and a list of group objects:
To remove Service Groups from a User, make a DELETE request with the user id in the URL and the following body:
The users endpoint allows retrieving, creating and managing Users in Wise CX, including assigning and removing Service Groups.
To export a list report, execute a POST method indicating the id of the report to download in the URL path.
\nNOTE: It is only possible to download 3 reports simultaneously.
\nThe filter object:
Validation rules for filter:
date_from and date_to must be provided together.date_to must be greater than or equal to date_from.Use the returned export_id to check the export status via GET /v1/analytics/export/{export_id}/status.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","analytics","export","{{id}}"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"574b37e5-2084-45b6-be7c-0e11802d88a9","name":"Iniciar Descarga de Reporte por id","originalRequest":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/analytics/export/6541"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"export_id\": \"5a97c4b0582d4076a5c4e2a4455666e9\",\n \"status\": \"processing\",\n \"progress\": 0,\n \"report_url\": null\n}"}],"_postman_id":"9a1bd03d-0794-49f3-b20c-cf779f130fe7"},{"name":"Fetching Download Status by export_id","id":"7fc3955f-432a-4d84-8b49-a3e32f0ef965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/analytics/export/{{export_id}}/status","description":"To check the status of an export, execute a GET method indicating the export_id returned by the POST /v1/analytics/export/{id} endpoint.
\nEndpoint analytics allows you to start and check the status of a report downloading.
Only reports of the list type are allowed to be downloaded. Dashboards Downloading is not allowed.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"56d88e7b-5f61-4b6d-bddc-baa4f01ea297"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"63802737-5786-47a6-9b3e-c65f635483f9"}}],"_postman_id":"21d29096-eaa0-4a57-8cd0-7a4bfb28fe32","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}}},{"name":"Surveys","item":[{"name":"Fetching Surveys","id":"62111917-86b0-4f42-8cb7-f692316ddef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/surveys","description":"To obtain a list of surveys you must perform a GET method.
To obtain a list of the questions in a survey, you must perform a GET request providing the survey id.
To obtain a list of survey responses, a GET method must be executed indicating the ID of the survey. The limit parameter can be sent as optional to determine the number of items per page and the page parameter for the positioned page.
ALLOWED OPERATORS
\nTo see more examples, check Filtros.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","surveys","{id}","responses"],"host":["api","wcx","cloud"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"80"}],"variable":[]}},"response":[{"id":"ed5e1fe6-7a8d-424f-81b2-643f16e4310f","name":"Obtención de Respuestas de Encuestas","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/surveys/{id}/responses?&limit=2&page=20","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","surveys","{id}","responses"],"query":[{"key":null,"value":null},{"key":"limit","value":"2"},{"key":"page","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"response_id\": 525,\n \"survey_id\": 4,\n \"case_id\": 57394656,\n \"status\": \"not_responded\",\n \"answers\": [],\n \"contact_id\": 6541872,\n \"sent_at\": \"2021-11-04T12:30:00Z\",\n \"responded_at\": \"1900-01-01T00:00:00\"\n },\n {\n \"response_id\": 189,\n \"survey_id\": 4,\n \"case_id\": 52534635,\n \"status\": \"responded\",\n \"answers\": [\n { \"question_id\": \"a2cde820cfec11e3b3be7d1907d92b49\", \"question_type\": \"rating\", \"value\": 8 },\n { \"question_id\": \"a2cde820cfec11e8b3be7d1907d92b49\", \"question_type\": \"rating\", \"value\": 3 },\n { \"question_id\": \"a2cf4c7bcfec11e3b38e7d1907d92b49\", \"question_type\": \"boolean\", \"value\": false }\n ],\n \"contact_id\": 6523860,\n \"sent_at\": \"2021-11-04T12:30:00Z\",\n \"responded_at\": \"2021-11-04T12:33:37\"\n }\n ],\n \"paging\": {\n \"next\": \"https://api.wcx.cloud/core/v1/surveys/4/responses?limit=2&page=21\",\n \"page\": 3,\n \"limit\": 2\n }\n}"}],"_postman_id":"493b5858-e39f-4906-b4f2-7147abbca295"}],"id":"a777a528-e914-49fc-bb69-4e0e9cb50b1f","description":"The endpoint surveys allows you to obtain lists and results of surveys.
To asynchronously execute an intention of a previously configured flow of the wizard, a POST method must be performed indicating the id of the intention. In the body, the context parameter is optional.
The endpoint assistants allows you to asynchronously execute an intent from a previously configured assistant's flow.
To create a new order, you need to make aEndFragment POSTwith the following object:
Customer Object:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","orders"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"9711b4fe-a5fb-4506-8385-bca735b4c1a9","name":"Order Creation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ecommerce_store_id\": \"store-08wc10clz4\",\r\n \"ecommerce_platform\": \"custom\",\r\n \"ecommerce_order_id\": \"123a456b\",\r\n \"status\": \"cancelled\",\r\n \"reject_reason\":\"Tarjeta sin fondos\",\r\n \"total_amount\": 466.50,\r\n \"sales_recovery\": true,\r\n \"customer\":{\r\n \"name\": \"test\",\r\n \"email\": \"test@gmail.com\",\r\n \"phone\": \"1234512345\",\r\n \"personal_id\": \"123123\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.wcx.cloud/core/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 7387492,\n \"message\": \"{\\\"id\\\":7387492}\"\n}"}],"_postman_id":"cdd21c24-894d-41b9-a12e-e55484366abe"},{"name":"Order updated by ID","id":"46e068b1-dc3f-481c-b046-0431591dc738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n \"reject_reason\":\"Sin Stock\",\r\n \"sales_recovery\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.wcx.cloud/core/v1/orders/{{id}}","description":"To update an order, a PUT method must be executed with the next object:
Customer Object:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","orders","{{id}}"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"ae8e4c60-a57b-4997-b06e-e32924f530de","name":"Order updating by ID","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"reject_reason\":\"Sin Stock\",\r\n \"sales_recovery\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.wcx.cloud/core/v1/orders/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 7387474,\n \"message\": \"{\\\"id\\\":7387474}\"\n}"}],"_postman_id":"46e068b1-dc3f-481c-b046-0431591dc738"},{"name":"Orders Retrieval","id":"6f179c1c-219a-41c2-95d9-96aad1c61bb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/orders","description":"To obtain the list of orders, you need to perform a GET request and specify the desired fields using the fields parameter.
Possible fields are:
\nid,ecommerce_store_id,ecommerce_platform,ecommerce_order_id,status,reject_reason,total_amount,sales_recovery,customer,created_at,updated_at,order_data
ALLOWED OPERATORS
\nTo see examples, check Filters.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","orders"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"e2292dbc-9c79-40f2-b8b1-f569ef153648","name":"Orders Retrieval","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/orders?fields=id,status,customer,created_at","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","orders"],"query":[{"key":"fields","value":"id,status,customer,created_at"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1001,\n \"status\": \"pending\",\n \"customer\": {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"+1234567890\",\n \"personal_id\": \"12345678\"\n },\n \"created_at\": \"2024-03-15 10:30:00\"\n },\n {\n \"id\": 1002,\n \"status\": \"confirmed\",\n \"customer\": {\n \"name\": \"Jane Smith\",\n \"email\": \"janesmith@example.com\",\n \"phone\": \"+0987654321\",\n \"personal_id\": \"87654321\"\n },\n \"created_at\": \"2024-03-14 08:15:00\"\n }\n]"}],"_postman_id":"6f179c1c-219a-41c2-95d9-96aad1c61bb3"}],"id":"8fc7e488-bf4f-4552-9e16-457c23a52b17","description":"The orders endpoint allows creating, updating, and retrieving ecommerce orders such as Vtex, Shopify, WooCommerce, Phoenician, and Custom (any ecommerce integrated with Wise through the 'Custom e-com' channel).
To obtain the Mercado Libre's Order detail, a GET method must be made indicating the wisecx_order_id.
The JSON response indicates in the order_data field all the information obtained from Mercado Libre.
To obtain the list of Templates, a GET method must be sent indicating the fields that are required through the fields parameter. The possible fields are:
template_id,content,name,whatsapp_number,whatsapp_description
The whatsapp_templates endpoint allows obtaining the list of WhatsApp Templates loaded in the WiseCX account.
A Webhook in WiseCX is a message or packet sent to an external system that contains information inherent to the channel or event that triggers it.
\nBy subscribing to WiseCX Webhooks, external systems are notified of events that occur in real time and can react and perform tasks accordingly.
\nFrom Channels | Settings, add a new Webhooks channel:
\nFill required fields.
\nPublic URL for events reception.
\nService Groups: Subscribe to events that happen only in cases of specific service groups.
\nActivate the New Activity selector.
\nWiseCX will notify the configured URL of all case events belonging to the selected care groups. Events can be:
\nCase creation.
\nNew messages within the case.
\nReadings, status changes, automations or group transfers.
\nThe webhook sent by WiseCX is a JSON format with the following structure:
\n{\n \"event\": \"[activity_new | status_update | survey]\",\n \"case_id\": 12345,\n \"activity_id\": 6789,\n \"activity_type\":[contact_message | user_reply | note | system | whatsapp_status]\n}\n\nIn case of a survey type event, the structure is as follows:
\n{\n \"event\": \"survey\",\n \"case_id\": 12345,\n \"url_survey\":\"https://wcentrix.net/pub/survey.html#?survey=87e9r8bfje4w7er4192b4ff548c67c468gh=RMSW016-3512649&c_resp=123\"\n}\n\nIn case of a meli event type, the structure is as follows:
\n{\n \"id\": wcx_order_id,\n \"event\": [\"meli_order_updated\"|\"meli_new_order\"]\n}\n\nIMPORTANT: The received payload only includes basic event information. To access more information about the particular event, after receiving the webhook, an additional call must be performed to the corresponding endpoint to obtain the content and complete object information.
\nDETAIL event
\nDETAIL activity_type
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7256eff3-f940-409e-bee1-87064a4e95de"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"fdb6ea08-e8ac-4bfa-a8cf-3eff3c37b986"}}],"_postman_id":"d8606e8f-a15c-48ac-85a5-5a79053dee01"},{"name":"Nitro","item":[{"name":"Actions","item":[{"name":"Schedule Campaign Send","id":"d365bd69-a2f8-4667-a735-e604f5c0e542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"scheduled_at\": \"2026-04-01 10:00:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/{{campaign_id}}/actions/schedule","description":"Schedules a bulk Campaign to be sent at a future date and time. Make a POST request with the campaign_id in the URL. Operates on all active messages of the campaign.
\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","campaigns","{{campaign_id}}","actions","schedule"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"dd8c720c-bde8-4b2e-b05b-40867b17eb6f","name":"Schedule Campaign Send","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"scheduled_at\": \"2026-04-01 10:00:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/1321/actions/schedule"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": 1321,\n \"status\": \"scheduled\",\n \"scheduled_at\": \"2026-04-01 13:00:00\"\n}"}],"_postman_id":"d365bd69-a2f8-4667-a735-e604f5c0e542"},{"name":"Send Campaign Immediately","id":"fb8396a3-8668-4a83-9bf3-13642a6bb00d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/{{campaign_id}}/actions/send","description":"Only available for
\nsimple(bulk) campaigns. For transactional campaigns, use theactivateaction.
Sends a bulk Campaign immediately, without specifying a send date. Make a POST request with the campaign_id in the URL. Operates on all active messages of the campaign.
\n\nOnly available for
\nsimple(bulk) campaigns. To schedule a future send, use thescheduleaction.
This endpoint does not require a body.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","campaigns","{{campaign_id}}","actions","send"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"7f2ddc28-08ec-459c-b111-592670f63703","name":"Send Campaign Immediately","originalRequest":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/1321/actions/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": 1321,\n \"status\": \"processing\"\n}"}],"_postman_id":"fb8396a3-8668-4a83-9bf3-13642a6bb00d"},{"name":"Activate Transactional Campaign","id":"80180424-3169-44eb-93b3-7e57be63aa97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/{{campaign_id}}/actions/activate","description":"Activates a transactional Campaign so it starts processing sends. Make a POST request with the campaign_id in the URL. Operates on all active messages of the campaign.
\n\nOnly available for
\ntransactionalcampaigns. Requires the campaign and all its messages to be indraftorstoppedstate.
This endpoint does not require a body.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","campaigns","{{campaign_id}}","actions","activate"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"861843a7-966c-45f9-9c45-941ac1916f6f","name":"Activate Transactional Campaign","originalRequest":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/1321/actions/activate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": 1321,\n \"status\": \"running\"\n}"}],"_postman_id":"80180424-3169-44eb-93b3-7e57be63aa97"},{"name":"Stop Transactional Campaign","id":"854fa7be-8e08-4427-ba1f-ab0f0dc0c8c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/{{campaign_id}}/actions/stop","description":"Stops a transactional Campaign that is currently running. Make a POST request with the campaign_id in the URL. Operates on all active messages of the campaign.
\n\nOnly available for
\ntransactionalcampaigns inrunningstate. To resume the send, use theactivateaction.
This endpoint does not require a body.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","campaigns","{{campaign_id}}","actions","stop"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"51381127-86e6-46a4-948a-b2123e935723","name":"Stop Transactional Campaign","originalRequest":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/1321/actions/stop"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": 1321,\n \"status\": \"stopped\"\n}"}],"_postman_id":"854fa7be-8e08-4427-ba1f-ab0f0dc0c8c1"},{"name":"Delete Campaign","id":"4bc87614-dc12-479d-8df1-9c73782fc48a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/{{campaign_id}}/actions/delete","description":"Deletes a Campaign. Make a POST request with the campaign_id in the URL.
\n\nAvailable for
\nsimple(bulk) campaigns indraftstate, and fortransactionalcampaigns indraftorstoppedstate.
This endpoint does not require a body.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","campaigns","{{campaign_id}}","actions","delete"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"a663bf77-7304-4171-8f4d-03c401242121","name":"Delete Campaign","originalRequest":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/1321/actions/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": 1321,\n \"status\": \"deleted\"\n}"}],"_postman_id":"4bc87614-dc12-479d-8df1-9c73782fc48a"},{"name":"Cancel Campaign Send","id":"7311ae57-8870-45b8-be86-9f2aeda11245","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/{{campaign_id}}/actions/cancel-send","description":"Cancels an ongoing send of a bulk Campaign. Make a POST request with the campaign_id in the URL. Operates on all active messages of the campaign.
\n\nOnly available for
\nsimple(bulk) campaigns. The campaign must be inrunningorscheduledstate, and messages inpreparing,sendingorscheduledstate.
This endpoint does not require a body.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","campaigns","{{campaign_id}}","actions","cancel-send"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"235bc63d-5eda-4eae-a8fa-0033a2488caf","name":"Cancel Campaign Send","originalRequest":{"method":"POST","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns/1321/actions/cancel-send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": 1321,\n \"status\": \"cancelled\"\n}"}],"_postman_id":"7311ae57-8870-45b8-be86-9f2aeda11245"}],"id":"b984607d-ab76-4258-8196-b6ea797b09d5","description":"The Actions folder groups the available actions to execute on a Nitro Campaign. All actions are invoked via POST to the route /v1/nitro/campaigns/{campaign_id}/actions/{action} and operate on all active messages of the campaign.
To send a message in a transactional campaign, you need to perform a POST method with the next object:
IMPORTANT: regarding to the dictionary variables, META's API considers the order/position in which the variables are sent and NOT their names.
For example, if a template has the following text: \"Hello {{1}}, thank you for your purchase! The tracking number is: {{2}}\", a request must be sent to our API containing the variables dictionary with the name first and the tracking ID second.
\nThe objectcontactshould be sent in the following manner:
Usage Specifications:
\n1. Before using this endpoint, the transactional campaign must be created, and the identifier (ID) of the campaign must be known.
\n2. To obtain company ID, we need to access Nitro module, where we have two options:
\n3. The campaign must be in an Active state and correctly configured for the defined channels.
\n4. To send the message through this endpoint, the following specifications must be taken into account:
\nThe channels field is a list of available channels for use in the Nitro module, for example: WhatsApp, Email, SMS, Calls.
\nIn the contact object, 'ID' is the identifying field of the contact. If this field is completed, it is not necessary to fill in the 'Email', 'personal_id', or 'phone' fields.
\nIn the contact object, if the 'ID' field is not completed, at least one of the three identification fields must be completed.
\nIf the specified channel is WhatsApp, call, or SMS, filling in the 'phone' field in the contact object is mandatory.
\nIf the specified channel is Email, filling in the email field in the contact object is mandatory.
\nTo send a message in a transactional campaign bulk, you need to perform a POST method with the next object in a LIST format:
IMPORTANT: regarding to the dictionary variables, META's API considers the order/position in which the variables are sent and NOT their names.
For example, if a template has the following text: \"Hello {{1}}, thank you for your purchase! The tracking number is: {{2}}\", a request must be sent to our API containing the variables dictionary with the name first and the tracking ID second.
\nThe objectcontactshould be sent in the following manner:
Usage Specifications:
\nSame as detailed in Transactional Message endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","transactional","send"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"bda5ea8c-3e13-4be6-b09b-5f26a176a672","name":"Transactional Campaign - Send Message Bulk","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"channels\": [\r\n \"whatsapp\"\r\n ],\r\n \"campaign_id\": 1321,\r\n \"contact\": {\r\n \"phone\": \"5493517606060\"\r\n },\r\n \"variables\": {\r\n \"{1}\": \"\",\r\n \"{2}\": \"\"\r\n },\r\n \"metadata\": {\r\n \"tracking_id\": \"ASD-9843\",\r\n \"project_area\": \"Marketing\"\r\n }\r\n },\r\n {\r\n \"channels\": [\r\n \"whatsapp\"\r\n ],\r\n \"campaign_id\": 1322,\r\n \"contact\": {\r\n \"phone\": \"5493517382938\"\r\n },\r\n \"variables\": {\r\n \"{1}\": \"\",\r\n \"{2}\": \"\"\r\n },\r\n \"metadata\": {\r\n \"tracking_id\": \"FDD-3847\",\r\n \"project_area\": \"Finance \"\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://api.wcx.cloud/core/v1/nitro/transactional/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"channel\": \"whatsapp\",\n \"status\": \"queued\",\n \"contact\":{\n \"id\": 89238,\n \"phone\": \"5493517606060\"\n },\n \"description\": \"\",\n \"tracking_id\": 1\n },\n {\n \"channel\": \"whatsapp\",\n \"status\": \"queued\",\n \"contact\":{\n \"id\": 89239,\n \"phone\": \"5493517382938\"\n },\n \"description\": \"\",\n \"tracking_id\": 1\n }\n]"}],"_postman_id":"54384586-5185-43ba-9b10-f4bb41575764"},{"name":"Request detail by tracking id","id":"e9f16696-dbfb-4652-be3c-88e392e44459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/transactional/requests/{{tracking_id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}},"urlObject":{"protocol":"https","path":["core","v1","nitro","transactional","requests","{{tracking_id}}"],"host":["api","wcx","cloud"],"query":[],"variable":[]}},"response":[{"id":"aa2e1dcf-b06c-4c95-a7b4-d90b260fb6de","name":"Get request detail","originalRequest":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/transactional/requests/em-340"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"case\": {\n \"id\": 1328784,\n \"number\": \"6544\"\n },\n \"contact\": {\n \"id\": \"19090509\",\n \"email\": \"julio.p@wisecx.com\"\n },\n \"variables\": {\n \"{id_tyt}\": \"12321876123876\",\n \"{location}\": \"ARG\"\n },\n \"metadata\": {\n \"id_tyt\": \"CU1567894654653AR\",\n \"id_mensaje\": \"123456789\"\n }\n}"}],"_postman_id":"e9f16696-dbfb-4652-be3c-88e392e44459"},{"name":"Get Campaigns","id":"e4c17282-0c2c-4867-a748-b5ef5d1fcb17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/nitro/campaigns?page=1&limit=10","description":"To retrieve the list of Nitro Campaigns, make a GET request.
Supports pagination and filtering via page, limit, sort_by, sort_order and filtering parameters.
Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of results per page
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"3a75a056-a401-4972-82ed-b3660da353dc","name":"Get Campaigns","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/nitro/campaigns?page=1&limit=10","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","nitro","campaigns"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"414\",\n \"name\": \"Winter Promotion Campaign\",\n \"type\": \"simple\",\n \"status\": \"draft\",\n \"created_at\": \"2026-03-05 11:57:17\",\n \"updated_at\": \"2026-03-05 11:57:17\",\n \"scheduled_at\": \"\",\n \"messages\": [\n {\n \"id\": \"685\",\n \"channel\": \"whatsapp\",\n \"status\": \"draft\",\n \"scheduled_at\": \"\",\n \"sent_at\": \"\",\n \"stats\": {\n \"total\": 0,\n \"sent\": 0,\n \"delivered\": 0,\n \"opened\": 0,\n \"clicked\": 0,\n \"replied\": 0,\n \"failed\": 0,\n \"bounced\": 0,\n \"unsubscribed\": 0\n },\n \"channel_config\": {\n \"template_id\": \"40184\",\n \"template_name\": \"winter_promo\",\n \"language\": \"en\"\n }\n }\n ]\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"page_size\": 10,\n \"total_items\": 100,\n \"total_pages\": 10\n }\n}"}],"_postman_id":"e4c17282-0c2c-4867-a748-b5ef5d1fcb17"},{"name":"Create Campaign","id":"2de74473-f6d1-4727-8d6d-58d7addcaec0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Welcome Campaign\",\r\n \"type\": \"simple\",\r\n \"description\": \"Welcome message for new customers\",\r\n \"groups_ids\": \"123,456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.wcx.cloud/core/v1/nitro/campaigns","description":"To create a new Nitro Campaign, make a POST request with the following body:
To retrieve the details of a Nitro Campaign, make a GET request with the campaign_id in the URL.
To update a Nitro Campaign, make a PUT request with the campaign_id in the URL.
To create a Message inside a Nitro Campaign, send a POST request to /v1/nitro/campaigns/{campaign_id}/messages.
campaign_idchannel, channel_config\n\nChannel restriction:
\ntransactionalcampaigns.
channel_config)channel_config)channel_config)reply_type conditional matrix{\n \"channel\": \"whatsapp\",\n \"channel_config\": {\n \"template_id\": \"40184\",\n \"variables\": [\n {\n \"name\": \"{1}\",\n \"value_from\": \"name\",\n \"value_default\": \"Customer\"\n }\n ],\n \"reply_type\": \"group\",\n \"reply_id\": 123\n }\n}\n{\n \"channel\": \"email\",\n \"scheduled_at\": \"2026-04-01 10:00:00\",\n \"channel_config\": {\n \"from_email\": \"noreply@yourdomain.com\",\n \"subject\": \"Welcome to WiseCX\",\n \"email_content\": \"<html><body><h1>Hello {{contact_name}}</h1></body></html>\",\n \"headers\": [\n {\n \"key\": \"X-Custom-Source\",\n \"value\": \"api\"\n }\n ]\n }\n}\nCall
\n{\n \"channel\": \"call\",\n \"channel_config\": {\n \"call_number_id\": 456,\n \"reply_type\": \"ivr\",\n \"reply_id\": 12,\n \"only_when_available\": true,\n \"only_business_hours\": false,\n \"simultaneous_calls\": 3\n }\n}\nTo update a Message in a Nitro Campaign, send a PUT request to /v1/nitro/campaigns/{campaign_id}/messages/{message_id}.
campaign_id, message_id\n\n\n
channelis immutable after creation. Do not sendchannelin update payloads.Channel restriction:
\ntransactionalcampaigns.
channel_config)channel_config)channel_config)reply_type conditional matrix{\n \"channel_config\": {\n \"template_id\": \"40200\",\n \"variables\": [\n {\n \"name\": \"{1}\",\n \"value_from\": \"customer_name\",\n \"value_default\": \"Customer\"\n }\n ],\n \"reply_type\": \"assistant\",\n \"reply_id\": 38,\n \"reply_node\": \"inicio\"\n }\n}\n{\n \"scheduled_at\": \"2026-04-02 11:30:00\",\n \"channel_config\": {\n \"from_email\": \"noreply@yourdomain.com\",\n \"subject\": \"Updated promotion\",\n \"email_content\": \"<html><body><p>Hi {{contact_name}}, this is an update.</p></body></html>\",\n \"headers\": [\n {\n \"key\": \"X-Campaign-Version\",\n \"value\": \"v2\"\n }\n ]\n }\n}\nCall
\n{\n \"channel_config\": {\n \"call_number_id\": 456,\n \"reply_type\": \"group\",\n \"reply_id\": 45,\n \"only_when_available\": false,\n \"only_business_hours\": true,\n \"simultaneous_calls\": 2\n }\n}\nTo retrieve the Contacts associated with a Campaign Message, make a GET request with campaign_id and message_id in the URL.
Supports pagination and filtering via page, limit, sort_by, sort_order and filtering parameters.
Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of results per page
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"d8901c7a-6dc7-4eed-b2d1-adf92a9a7dc3","name":"Get Campaign Message Contacts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.wcx.cloud/core/v1/nitro/campaigns/1321/messages/msg-abc123/contacts?page=1&limit=10","protocol":"https","host":["api","wcx","cloud"],"path":["core","v1","nitro","campaigns","1321","messages","msg-abc123","contacts"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"tracking_id\": \"wa_3264\",\n \"contact_id\": \"19372467\",\n \"phone\": \"5493533683773\",\n \"channel\": \"whatsapp\",\n \"status\": \"sent\",\n \"created_at\": \"2026-03-04 20:00:03\",\n \"case_id\": 0,\n \"channel_detail\": {\n \"whatsapp_id\": \"98e04e8f-c159-4c7f-9d68-de7d5659e536\",\n \"sent_at\": \"2026-03-04 20:00:05\",\n \"delivered_at\": \"\",\n \"last_open_date\": \"\",\n \"last_click_date\": \"\"\n }\n },\n {\n \"tracking_id\": \"wa_3265\",\n \"contact_id\": \"19276265\",\n \"phone\": \"541156929370\",\n \"channel\": \"whatsapp\",\n \"status\": \"sent\",\n \"created_at\": \"2026-03-04 20:00:03\",\n \"case_id\": 0,\n \"channel_detail\": {\n \"whatsapp_id\": \"6ec7e5fc-fb1d-4365-b1c4-3b4b56f50417\",\n \"sent_at\": \"2026-03-04 20:00:07\",\n \"delivered_at\": \"\",\n \"last_open_date\": \"\",\n \"last_click_date\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"page_size\": 10,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"d1291426-a4ee-489d-a076-3fd9b8812281"}],"id":"2fe42a67-8850-4271-b2ba-6f2f5dd2e619","description":"Thenitro endpoint allows the handling and management of WiseCX campaigns.
Through this endpoint it is possible to send WhatsApp messages, phone calls as well as emails, depending on the configuration associated with the campaign to be executed within WiseCX.
\n","_postman_id":"2fe42a67-8850-4271-b2ba-6f2f5dd2e619","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":true,"source":{"_postman_id":"910aadde-d49b-47b0-b494-264bc826ec72","id":"910aadde-d49b-47b0-b494-264bc826ec72","name":"WiseCX API · v1 (English)","type":"collection"}}},{"name":"Channels","item":[{"name":"Fetching Channels","id":"38553f7d-b47d-40eb-ae02-5e8ee179b65a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.wcx.cloud/core/v1/channels","description":"To retrieve the list of integrated channels, you must perform a GET request, specifying the required fields using the fields parameter. Available fields are:
id, name, source.
The channels endpoint allows you to retrieve the list of channels integrated into Wise CX