Avochato API
Welcome!
If anything isn’t working as documented, please message Avochato Support @ 415-214-8977.
Accounts
Fetch Accounts
Using your auth id + secret you can fetch Accounts by subdomains
Endpoint
GET /v1/accounts/:ids
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Comma separated list of Account subdomains to fetch |
| page | Page to request |
Request
Route
GET /v1/accounts/test-account,account_15?auth_id=ezjJ7pX85y&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=ezjJ7pX85y auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/accounts/test-account,account_15?auth_id=ezjJ7pX85y&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 8866fb41-65eb-4cef-81ed-337d43355f4b
X-Runtime: 0.047682
Content-Length: 295Body
{
"status": 200,
"data": {
"accounts": [
{
"id": "z1N8xr3937",
"subdomain": "account_15",
"name": "Account 15",
"phone": null,
"created_at": "2019-06-20T09:28:45.263-07:00"
},
{
"id": "BDr8GRmJPl",
"subdomain": "test-account",
"name": "Test Account",
"phone": null,
"created_at": "2019-06-20T09:28:45.288-07:00"
}
]
},
"page": 1
}List Accounts
Using your auth id + secret you can list all your Accounts
Endpoint
GET /v1/accounts
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| page | Page to request |
Request
Route
GET /v1/accounts?auth_id=VePJl6abar&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=VePJl6abar auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/accounts?auth_id=VePJl6abar&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: e1fd4fd5-160a-4fdd-98a2-dfc16df32c09
X-Runtime: 0.096643
Content-Length: 295Body
{
"status": 200,
"data": {
"accounts": [
{
"id": "YOobKAPJ7E",
"subdomain": "account_14",
"name": "Account 14",
"phone": null,
"created_at": "2019-06-20T09:28:45.102-07:00"
},
{
"id": "v7Mb6v7bER",
"subdomain": "test-account",
"name": "Test Account",
"phone": null,
"created_at": "2019-06-20T09:28:45.126-07:00"
}
]
},
"page": 1
}Broadcasts
Create Broadcast
Using your auth id + secret you can setup a broadcast
Endpoint
POST /v1/broadcasts
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| message required | Text to send in Broadcasts |
| media_url | Url of media to send in MMS (500kb limit) |
| via_tags | Comma-separated list of contact tags to add to broadcast |
| via_contact_ids | Comma-separated list of contact ids to add to broadcast |
| via_phone_numbers | Comma-separated list of phone_numbers to add to broadcast |
| via_field[field] | String, either name ,phone ,phone_formatted ,email ,company ,street ,city ,state ,country ,zip ,priority ,opted_out, OR Custom Variable name |
| via_field[value] | String, match all contacts with a given field which matches this value exactly |
Request
Route
POST /v1/broadcasts
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "xDjJBrlJoO",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"message": "new test message",
"media_url": "https://somesite.com/pretty.jpg",
"via_tags": "tag1,tag2",
"via_contact_ids": "43y83npJVN",
"via_phone_numbers": "5105551234,4155551234",
"via_field[field]": "email",
"via_field[value]": "bob@mctest.com"
}cURL
curl "https://www.avochato.com/v1/broadcasts" -d '{"auth_id":"xDjJBrlJoO","auth_secret":"YYYYYYYYYYYYYYYYYYYY","message":"new test message","media_url":"https://somesite.com/pretty.jpg","via_tags":"tag1,tag2","via_contact_ids":"43y83npJVN","via_phone_numbers":"5105551234,4155551234","via_field[field]":"email","via_field[value]":"bob@mctest.com"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: ad960bca-6f38-4970-a9d4-d0615130b26d
X-Runtime: 0.347303
Content-Length: 280Body
{
"status": 200,
"data": {
"broadcast": {
"id": "ZMvbX7z8Rm",
"message": "new test message",
"media_url": "https://somesite.com/pretty.jpg",
"status": "initialized",
"contacts_count": 0,
"user": {
"email": "person_12@example.com",
"id": "PDz9n6A9e3",
"name": "Person 13"
},
"pending_contacts_count": null
}
}
}Fetch Broadcasts
Using your auth id + secret you can fetch broadcasts based on their ids
Endpoint
GET /v1/broadcasts/:ids
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Comma separated list of Contact ids to fetch |
| page | Page number to request |
Request
Route
GET /v1/broadcasts/2jRbkd691P,enL8ajlb7N?auth_id=PxB9NmxbYO&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=PxB9NmxbYO auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/broadcasts/2jRbkd691P,enL8ajlb7N?auth_id=PxB9NmxbYO&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 81c6401a-51fb-4352-bde3-2ee5eb69164e
X-Runtime: 0.042566
Content-Length: 341Body
{
"status": 200,
"data": {
"broadcasts": [
{
"id": "2jRbkd691P",
"message": "7",
"status": "initialized",
"contacts_count": 1,
"user": {
"email": "person_15@example.com",
"id": "v7Mb6BObER",
"name": "Person 16"
}
},
{
"id": "enL8ajlb7N",
"message": "8",
"status": "queued",
"contacts_count": 0,
"user": {
"email": "person_15@example.com",
"id": "v7Mb6BObER",
"name": "Person 16"
}
}
]
}
}Publish Broadcast
Using your auth id + secret you can publish your broadcast
Endpoint
POST /v1/broadcasts/:id/publish
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| schedule_for | Unix timestamp, Ensure delivery at this time |
| asap | Boolean, Ignore schedule_for and schedule ASAP |
Request
Route
POST /v1/broadcasts/ezjJ7WLJ5y/publish
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "enL8alOJ7N",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"schedule_for": 1561012126.827318,
"asap": true
}cURL
curl "https://www.avochato.com/v1/broadcasts/ezjJ7WLJ5y/publish" -d '{"auth_id":"enL8alOJ7N","auth_secret":"YYYYYYYYYYYYYYYYYYYY","schedule_for":1561012126.827318,"asap":true}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 61bc010a-1870-4ab3-922f-39b66b7926ec
X-Runtime: 0.097085
Content-Length: 184Body
{
"status": 200,
"data": {
"broadcast": {
"id": "ezjJ7WLJ5y",
"message": "5",
"status": "queued",
"contacts_count": 1,
"user": {
"email": "person_14@example.com",
"id": "YOobKKNb7E",
"name": "Person 15"
}
}
}
}Update Broadcast
Using your auth id + secret you can add more contacts or update your broadcast
Endpoint
POST /v1/broadcasts/:id
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| message | Text to send in Broadcasts |
| media_url | Url of media to send in MMS (500kb limit) |
| via_tags | Comma-separated list of contact tags to add to broadcast |
| via_contact_ids | Comma-separated list of contact ids to add to broadcast |
| via_phone_numbers | Comma-separated list of phone_numbers to add to broadcast |
| via_field[field] | String, [:name, :phone, :phone_formatted, :email, :company, :street, :city, :state, :country, :zip, :priority, :opted_out], OR Custom Variable name |
| via_field[value] | String, match all contacts with a given field which matches this value exactly |
Request
Route
POST /v1/broadcasts/wd6Jmxz97m
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "2jRbkYeJ1P",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"message": "new test message",
"media_url": "https://somesite.com/pretty2.jpg",
"via_tags": "tag2,tag3",
"via_contact_ids": "v5D9RZq9VA",
"via_phone_numbers": "+15105551234,+14155551234",
"via_field[field]": "email",
"via_field[value]": "bob@mctest.com"
}cURL
curl "https://www.avochato.com/v1/broadcasts/wd6Jmxz97m" -d '{"auth_id":"2jRbkYeJ1P","auth_secret":"YYYYYYYYYYYYYYYYYYYY","message":"new test message","media_url":"https://somesite.com/pretty2.jpg","via_tags":"tag2,tag3","via_contact_ids":"v5D9RZq9VA","via_phone_numbers":"+15105551234,+14155551234","via_field[field]":"email","via_field[value]":"bob@mctest.com"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 493cdd04-6b9c-465a-b765-308f29127de0
X-Runtime: 0.146351
Content-Length: 278Body
{
"status": 200,
"data": {
"broadcast": {
"id": "wd6Jmxz97m",
"message": "new test message",
"media_url": "https://somesite.com/pretty2.jpg",
"status": "initialized",
"contacts_count": 1,
"user": {
"email": "person_13@example.com",
"id": "3o48ORwJeA",
"name": "Person 14"
},
"pending_contacts_count": 3
}
}
}CallTokens
Create Call Token
Using your auth id + secret you can create a token to make a call
Endpoint
POST /v1/calls
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
Request
Route
POST /v1/calls
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "0nMJLqN8vZ",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY"
}cURL
curl "https://www.avochato.com/v1/calls" -d '{"auth_id":"0nMJLqN8vZ","auth_secret":"YYYYYYYYYYYYYYYYYYYY"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 506e0737-89e6-4986-98e7-52d8baca85df
X-Runtime: 0.089209
Content-Length: 324Body
{
"status": 200,
"data": {
"call_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzY29wZSI6InNjb3BlOmNsaWVudDpvdXRnb2luZz9hcHBTaWQ9bm90cmVhbCBzY29wZTpjbGllbnQ6aW5jb21pbmc_Y2xpZW50TmFtZT1BRWdiNVlRYmVqIiwiaXNzIjoidHdpbGlvX2FjY291bnRfc2lkIiwibmJmIjoxNTYxMDQ4MTM5LCJleHAiOjE1NjExMzQ1Mzl9.NXviyQ8jB5X_zX6zngfcwvSbFxMsGLpjPLIa2PBprGQ"
}
}Contacts
Fetch Contacts
Using your auth id + secret you can fetch Contacts by ids
Endpoint
GET /v1/contacts/:ids
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Comma separated list of Contact ids to fetch |
| page | Page to request |
Request
Route
GET /v1/contacts/ZMvbXZlJRm,KRg80vk9j0?auth_id=qQR91BoJge&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=qQR91BoJge auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/contacts/ZMvbXZlJRm,KRg80vk9j0?auth_id=qQR91BoJge&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 4820d2af-082c-4494-ac12-46976e747b3c
X-Runtime: 0.042672
Content-Length: 454Body
{
"status": 200,
"data": {
"contacts": [
{
"id": "KRg80vk9j0",
"name": "Bob McTest",
"phone": "+15551234567",
"email": "bob@mctest.com",
"city": "Los Angeles",
"state": "CA",
"zip": "99999",
"company": "McTest Inc",
"created_at": 1561048140.3161001,
"tags": [
"important"
]
},
{
"id": "ZMvbXZlJRm",
"name": "Other Contact",
"phone": "+15551234568",
"email": "bob@contact.com",
"city": "San Francisco",
"state": "CA",
"zip": "88888",
"company": "Contact Inc",
"created_at": 1561048140.322641
}
]
},
"page": 1
}Search Contacts
Using your auth id + secret you can search for matching Contacts based on a query
Endpoint
GET /v1/contacts
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| query | String to search Contacts with (default: iterate through all Contacts) |
| created_at[from] | Select Contacts created after this unixtime |
| created_at[to] | Select Contacts created before this unixtime (default: now) |
| page | Page to request |
Request
Route
GET /v1/contacts?auth_id=KRg807yJj0&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=name%3ABob+OR+%27San+Fran%27&created_at%5Bfrom%5D=1561048079.9937768&created_at%5Bto%5D=1561048199.993876&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=KRg807yJj0 auth_secret=YYYYYYYYYYYYYYYYYYYY query=name:Bob OR 'San Fran' created_at%5Bfrom%5D=1561048079.9937768 created_at%5Bto%5D=1561048199.993876 page=1
cURL
curl "https://www.avochato.com/v1/contacts?auth_id=KRg807yJj0&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=name%3ABob+OR+%27San+Fran%27&created_at%5Bfrom%5D=1561048079.9937768&created_at%5Bto%5D=1561048199.993876&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 75252b04-313c-40c1-ab0b-d146bc2cc5ec
X-Runtime: 0.113244
Content-Length: 432Body
{
"status": 200,
"data": {
"contacts": [
{
"id": "WAnJQZR8y1",
"name": "Bob McTest",
"phone": "+15551234567",
"email": "bob@mctest.com",
"city": "Los Angeles",
"state": "CA",
"zip": "99999",
"company": "McTest Inc",
"created_at": 1561048139.936723
},
{
"id": "0nMJLZ4bvZ",
"name": "Other Contact",
"phone": "+15551234568",
"email": "bob@contact.com",
"city": "San Francisco",
"state": "CA",
"zip": "88888",
"company": "Contact Inc",
"created_at": 1561048139.945775
}
]
},
"page": 1
}Update Contact
Using your auth id + secret you can create or update a Contact based on their phone number
Endpoint
POST /v1/contacts
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| phone required | Phone number of Contact |
| name | Name of the Contact |
| Email for the Contact | |
| other_phone | Other phone for the Contact |
| company | Company for the Contact |
| city | City for the Contact |
| state | State for the Contact |
| zip | Zip Code for the Contact |
| country | Country for the Contact |
| custom_variable_name | Custom variable to set for the Contact |
| tags | CSV of tags to apply to the Contact |
Request
Route
POST /v1/contacts
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "0N6bwpO9DM",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"phone": "+14155553333",
"email": "contact@example.com",
"company": "Example Inc.",
"city": "SF",
"state": "CA",
"country": "USA",
"custom_variable_name": "value to set custom variable"
}cURL
curl "https://www.avochato.com/v1/contacts" -d '{"auth_id":"0N6bwpO9DM","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+14155553333","email":"contact@example.com","company":"Example Inc.","city":"SF","state":"CA","country":"USA","custom_variable_name":"value to set custom variable"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 5986970d-8698-4812-b406-353759b0dc41
X-Runtime: 0.122202
Content-Length: 262Body
{
"status": 200,
"data": {
"contact": {
"id": "ezjJ7x385y",
"name": "New Contact",
"phone": "+14155553333",
"email": "contact@example.com",
"city": "SF",
"state": "CA",
"company": "Example Inc.",
"created_at": 1561048140.708249,
"custom_variable_name": "value to set custom variable"
}
}
}Events
Add Event (Contact id)
Using your auth id + secret you can append an Event directly into a Conversation stream based on the Contact id
Endpoint
POST /v1/contacts/:id/events
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| id required | (URL) Contact id to add an event to |
| type required | Type of event to log: click, sale, etc. |
| context | Context to save regarding the event |
| revenue | Value created for your team from this event |
Request
Route
POST /v1/contacts/YOobKmNJ7E/events
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "wd6Jmvj87m",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"type": "sale",
"context": "Wanted a new watch ($99.99) with no warranty",
"revenue": 99.99
}cURL
curl "https://www.avochato.com/v1/contacts/YOobKmNJ7E/events" -d '{"auth_id":"wd6Jmvj87m","auth_secret":"YYYYYYYYYYYYYYYYYYYY","type":"sale","context":"Wanted a new watch ($99.99) with no warranty","revenue":99.99}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 108a1f59-075b-431c-9791-32baa1f9096e
X-Runtime: 0.468234
Content-Length: 303Body
{
"status": 200,
"data": {
"event": {
"user_id": "BLP9MxgbqY",
"account_id": "qQR91V4Jge",
"ticket_id": "xDjJBMZ9oO",
"contact_id": "YOobKmNJ7E",
"type": "sale",
"context": "Wanted a new watch ($99.99) with no warranty",
"revenue": 99.99,
"element_id": "AwebYoJaEr",
"element_type": "CustomEvent",
"sent_at": 1561048120.058524
}
}
}Add Event (Phone)
Using your auth id + secret you can append an Event directly into a Conversation stream based on the phone number
Endpoint
POST /v1/events
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| phone required | Phone number of the Contact |
| type required | Type of event to log: click, sale, etc. |
| context | Context to save regarding the event |
| revenue | Value created for your team from this event |
Request
Route
POST /v1/events
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "ezjJ7pZ85y",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"phone": "+15551234567",
"type": "sale",
"context": "Bought an avocado ($2) and was interested in a subscription",
"revenue": 2.0
}cURL
curl "https://www.avochato.com/v1/events" -d '{"auth_id":"ezjJ7pZ85y","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+15551234567","type":"sale","context":"Bought an avocado ($2) and was interested in a subscription","revenue":2.0}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: fac872cb-1716-4b00-9d44-37a985350a51
X-Runtime: 0.142850
Content-Length: 316Body
{
"status": 200,
"data": {
"event": {
"user_id": "0nMJL64bvZ",
"account_id": "M3NbrMz8r6",
"ticket_id": "enL8ae387N",
"contact_id": "z1N8x0A837",
"type": "sale",
"context": "Bought an avocado ($2) and was interested in a subscription",
"revenue": 2.0,
"element_id": "3YnbgeJae2",
"element_type": "CustomEvent",
"sent_at": 1561048121.312531
}
}
}Add Event (Ticket id)
Using your auth id + secret you can append an Event directly into a Conversation stream based on the Ticket id
Endpoint
POST /v1/tickets/:id/events
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| id required | (URL) Ticket id to add event to |
| type required | Type of event to log: click, sale, etc. |
| context | Context to save regarding the event |
| revenue | Value created for your team from this event |
Request
Route
POST /v1/tickets/2jRbkmMJ1P/events
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "VePJl6obar",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"type": "sale",
"context": "Wanted one hat ($10) and upsold warranty ($5.50)",
"revenue": 15.5
}cURL
curl "https://www.avochato.com/v1/tickets/2jRbkmMJ1P/events" -d '{"auth_id":"VePJl6obar","auth_secret":"YYYYYYYYYYYYYYYYYYYY","type":"sale","context":"Wanted one hat ($10) and upsold warranty ($5.50)","revenue":15.5}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: e65d6b20-a834-4b18-a830-bc398a2720b2
X-Runtime: 0.140128
Content-Length: 307Body
{
"status": 200,
"data": {
"event": {
"user_id": "WAnJQeRJy1",
"account_id": "0N6bwwZbDM",
"ticket_id": "2jRbkmMJ1P",
"contact_id": "v7Mb6VObER",
"type": "sale",
"context": "Wanted one hat ($10) and upsold warranty ($5.50)",
"revenue": 15.5,
"element_id": "RkAJvlb0oL",
"element_type": "CustomEvent",
"sent_at": 1561048120.8925781
}
}
}Fetch Events
Using your auth id + secret you can fetch Events in a Ticket based on Ticket ids
Endpoint
GET /v1/tickets/:ids/events
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Ticket ids to fetch the event stream |
| page | Page to request |
Request
Route
GET /v1/tickets/ezjJ7gEJ5y/events?auth_id=ZMvbXkK8Rm&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=ZMvbXkK8Rm auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/tickets/ezjJ7gEJ5y/events?auth_id=ZMvbXkK8Rm&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 80e06b05-9947-4dc3-ae1a-7864f7eae308
X-Runtime: 0.738350
Content-Length: 1884Body
{
"status": 200,
"data": {
"events": [
{
"account_id": "KRg80BL9j0",
"ticket_id": "ezjJ7gEJ5y",
"user_id": "PxB9NGDJYO",
"status": "Closed",
"element_id": "M3NbrBKbr6",
"element_type": "StatusChange",
"sent_at": 1561048119.102295
},
{
"account_id": "KRg80BL9j0",
"call_from": "+15551234567",
"call_to": "+15558888888",
"voicemail": null,
"direction": "in",
"call_status": "completed",
"ended_at": null,
"duration": 119,
"segments": 2,
"element_id": "wEG8jA2JQl",
"element_type": "Call",
"sent_at": 1561048119.09451
},
{
"uuid": "589df0bd-16fa-4fe4-999c-6a5824a5f4f6",
"account_id": "KRg80BL9j0",
"ticket_id": "ezjJ7gEJ5y",
"contact_id": "3o48Okw8eA",
"sender_id": "PxB9NGDJYO",
"sender_type": "User",
"direction": "out",
"message": "Sorry in a meeting but can call afterwards",
"segments": 1,
"status": "queued",
"error_code": 0,
"created_at": 1561048119,
"sent_at": 1561048119.085383,
"element_id": "ePJl7DK9ar",
"element_type": "SmsMessage"
},
{
"uuid": "7d15941d-03ff-4bea-8d55-dc4df94f678e",
"account_id": "KRg80BL9j0",
"ticket_id": "ezjJ7gEJ5y",
"contact_id": "3o48Okw8eA",
"sender_id": "PxB9NGDJYO",
"sender_type": "User",
"direction": "out",
"message": "Hey there Bob let me know when we can talk!",
"segments": 1,
"status": "queued",
"error_code": 0,
"created_at": 1561048119,
"sent_at": 1561048119.076465,
"element_id": "d6JmzDp87m",
"element_type": "SmsMessage"
},
{
"account_id": "KRg80BL9j0",
"call_from": "+15558888888",
"call_to": "+15551234567",
"voicemail": null,
"direction": "out",
"call_status": "completed",
"ended_at": null,
"duration": 10,
"segments": 1,
"element_id": "43y832xJVN",
"element_type": "Call",
"sent_at": 1561048119.0268958
},
{
"account_id": "KRg80BL9j0",
"ticket_id": "ezjJ7gEJ5y",
"user_id": "PxB9NGDJYO",
"status": "Open",
"element_id": "0N6bwZR8DM",
"element_type": "StatusChange",
"sent_at": 1561048118.988825
},
{
"account_id": "KRg80BL9j0",
"ticket_id": "ezjJ7gEJ5y",
"user_id": "PxB9NGDJYO",
"owner_id": "PxB9NGDJYO",
"element_id": "zPG9yg8aO0",
"element_type": "OwnerChange",
"sent_at": 1561048118.949644
}
]
}
}Links
Create or Update a Link
Using your auth id + secret you can create or update your links
Endpoint
POST /v1/links
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| url required | Url to shorten and track |
| tags | Tags to add to the contact after a click |
Request
Route
POST /v1/links
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "2jRbkY4J1P",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"url": "https://example.com/?utm_campaign=ga",
"tags": "adwords-click,active"
}cURL
curl "https://www.avochato.com/v1/links" -d '{"auth_id":"2jRbkY4J1P","auth_secret":"YYYYYYYYYYYYYYYYYYYY","url":"https://example.com/?utm_campaign=ga","tags":"adwords-click,active"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: d8552767-fb88-4123-b61d-d4855749f387
X-Runtime: 0.153351
Content-Length: 233Body
{
"status": 200,
"data": {
"link": {
"id": "zPG9y3g8aO",
"original_url": "https://example.com/?utm_campaign=ga",
"short_url": "https://avo.im/XXXXXXXX",
"tag_on_click": "adwords-click,active",
"sent_count": 0,
"unclicked_count": 0,
"clicked_count": 0
}
}
}Fetch Links
Using your auth id + secret you can iterate through your links
Endpoint
GET /v1/links/:ids
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Comma separated list of Link ids to fetch |
| page | Page to request |
Request
Route
GET /v1/links/Pweboa1JXm,GeAbZv3bDM?auth_id=enL8alNJ7N&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=enL8alNJ7N auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/links/Pweboa1JXm,GeAbZv3bDM?auth_id=enL8alNJ7N&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 041e5251-eada-4102-bd22-be2aaaa6c91d
X-Runtime: 0.034182
Content-Length: 485Body
{
"status": 200,
"data": {
"contacts": [
{
"id": "GeAbZv3bDM",
"original_url": "https://example.com/?utm_campaign=broadcast",
"short_url": "https://avo.im/XXXXXXXX",
"tag_on_click": "broadcast-click,active",
"sent_count": 5000,
"unclicked_count": 3663,
"clicked_count": 1337
},
{
"id": "Pweboa1JXm",
"original_url": "https://example.com/?utm_campaign=facebook",
"short_url": "https://avo.im/XXXXXXXX",
"tag_on_click": "facebook-click,active",
"sent_count": 5000,
"unclicked_count": 3663,
"clicked_count": 1337
}
]
},
"page": 1
}List Links
Using your auth id + secret you can iterate through your links
Endpoint
GET /v1/links
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| page | Page to request |
Request
Route
GET /v1/links?auth_id=xDjJBrXJoO&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=xDjJBrXJoO auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/links?auth_id=xDjJBrXJoO&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 2e674e73-6282-4f5c-a0fa-ce7237f9f989
X-Runtime: 0.106300
Content-Length: 482Body
{
"status": 200,
"data": {
"links": [
{
"id": "EZA9Pl59rw",
"original_url": "https://example.com/?utm_campaign=broadcast",
"short_url": "https://avo.im/XXXXXXXX",
"tag_on_click": "broadcast-click,active",
"sent_count": 5000,
"unclicked_count": 3663,
"clicked_count": 1337
},
{
"id": "3OLb4WY84Y",
"original_url": "https://example.com/?utm_campaign=facebook",
"short_url": "https://avo.im/XXXXXXXX",
"tag_on_click": "facebook-click,active",
"sent_count": 5000,
"unclicked_count": 3663,
"clicked_count": 1337
}
]
},
"page": 1
}Messages
Search Messages
Using your auth id + secret you can search for matching Messages based on a query
Endpoint
GET /v1/messages
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| query | String, Query to search Messages (default: iterate through all messages) |
| page | Integer, Page to request |
| direction | String, Direction of the message ("in" for received messages, "out" for sent messages) |
| status | String, Message delivery status (ie: queued, delivered, undelivered, failed) |
| from | String, Phone number message was sent from |
| to | String, Phone number message was sent to |
| created_at[from] | Unix timestamp, Select messages created after this date |
| created_at[to] | Unix timestamp, Select messages created before this date (default: now) |
Request
Route
GET /v1/messages?auth_id=BLP9Mor8qY&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=hear&page=1&direction=in&status=delivered&from=%2B15105551234&to=%2B14155551234&created_at%5Bfrom%5D=1561048067.871341&created_at%5Bto%5D=1561048187.871455
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=BLP9Mor8qY auth_secret=YYYYYYYYYYYYYYYYYYYY query=hear page=1 direction=in status=delivered from=+15105551234 to=+14155551234 created_at%5Bfrom%5D=1561048067.871341 created_at%5Bto%5D=1561048187.871455
cURL
curl "https://www.avochato.com/v1/messages?auth_id=BLP9Mor8qY&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=hear&page=1&direction=in&status=delivered&from=%2B15105551234&to=%2B14155551234&created_at%5Bfrom%5D=1561048067.871341&created_at%5Bto%5D=1561048187.871455" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 4087578b-c6fb-47a9-b121-7e658da767f9
X-Runtime: 10.441447
Content-Length: 444Body
{
"status": 200,
"data": {
"messages": [
{
"uuid": "3a023a95-ec52-4e06-8a35-7393d57a3b85",
"account_id": "EZA9PDY9rw",
"ticket_id": "KRg80rL9j0",
"contact_id": "xDjJBZdJoO",
"to": "+14155551234",
"from": "+15105551234",
"direction": "in",
"message": "I kept hearing that you had great service 😀!",
"segments": 1,
"status": "delivered",
"error_code": 0,
"created_at": 1561048127,
"sent_at": 1561048127.678281,
"element_id": "nMJLykK8vZ",
"element_type": "SmsMessage"
}
]
},
"page": 1
}Send Message
Using your auth id + secret you can send a Message to any Contact based on their phone
Endpoint
POST /v1/messages
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| phone required | Phone number to send |
| message required | Text to send in SMS |
| from | String, Phone number in the account to try to send from |
| media_url | String, Url of media to send in MMS (500kb limit) |
| tags | String, Comma-separated list of tags to apply to this contact |
| status_callback | String, Domain to send callback http POST requests when the status is updated |
Request
Route
POST /v1/messages
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "WAnJQxL9y1",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"phone": "+14155553333",
"message": "test message",
"from": "+15105551234",
"tags": "Some Tag, Another Tag",
"status_callback": "http://my.domain.com"
}cURL
curl "https://www.avochato.com/v1/messages" -d '{"auth_id":"WAnJQxL9y1","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+14155553333","message":"test message","from":"+15105551234","tags":"Some Tag, Another Tag","status_callback":"http://my.domain.com"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: f0537877-61e1-4317-9b28-cb4988993add
X-Runtime: 0.235043
Content-Length: 479Body
{
"status": 200,
"data": {
"message": {
"uuid": "642c7db6-a8b7-4974-9849-646b13ca9115",
"account_id": "mQL9WoM9Wq",
"ticket_id": "ezjJ7nL95y",
"contact_id": "BLP9MZgJqY",
"sender_id": "BDr8Gga8Pl",
"sender_type": "User",
"to": "+14155553333",
"direction": "out",
"message": "test message",
"segments": 1,
"carrier": "twilio",
"status": "queued",
"error_code": 0,
"status_callback": "http://my.domain.com",
"created_at": 1561048139,
"sent_at": 1561048139.051578,
"element_id": "d6JmzDj87m",
"element_type": "SmsMessage"
}
}
}Tags
Add Tag (Contact id)
Using your auth id + secret you can add a new tag to Contacts
Endpoint
POST /v1/contacts/:ids/tags
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Comma separated list of Contact ids to tag |
| tag required | Tag to add to Contacts |
Request
Route
POST /v1/contacts/EDR8zwVbA2,BDr8G4abPl/tags
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "PxB9NmabYO",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"tag": "my-new-tag"
}cURL
curl "https://www.avochato.com/v1/contacts/EDR8zwVbA2,BDr8G4abPl/tags" -d '{"auth_id":"PxB9NmabYO","auth_secret":"YYYYYYYYYYYYYYYYYYYY","tag":"my-new-tag"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: b76501d2-d0c4-4f28-9242-c98a23ba37a5
X-Runtime: 0.212063
Content-Length: 94Body
{
"status": 200,
"data": {
"action": "tagged",
"tag": "my-new-tag",
"ids": [
"EDR8zwVbA2",
"BDr8G4abPl"
]
}
}Add Tag (Phone)
Using your auth id + secret you can add a new tag to a Contact based on phone number
Endpoint
POST /v1/tags
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| phone required | Phone number of the Contact |
| tag required | Tag to add to Contacts |
Request
Route
POST /v1/tags
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "0nMJLR6bvZ",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"phone": "+15551234567",
"tag": "my-new-tag"
}cURL
curl "https://www.avochato.com/v1/tags" -d '{"auth_id":"0nMJLR6bvZ","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+15551234567","tag":"my-new-tag"}' -X POST \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: eeac2c4f-c36c-4f25-bc11-99052ba1d35d
X-Runtime: 0.070668
Content-Length: 81Body
{
"status": 200,
"data": {
"action": "tagged",
"tag": "my-new-tag",
"ids": [
"mQL9Ww39Wq"
]
}
}Remove Tag (Contact id)
Using your auth id + secret you can remove an old tag from Contacts
Endpoint
DELETE /v1/contacts/:ids/tags
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Comma separated list of Contact ids to untag |
| tag required | Tag to remove from Contacts |
Request
Route
DELETE /v1/contacts/Pe6bexx8Xw,1K2b20XJWR/tags
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "BLP9MX1bqY",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"tag": "my-old-tag"
}cURL
curl "https://www.avochato.com/v1/contacts/Pe6bexx8Xw,1K2b20XJWR/tags" -d '{"auth_id":"BLP9MX1bqY","auth_secret":"YYYYYYYYYYYYYYYYYYYY","tag":"my-old-tag"}' -X DELETE \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 47799922-e258-4a34-b349-8433239fcaf4
X-Runtime: 0.100568
Content-Length: 96Body
{
"status": 200,
"data": {
"action": "untagged",
"tag": "my-old-tag",
"ids": [
"Pe6bexx8Xw",
"1K2b20XJWR"
]
}
}Remove Tag (Phone)
Using your auth id + secret you can remove an old tag from a Contact based on phone number
Endpoint
DELETE /v1/tags
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| phone required | Phone number of the Contact |
| tag required | Tag to remove from Contacts |
Request
Route
DELETE /v1/tags
Headers
Content-Type: application/json
Host: www.avochato.comBody
{
"auth_id": "WAnJQB58y1",
"auth_secret": "YYYYYYYYYYYYYYYYYYYY",
"phone": "+15551234567",
"tag": "my-old-tag"
}cURL
curl "https://www.avochato.com/v1/tags" -d '{"auth_id":"WAnJQB58y1","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+15551234567","tag":"my-old-tag"}' -X DELETE \
-H "Content-Type: application/json" \
-H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 4574ff97-f514-4b6c-9696-5c348d44b4a0
X-Runtime: 0.092079
Content-Length: 83Body
{
"status": 200,
"data": {
"action": "untagged",
"tag": "my-old-tag",
"ids": [
"3OLb4wO84Y"
]
}
}Tickets
Fetch Tickets
Using your auth id + secret you can fetch Tickets by ids
Endpoint
GET /v1/tickets/:ids
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| ids required | (URL) Comma separated list of Ticket ids |
| page | Page to request |
Request
Route
GET /v1/tickets/0nMJLd7JvZ,WAnJQnk8y1?auth_id=wd6JmvL87m&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=wd6JmvL87m auth_secret=YYYYYYYYYYYYYYYYYYYY page=1
cURL
curl "https://www.avochato.com/v1/tickets/0nMJLd7JvZ,WAnJQnk8y1?auth_id=wd6JmvL87m&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: f967fff7-e83d-4c81-9977-77c52810b64d
X-Runtime: 0.037732
Content-Length: 361Body
{
"status": 200,
"data": {
"tickets": [
{
"uuid": "2be4a282-c00a-4d1b-ab4f-1975a751690e",
"contact": "xoWbqB09qn",
"user_id": "RkAJvX1b0o",
"status": "Open",
"origin": "Avochato",
"created_at": 1561048124.630837
},
{
"uuid": "e139ab6e-6968-4969-9ea0-77976245cc4b",
"contact": "GeAbZEA8DM",
"user_id": null,
"status": "Pending",
"origin": "Avochato",
"created_at": 1561048124.622208
}
]
},
"page": 1
}Search Tickets
Using your auth id + secret you can search for matching Tickets based on a query
Endpoint
GET /v1/tickets
Parameters
| Name | Description |
|---|---|
| auth_id required | Auth Id field |
| auth_secret required | Authentication Secret field |
| query | String to search Tickets with (default: iterate through all tickets) |
| page | Page to request |
Request
Route
GET /v1/tickets?auth_id=ZMvbXkZ8Rm&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=status%3AOpen&page=1
Headers
Content-Type: application/json
Host: www.avochato.comQuery Parameters
auth_id=ZMvbXkZ8Rm auth_secret=YYYYYYYYYYYYYYYYYYYY query=status:Open page=1
cURL
curl "https://www.avochato.com/v1/tickets?auth_id=ZMvbXkZ8Rm&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=status%3AOpen&page=1" -X GET \ -H "Content-Type: application/json" \ -H "Host: www.avochato.com"
Response
Simulated Response
Status
200Headers
Content-Type: application/json; charset=utf-8
X-Request-Id: 061420f0-ab60-4cd0-b2ba-18a59d2d0e1a
X-Runtime: 0.110186
Content-Length: 205Body
{
"status": 200,
"data": {
"tickets": [
{
"uuid": "ed92bb4e-bb26-4a57-b613-a5be1535ba89",
"contact": "Pwebol59Xm",
"user_id": "AwebYkDJaE",
"status": "Open",
"origin": "Avochato",
"created_at": 1561048124.036184
}
]
},
"page": 1
}