List a contact's campaigns
curl --request GET \
--url https://api.vambe.me/api/public/outreach-campaign/by-contact/{contactId} \
--header 'x-api-key: <x-api-key>'const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.vambe.me/api/public/outreach-campaign/by-contact/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/outreach-campaign/by-contact/{contactId}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total": 123,
"page": 123,
"page_size": 123,
"has_more": true,
"campaigns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Autocash Septiembre",
"status": "draft",
"campaign_type": "one_time",
"kpi_event": {
"key": "order_created",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"audience": {
"status": "<string>",
"source": "<string>",
"segment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"size": 123
},
"lifecycle": "notSent",
"delivery": {
"not_started": 123,
"running": 123,
"finished": 123,
"last_batch_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"front_url": "<string>",
"steps": [
{
"kind": "send-template",
"channel": "whatsapp"
}
],
"recipient": {
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"status": "pending",
"reach": "full",
"dispatched_at": "2023-11-07T05:31:56Z",
"batch_number": 123,
"next_step_at": "2023-11-07T05:31:56Z",
"responded_at": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"reason": "<string>",
"failure_level": "system",
"at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"read_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"failed_reason": "<string>",
"button_presses": [
{
"button": "<string>",
"pressed_at": "2023-11-07T05:31:56Z"
}
],
"email_status": "<string>",
"email_status_at": "2023-11-07T05:31:56Z",
"email_failed_reason": "<string>",
"call": {
"status": "<string>",
"answered": true,
"duration_seconds": 123
}
}
],
"ticket_fields": [
{
"key": "rut",
"name": "RUT",
"value": "11111111-1"
}
]
}
}
]
}Campaigns
List a contact's campaigns
List the campaigns a contact received, newest first, each with only that contact’s participation: delivery status, whether they responded or converted, the ticket fields uploaded for them and the outcome of every send step.
GET
/
api
/
public
/
outreach-campaign
/
by-contact
/
{contactId}
List a contact's campaigns
curl --request GET \
--url https://api.vambe.me/api/public/outreach-campaign/by-contact/{contactId} \
--header 'x-api-key: <x-api-key>'const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.vambe.me/api/public/outreach-campaign/by-contact/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/outreach-campaign/by-contact/{contactId}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total": 123,
"page": 123,
"page_size": 123,
"has_more": true,
"campaigns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Autocash Septiembre",
"status": "draft",
"campaign_type": "one_time",
"kpi_event": {
"key": "order_created",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"audience": {
"status": "<string>",
"source": "<string>",
"segment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"size": 123
},
"lifecycle": "notSent",
"delivery": {
"not_started": 123,
"running": 123,
"finished": 123,
"last_batch_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"front_url": "<string>",
"steps": [
{
"kind": "send-template",
"channel": "whatsapp"
}
],
"recipient": {
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"status": "pending",
"reach": "full",
"dispatched_at": "2023-11-07T05:31:56Z",
"batch_number": 123,
"next_step_at": "2023-11-07T05:31:56Z",
"responded_at": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"reason": "<string>",
"failure_level": "system",
"at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"read_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"failed_reason": "<string>",
"button_presses": [
{
"button": "<string>",
"pressed_at": "2023-11-07T05:31:56Z"
}
],
"email_status": "<string>",
"email_status_at": "2023-11-07T05:31:56Z",
"email_failed_reason": "<string>",
"call": {
"status": "<string>",
"answered": true,
"duration_seconds": 123
}
}
],
"ticket_fields": [
{
"key": "rut",
"name": "RUT",
"value": "11111111-1"
}
]
}
}
]
}Headers
API key needed to authorize the request
Path Parameters
The ID of the contact
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 25Was this page helpful?
