Accounts

Fetch Accounts

Fetch one or more Accounts by their unique subdomain

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%2Caccount_26?auth_id=xlYJpnGbmw&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=xlYJpnGbmw
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/accounts/test-account%2Caccount_26?auth_id=xlYJpnGbmw&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 27a93644-b94e-4182-985f-2b5466aa2954
X-Runtime: 0.022757
Content-Length: 295

Body

{
  "status": 200,
  "data": {
    "accounts": [
      {
        "id": "1N8xDkK837",
        "subdomain": "account_26",
        "name": "Account 26",
        "phone": null,
        "created_at": "2021-11-08T16:41:33.527-08:00"
      },
      {
        "id": "Dr8GnwMJPl",
        "subdomain": "test-account",
        "name": "Test Account",
        "phone": null,
        "created_at": "2021-11-08T16:41:33.584-08:00"
      }
    ]
  },
  "page": 1
}

List Accounts

List each of the Accounts this API Key can access

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=wEG8jv58Ql&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=wEG8jv58Ql
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/accounts?auth_id=wEG8jv58Ql&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 374c2463-4a63-4890-8ed8-2c725500544f
X-Runtime: 0.071609
Content-Length: 295

Body

{
  "status": 200,
  "data": {
    "accounts": [
      {
        "id": "OobKal3J7E",
        "subdomain": "account_25",
        "name": "Account 25",
        "phone": null,
        "created_at": "2021-11-08T16:41:33.401-08:00"
      },
      {
        "id": "7Mb6Wnn9ER",
        "subdomain": "test-account",
        "name": "Test Account",
        "phone": null,
        "created_at": "2021-11-08T16:41:33.432-08:00"
      }
    ]
  },
  "page": 1
}

Broadcasts

A Broadcast is a message that is delivered to one or more contacts. In order to send a broadcast via the API, you must
1) Create a broadcast
2) Add contacts to the broadcast audience
3)Publish your broadcast (either ASAP or in the future).

The recipients will each receive your broadcast’s message on their device in a 1-on-1 conversation with your Avochato number.
You can use variables like $first_name to customize the content of the message.
Broadcasts with large audiences or long message content will take longer to deliver to the entire audience. Broadcasts cannot be sent to groups.

Create Broadcast

Create a new broadcast

Endpoint

POST /v1/broadcasts

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
message required	String, the Message you want to broadcast (1600 character limit)
media_url	Url of media to send in MMS (500kb limit)
status_callback	Url to send status updates for each message sent by this broadcast
name	String, name of this broadcast
via_tags	Comma-separated list of contact tags to add to this broadcast
via_contact_ids	Comma-separated list of contact ids to add to this broadcast
via_phone_numbers	Comma-separated list of phone_numbers to add to this broadcast
via_field[field]	String, either name ,phone ,phone_formatted ,email ,company ,street ,city ,state ,country ,zip ,priority ,opted_out ,salesforce_object_id ,salesforce_object_type, 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.com

Body

{
  "auth_id": "M3NbrlDJr6",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "message": "new test message",
  "media_url": "https://somesite.com/pretty.jpg",
  "status_callback": "https://somesite.com/some_callback_route",
  "name": "My New Broadcast",
  "via_tags": "tag1,tag2",
  "via_contact_ids": "ePJlYYd8ar",
  "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":"M3NbrlDJr6","auth_secret":"YYYYYYYYYYYYYYYYYYYY","message":"new test message","media_url":"https://somesite.com/pretty.jpg","status_callback":"https://somesite.com/some_callback_route","name":"My New Broadcast","via_tags":"tag1,tag2","via_contact_ids":"ePJlYYd8ar","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

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 644d8988-7a3b-4f62-a9de-a96bf973885a
X-Runtime: 0.186765
Content-Length: 367

Body

{
  "status": 200,
  "data": {
    "broadcast": {
      "id": "AwebY0A8aE",
      "name": "My New Broadcast",
      "message": "new test message",
      "media_url": "https://somesite.com/pretty.jpg",
      "status": "initialized",
      "contacts_count": 0,
      "user": {
        "email": "person_31@example.com",
        "id": "eAbZnNabDM",
        "name": "Person 34"
      },
      "status_callback": "https://somesite.com/some_callback_route",
      "pending_contacts_count": null
    }
  }
}

Fetch Broadcasts

Fetch one or more 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 Broadcast ids to fetch
page	Page number to request

Request

Route

GET /v1/broadcasts/1LxJD5d8n2%2CPDz9nXm8e3?auth_id=qxk9E66JRK&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=qxk9E66JRK
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/broadcasts/1LxJD5d8n2%2CPDz9nXm8e3?auth_id=qxk9E66JRK&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: d2fff670-7f6b-4cb8-9c8c-e5705bc8803f
X-Runtime: 0.024891
Content-Length: 445

Body

{
  "status": 200,
  "data": {
    "broadcasts": [
      {
        "id": "1LxJD5d8n2",
        "name": null,
        "message": "5",
        "media_url": null,
        "status": "initialized",
        "contacts_count": 1,
        "user": {
          "email": "person_33@example.com",
          "id": "3y83WOn8VN",
          "name": "Person 36"
        },
        "status_callback": null
      },
      {
        "id": "PDz9nXm8e3",
        "name": null,
        "message": "6",
        "media_url": null,
        "status": "queued",
        "contacts_count": 0,
        "user": {
          "email": "person_33@example.com",
          "id": "3y83WOn8VN",
          "name": "Person 36"
        },
        "status_callback": null
      }
    ]
  }
}

Publish Broadcast

Publish your broadcast

Endpoint

POST /v1/broadcasts/:id/publish

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
scheduled_for	Unix timestamp, Ensure delivery at this time
asap	Boolean, Ignore schedule_for and schedule ASAP

Request

Route

POST /v1/broadcasts/3o48OmZ9eA/publish

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "kvnJAEoJAD",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "scheduled_for": 1636382497.283731,
  "asap": true
}

cURL

curl "https://www.avochato.com/v1/broadcasts/3o48OmZ9eA/publish" -d '{"auth_id":"kvnJAEoJAD","auth_secret":"YYYYYYYYYYYYYYYYYYYY","scheduled_for":1636382497.283731,"asap":true}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 26f9fd97-8241-46b7-91c9-803ec8dbd1e5
X-Runtime: 0.057328
Content-Length: 241

Body

{
  "status": 200,
  "data": {
    "broadcast": {
      "id": "3o48OmZ9eA",
      "name": null,
      "message": "7",
      "media_url": null,
      "status": "initialized",
      "contacts_count": 1,
      "user": {
        "email": "person_34@example.com",
        "id": "EG8jndN8Ql",
        "name": "Person 37"
      },
      "status_callback": null
    }
  }
}

Update Broadcast

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	String, the Message you want to broadcast (1600 character limit)
media_url	Url of media to send in MMS (500kb limit)
name	String, name of this broadcast
via_tags	Comma-separated list of contact tags to add to this broadcast
via_contact_ids	Comma-separated list of contact ids to add to this broadcast
via_phone_numbers	Comma-separated list of phone_numbers to add to this broadcast
via_field[field]	String, [:name, :phone, :phone_formatted, :email, :company, :street, :city, :state, :country, :zip, :priority, :opted_out, :salesforce_object_id, :salesforce_object_type], 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/RkAJvMR90o

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "k5V9VQMblr",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "message": "new test message",
  "media_url": "https://somesite.com/pretty2.jpg",
  "name": "My Other Broadcast",
  "via_tags": "tag2,tag3",
  "via_contact_ids": "jRbkddX91P",
  "via_phone_numbers": "+15105551234,+14155551234",
  "via_field[field]": "email",
  "via_field[value]": "bob@mctest.com"
}

cURL

curl "https://www.avochato.com/v1/broadcasts/RkAJvMR90o" -d '{"auth_id":"k5V9VQMblr","auth_secret":"YYYYYYYYYYYYYYYYYYYY","message":"new test message","media_url":"https://somesite.com/pretty2.jpg","name":"My Other Broadcast","via_tags":"tag2,tag3","via_contact_ids":"jRbkddX91P","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

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: a4fecf03-832a-476a-bc78-95a0f210a603
X-Runtime: 0.116090
Content-Length: 329

Body

{
  "status": 200,
  "data": {
    "broadcast": {
      "id": "RkAJvMR90o",
      "name": "My Other Broadcast",
      "message": "new test message",
      "media_url": "https://somesite.com/pretty2.jpg",
      "status": "initialized",
      "contacts_count": 1,
      "user": {
        "email": "person_32@example.com",
        "id": "oWbq7GBJqn",
        "name": "Person 35"
      },
      "status_callback": null,
      "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.com

Body

{
  "auth_id": "kvnJAaoJAD",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY"
}

cURL

curl "https://www.avochato.com/v1/calls" -d '{"auth_id":"kvnJAaoJAD","auth_secret":"YYYYYYYYYYYYYYYYYYYY"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 5d745017-6a0e-4518-99d4-637c5761505d
X-Runtime: 0.360283
Content-Length: 324

Body

{
  "status": 200,
  "data": {
    "call_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzY29wZSI6InNjb3BlOmNsaWVudDpvdXRnb2luZz9hcHBTaWQ9bm90cmVhbCBzY29wZTpjbGllbnQ6aW5jb21pbmc_Y2xpZW50TmFtZT1kNkptenlkODdtIiwiaXNzIjoidHdpbGlvX2FjY291bnRfc2lkIiwibmJmIjoxNjM2NDE4NDg2LCJleHAiOjE2MzY1MDQ4ODZ9.0si_sz2qUY2d7xwm3No2VQu0yluK_wvHQ92pWTAQRK4"
  }
}

Campaigns

Fetch Campaigns

Using your auth id + secret you can fetch campaign macros by ids

Endpoint

GET /v1/campaigns/:ids

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL) Comma separated list of campaign keys to fetch
page	Page to request

Request

Route

GET /v1/campaigns/one?auth_id=GeAbZwX9DM&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=GeAbZwX9DM
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/campaigns/one?auth_id=GeAbZwX9DM&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 0edeaa99-fcbd-4d4d-b9cd-60d952321359
X-Runtime: 0.030812
Content-Length: 245

Body

{
  "status": 200,
  "data": {
    "campaigns": [
      {
        "id": "3OLb4NqJ4Y",
        "key": "one",
        "raw_text": "[Campaign 1] first message",
        "follow_up_message": "[Campaign 1] second message",
        "follow_up_delay": null,
        "media_url": null,
        "hash_id": "3OLb4NqJ4Y",
        "hotkey": null
      }
    ]
  },
  "page": 1
}

List Campaigns

Using your auth id + secret you can get all defined campaigns

Endpoint

GET /v1/campaigns

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field

Request

Route

GET /v1/campaigns?auth_id=PweboY4JXm&auth_secret=YYYYYYYYYYYYYYYYYYYY

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=PweboY4JXm
auth_secret=YYYYYYYYYYYYYYYYYYYY

cURL

curl -g "https://www.avochato.com/v1/campaigns?auth_id=PweboY4JXm&auth_secret=YYYYYYYYYYYYYYYYYYYY" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 34258e54-97c1-48d2-a5f9-af634e80c28f
X-Runtime: 0.024559
Content-Length: 435

Body

{
  "status": 200,
  "data": {
    "campaigns": [
      {
        "id": "Pe6beW2JXw",
        "key": "two",
        "raw_text": "[Campaign 2] first message",
        "follow_up_message": "[Campaign 2] second message",
        "follow_up_delay": null,
        "media_url": null,
        "hash_id": "Pe6beW2JXw",
        "hotkey": null
      },
      {
        "id": "1K2b2qY8WR",
        "key": "one",
        "raw_text": "[Campaign 1] first message",
        "follow_up_message": "[Campaign 1] second message",
        "follow_up_delay": null,
        "media_url": null,
        "hash_id": "1K2b2qY8WR",
        "hotkey": null
      }
    ]
  }
}

Remove all contacts from campaign

Using your auth id + secret you can remove all contacts from a campaign

Endpoint

POST /v1/campaigns/:id/cancel

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
id required	(URL) Campaign keyword
phone	Phone number of the contact to cancel
contacts	List of contacts to cancel

Request

Route

POST /v1/campaigns/one/cancel

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "AEgb5m3bej",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY"
}

cURL

curl "https://www.avochato.com/v1/campaigns/one/cancel" -d '{"auth_id":"AEgb5m3bej","auth_secret":"YYYYYYYYYYYYYYYYYYYY"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 4d31d05d-3d28-499a-9df2-c7734daf5abf
X-Runtime: 0.064812
Content-Length: 59

Body

{
  "status": 200,
  "data": {
    "campaigns": "Processing 2 entries."
  }
}

Remove multiple contacts from campaign

Using your auth id + secret you can remove contacts from a campaign by their phone numbers

Endpoint

POST /v1/campaigns/:id/cancel

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
id required	(URL) Campaign keyword
phone	Phone number of the contact to cancel
contacts	List of contacts to cancel

Request

Route

POST /v1/campaigns/one/cancel

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "mQL9WPpJWq",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "contacts": [
    "+15551234568",
    "+15105551234"
  ]
}

cURL

curl "https://www.avochato.com/v1/campaigns/one/cancel" -d '{"auth_id":"mQL9WPpJWq","auth_secret":"YYYYYYYYYYYYYYYYYYYY","contacts":["+15551234568","+15105551234"]}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 10d1079c-7986-4a87-8d6c-aa7bfd7953b7
X-Runtime: 0.179943
Content-Length: 59

Body

{
  "status": 200,
  "data": {
    "campaigns": "Processing 2 entries."
  }
}

Remove single contact from campaign

Using your auth id + secret you can remove contacts from a campaign by their phone numbers

Endpoint

POST /v1/campaigns/:id/cancel

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
id required	(URL) Campaign keyword
phone	Phone number of the contact to cancel
contacts	List of contacts to cancel

Request

Route

POST /v1/campaigns/one/cancel

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "zPG9ypqbaO",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "phone": "+15105551234"
}

cURL

curl "https://www.avochato.com/v1/campaigns/one/cancel" -d '{"auth_id":"zPG9ypqbaO","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+15105551234"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 3b299fc3-7217-4a7a-afde-5619a0890a44
X-Runtime: 0.049497
Content-Length: 24

Body

{
  "status": 200,
  "data": {
  }
}

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/OobK11RJ7E%2Co48Omme9eA?auth_id=v5D9RwMJVA&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=v5D9RwMJVA
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/contacts/OobK11RJ7E%2Co48Omme9eA?auth_id=v5D9RwMJVA&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 52bcdc82-5027-4f8d-93bb-0739719eb809
X-Runtime: 0.076982
Content-Length: 897

Body

{
  "status": 200,
  "data": {
    "contacts": [
      {
        "id": "o48Omme9eA",
        "name": "Bob McTest",
        "phone": "+15551234567",
        "email": "bob@mctest.com",
        "street": null,
        "city": "Los Angeles",
        "state": "CA",
        "zip": "99999",
        "notes": null,
        "company": "McTest Inc",
        "other_phone": null,
        "created_at": 1636417893.64672,
        "tags": [
          "important"
        ],
        "opted_out": false,
        "double_opted_in": false,
        "muted": false,
        "blocked": null,
        "salesforce_object_type": null,
        "salesforce_object_id": null,
        "priority": 0,
        "user_id": null,
        "visible": true
      },
      {
        "id": "OobK11RJ7E",
        "name": "Other Contact",
        "phone": "+15551234568",
        "email": "bob@contact.com",
        "street": null,
        "city": "San Francisco",
        "state": "CA",
        "zip": "88888",
        "notes": null,
        "company": "Contact Inc",
        "other_phone": null,
        "created_at": 1636418493.69016,
        "tags": [

        ],
        "opted_out": false,
        "double_opted_in": false,
        "muted": false,
        "blocked": null,
        "salesforce_object_type": null,
        "salesforce_object_id": null,
        "priority": 0,
        "user_id": null,
        "visible": true
      }
    ]
  },
  "page": 1
}

Remove all contacts

Remove all contacts from this inbox.

Endpoint

DELETE /v1/contacts/remove_all

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
query	String. If query is empty or no query parameter is provided, remove all contacts from the contacts list in this inbox. If a query is provided, only contacts matching the query will be removed from this inbox.

Request

Route

DELETE /v1/contacts/remove_all

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "ZMvbXAZ9Rm",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "query": null
}

cURL

curl "https://www.avochato.com/v1/contacts/remove_all" -d '{"auth_id":"ZMvbXAZ9Rm","auth_secret":"YYYYYYYYYYYYYYYYYYYY","query":null}' -X DELETE \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: a67d1dac-0003-4746-a909-10b0f51fe509
X-Runtime: 0.022178
Content-Length: 58

Body

{
  "status": 200,
  "data": {
    "account": "account_28",
    "query": "*"
  }
}

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=wd6JmnL87m&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=name%3ABob+OR+city%3A%22San+Francisco%22&created_at%5Bfrom%5D=1636417834.133758&created_at%5Bto%5D=1636417954.133794&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=wd6JmnL87m
auth_secret=YYYYYYYYYYYYYYYYYYYY
query=name:Bob OR city:"San Francisco"
created_at={"from"=>"1636417834.133758", "to"=>"1636417954.133794"}
page=1

cURL

curl -g "https://www.avochato.com/v1/contacts?auth_id=wd6JmnL87m&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=name%3ABob+OR+city%3A%22San+Francisco%22&created_at%5Bfrom%5D=1636417834.133758&created_at%5Bto%5D=1636417954.133794&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 82a3b0db-9b56-4c26-9feb-a4a2d6ae0e78
X-Runtime: 0.042286
Content-Length: 462

Body

{
  "status": 200,
  "data": {
    "contacts": [
      {
        "id": "Dr8GzzdJPl",
        "name": "Bob McTest",
        "phone": "+15551234567",
        "email": "bob@mctest.com",
        "street": null,
        "city": "Los Angeles",
        "state": "CA",
        "zip": "99999",
        "notes": null,
        "company": "McTest Inc",
        "other_phone": null,
        "created_at": 1636417894.04332,
        "tags": [

        ],
        "opted_out": false,
        "double_opted_in": false,
        "muted": false,
        "blocked": null,
        "salesforce_object_type": null,
        "salesforce_object_id": null,
        "priority": 0,
        "user_id": null,
        "visible": true
      }
    ]
  },
  "page": 1
}

Update Multiple Contacts

Create or update multiple Contacts based on their phone numbers. Given a list of contacts, Avochato will attempt to update or create a record for each unique 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
contacts required	List of Contacts
contacts[n][phone] required	Phone number of Contact
contacts[n][name]	Name of the Contact
contacts[n][email]	Email for the Contact
contacts[n][other_phone]	Other phone for the Contact
contacts[n][company]	Company Name for the Contact
contacts[n][street]	Street for the Contact
contacts[n][city]	City for the Contact
contacts[n][state]	State for the Contact
contacts[n][zip]	Zip Code for the Contact
contacts[n][country]	Country for the Contact
contacts[n][opted_out]	Opted-out status of the Contact. Avochato will prevent any outbound message to an opted out contact.
contacts[n][double_opted_in]	Boolean, 0 or 1. Update the Double Opt-in status of the contact.
contacts[n][muted]	Boolean, 0 or 1. Mute or unmute the Contact to suppress calls and notifications from them.
contacts[n][blocked]	Boolean, 0 or 1. Block or unblock the Contact to prevent all calls and texts to and from them.
contacts[n][priority]	Integer, 0 through 5. Sets a priority level for the contact, 5 is the greatest.
contacts[n][visible]	Boolean, 0 or 1. Visibility status of the Contact. Set to 0 to remove the contact.
contacts[n][custom_variable_name]	Custom field to set for the Contact
contacts[n][tags]	CSV of tags to apply to the Contact
contacts[n][user_id]	User ID or Email of a User that is responsible for this contact. Assigns all conversations to the user when set.
contacts[n][salesforce_object_id]	Salesforce object id
contacts[n][salesforce_object_type]	Salesforce object type
allow_empty_fields	Boolean, 0 or 1. Permit overwriting custom fields with empty or null value (defaults to 0)

Request

Route

POST /v1/contacts

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "ezjJ77XJ5y",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "contacts": [
    {
      "phone": "+14155553333",
      "name": "Bob McTest",
      "email": "contact@example.com",
      "company": "Example Inc.",
      "street": "123 Main St.",
      "city": "SF",
      "state": "CA",
      "zip": "99999",
      "country": "USA",
      "opted_out": false,
      "visible": true,
      "custom_variable_name": "value to set custom variable",
      "tags": "red,green,blue",
      "user_id": "teammate@example.com",
      "salesforce_object_id": "0030030000000014cAAA",
      "salesforce_object_type": "Contact"
    }
  ]
}

cURL

curl "https://www.avochato.com/v1/contacts" -d '{"auth_id":"ezjJ77XJ5y","auth_secret":"YYYYYYYYYYYYYYYYYYYY","contacts":[{"phone":"+14155553333","name":"Bob McTest","email":"contact@example.com","company":"Example Inc.","street":"123 Main St.","city":"SF","state":"CA","zip":"99999","country":"USA","opted_out":false,"visible":true,"custom_variable_name":"value to set custom variable","tags":"red,green,blue","user_id":"teammate@example.com","salesforce_object_id":"0030030000000014cAAA","salesforce_object_type":"Contact"}]}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 77c8653b-8f0f-46d5-8df5-c155c27f51c9
X-Runtime: 0.180149
Content-Length: 563

Body

{
  "status": 200,
  "data": {
    "contact": {
      "id": "Egb5WWeJej",
      "name": "Bob McTest",
      "phone": "+14155553333",
      "email": "contact@example.com",
      "street": "123 Main St.",
      "city": "SF",
      "state": "CA",
      "zip": "99999",
      "notes": null,
      "company": "Example Inc.",
      "other_phone": null,
      "created_at": 1636418494.52128,
      "tags": [
        "blue",
        "green",
        "red"
      ],
      "opted_out": false,
      "double_opted_in": false,
      "muted": false,
      "blocked": null,
      "salesforce_object_type": "Contact",
      "salesforce_object_id": "0030030000000014cAAA",
      "priority": 0,
      "user_id": "OobK1yrJ7E",
      "visible": true,
      "custom_variable_name": "value to set custom variable"
    }
  }
}

Update Single Contact

Create or update a single 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	Email for the Contact
other_phone	Other phone for the Contact
company	Company Name for the Contact
street	Street for the Contact
city	City for the Contact
state	State for the Contact
zip	Zip Code for the Contact
country	Country for the Contact
opted_out	Opted-out status of the Contact. Avochato will prevent any outbound message to an opted out contact.
double_opted_in	Boolean, 0 or 1. Update the Double Opt-in status of the contact.
muted	Boolean, 0 or 1. Mute or unmute the Contact to suppress calls and notifications from them.
blocked	Boolean, 0 or 1. Block or unblock the Contact to prevent all calls and texts to and from them.
priority	Integer, 0 through 5. Sets a priority level for the contact, 5 is the greatest.
visible	Boolean, 0 or 1. Visibility status of the Contact. Set to 0 to remove the contact.
custom_variable_name	Custom variable to set for the Contact
tags	CSV of tags to apply to the Contact
user_id	User ID or Email of a User that is responsible for this contact. Assigns all conversations to the user when set.
salesforce_object_id	Salesforce object id
salesforce_object_type	Salesforce object type
allow_empty_fields	Boolean, 0 or 1. Permit overwriting custom fields with empty or null value (defaults to 0)

Request

Route

POST /v1/contacts

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "VePJlzabar",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "phone": "+14155553333",
  "name": "Bob McTest",
  "email": "contact@example.com",
  "company": "Example Inc.",
  "street": "123 Main St.",
  "city": "SF",
  "state": "CA",
  "zip": "99999",
  "country": "USA",
  "opted_out": false,
  "visible": true,
  "custom_variable_name": "value to set custom variable",
  "tags": "red,green,blue",
  "user_id": "teammate@example.com",
  "salesforce_object_id": "0030030000000014cAAA",
  "salesforce_object_type": "Contact"
}

cURL

curl "https://www.avochato.com/v1/contacts" -d '{"auth_id":"VePJlzabar","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+14155553333","name":"Bob McTest","email":"contact@example.com","company":"Example Inc.","street":"123 Main St.","city":"SF","state":"CA","zip":"99999","country":"USA","opted_out":false,"visible":true,"custom_variable_name":"value to set custom variable","tags":"red,green,blue","user_id":"teammate@example.com","salesforce_object_id":"0030030000000014cAAA","salesforce_object_type":"Contact"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 31ac4438-0db5-4dc2-a52e-5179f992e3c8
X-Runtime: 0.088768
Content-Length: 535

Body

{
  "status": 200,
  "data": {
    "contact": {
      "id": "OLb4pp3b4Y",
      "name": "Bob McTest",
      "phone": "+14155553333",
      "email": "contact@example.com",
      "street": "123 Main St.",
      "city": "SF",
      "state": "CA",
      "zip": "99999",
      "notes": null,
      "company": "Example Inc.",
      "other_phone": null,
      "created_at": 1636418494.32035,
      "tags": [

      ],
      "opted_out": false,
      "double_opted_in": false,
      "muted": false,
      "blocked": null,
      "salesforce_object_type": "Contact",
      "salesforce_object_id": "0030030000000014cAAA",
      "priority": 0,
      "user_id": null,
      "visible": true,
      "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/eAbZnv0bDM/events

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "3o48OyQ9eA",
  "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/eAbZnv0bDM/events" -d '{"auth_id":"3o48OyQ9eA","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

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 357d66b8-7397-4844-b033-c899d3382477
X-Runtime: 0.037065
Content-Length: 326

Body

{
  "status": 200,
  "data": {
    "event": {
      "user_id": "EG8jnGN8Ql",
      "account_id": "LP9MzBYJqY",
      "ticket_id": "QL9WLMxJWq",
      "contact_id": "eAbZnv0bDM",
      "type": "sale",
      "context": "Wanted a new watch ($99.99) with no warranty",
      "revenue": 99.99,
      "event_id": "ZA9PlPn9rw",
      "element_id": "z1N8xM6b37",
      "element_type": "CustomEvent",
      "sent_at": 1636418488.59593
    }
  }
}

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.com

Body

{
  "auth_id": "YOobKqXJ7E",
  "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":"YOobKqXJ7E","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

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: cf817626-f852-4255-ab17-14fcc69cb3b4
X-Runtime: 0.043360
Content-Length: 338

Body

{
  "status": 200,
  "data": {
    "event": {
      "user_id": "lYJp63Lbmw",
      "account_id": "AnJQLMO9y1",
      "ticket_id": "Egb56jP9ej",
      "contact_id": "oWbq7pXJqn",
      "type": "sale",
      "context": "Bought an avocado ($2) and was interested in a subscription",
      "revenue": 2.0,
      "event_id": "EG8jAy5JQl",
      "element_id": "BDr8GzNJPl",
      "element_type": "CustomEvent",
      "sent_at": 1636418488.8851
    }
  }
}

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/ZA9Plm19rw/events

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "PDz9njg9e3",
  "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/ZA9Plm19rw/events" -d '{"auth_id":"PDz9njg9e3","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

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: b18559d8-21c1-4810-9bd3-0be10c052737
X-Runtime: 0.072895
Content-Length: 329

Body

{
  "status": 200,
  "data": {
    "event": {
      "user_id": "3y83W3n8VN",
      "account_id": "xB9NQk0bYO",
      "ticket_id": "ZA9Plm19rw",
      "contact_id": "webomaeJXm",
      "type": "sale",
      "context": "Wanted one hat ($10) and upsold warranty ($5.50)",
      "revenue": 15.5,
      "event_id": "OobKaPXJ7E",
      "element_id": "v7Mb6kG9ER",
      "element_type": "CustomEvent",
      "sent_at": 1636418488.26081
    }
  }
}

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/OLb4Wjr84Y/events?auth_id=1LxJDe48n2&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=1LxJDe48n2
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/tickets/OLb4Wjr84Y/events?auth_id=1LxJDe48n2&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: d79aea76-0683-40c7-9bb5-b57b5ee6c424
X-Runtime: 0.091626
Content-Length: 2305

Body

{
  "status": 200,
  "data": {
    "events": [
      {
        "account_id": "nL8aAOd87N",
        "ticket_id": "OLb4Wjr84Y",
        "user_id": "oWbq7MBJqn",
        "status": "Closed",
        "event_id": "vnJA1noJAD",
        "element_id": "wd6Jmxp97m",
        "element_type": "StatusChange",
        "sent_at": 1636418487.89697
      },
      {
        "account_id": "nL8aAOd87N",
        "call_from": "+15551234567",
        "call_to": "+15558888888",
        "voicemail": null,
        "direction": "in",
        "call_status": "completed",
        "ended_at": 0.0,
        "duration": 119,
        "segments": 2,
        "event_id": "xk9ELg6bRK",
        "element_id": "0N6bwkvbDM",
        "element_type": "Call",
        "sent_at": 1636418487.89098
      },
      {
        "uuid": "d8aa749d-2671-4e6f-8bd3-148dc4c24710",
        "account_id": "nL8aAOd87N",
        "ticket_id": "OLb4Wjr84Y",
        "contact_id": "PG9yw3k8aO",
        "sender_id": "oWbq7MBJqn",
        "sender_type": "User",
        "to": null,
        "from": null,
        "direction": "out",
        "origin": null,
        "message": "Sorry in a meeting but can call afterwards",
        "contents": [

        ],
        "segments": 1,
        "carrier": null,
        "external_id": null,
        "status": "queued",
        "error_code": 0,
        "reason": null,
        "status_callback": null,
        "created_at": 1636418487.8042,
        "sent_at": 1636418487.82684,
        "event_id": "5V9VxPM8lr",
        "element_id": "0nMJL5N8vZ",
        "element_type": "SmsMessage"
      },
      {
        "uuid": "3fc0d419-46f9-4cfc-a35f-12e1b7540670",
        "account_id": "nL8aAOd87N",
        "ticket_id": "OLb4Wjr84Y",
        "contact_id": "PG9yw3k8aO",
        "sender_id": "oWbq7MBJqn",
        "sender_type": "User",
        "to": null,
        "from": null,
        "direction": "out",
        "origin": null,
        "message": "Hey there Bob let me know when we can talk!",
        "contents": [

        ],
        "segments": 1,
        "carrier": null,
        "external_id": null,
        "status": "queued",
        "error_code": 0,
        "reason": null,
        "status_callback": null,
        "created_at": 1636418487.70782,
        "sent_at": 1636418487.74364,
        "event_id": "3NbrBnDbr6",
        "element_id": "WAnJQ5LJy1",
        "element_type": "SmsMessage"
      },
      {
        "account_id": "nL8aAOd87N",
        "call_from": "+15558888888",
        "call_to": "+15551234567",
        "voicemail": null,
        "direction": "out",
        "call_status": "completed",
        "ended_at": 0.0,
        "duration": 10,
        "segments": 1,
        "event_id": "N6bwZRO8DM",
        "element_id": "qQR91og8ge",
        "element_type": "Call",
        "sent_at": 1636418487.68631
      },
      {
        "account_id": "nL8aAOd87N",
        "ticket_id": "OLb4Wjr84Y",
        "user_id": "oWbq7MBJqn",
        "status": "Open",
        "event_id": "QR91Dmobge",
        "element_id": "ZMvbX748Rm",
        "element_type": "StatusChange",
        "sent_at": 1636418487.66112
      },
      {
        "account_id": "nL8aAOd87N",
        "ticket_id": "OLb4Wjr84Y",
        "user_id": "oWbq7MBJqn",
        "owner_id": "oWbq7MBJqn",
        "event_id": "Rg80KXyJj0",
        "element_id": "WAnJQ2v8y1",
        "element_type": "OwnerChange",
        "sent_at": 1636418487.63088
      }
    ]
  },
  "page": 1
}

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.com

Body

{
  "auth_id": "0N6bwNO8DM",
  "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":"0N6bwNO8DM","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

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: a5c6651e-e950-44a4-a6c4-e39ad2760cec
X-Runtime: 0.153657
Content-Length: 233

Body

{
  "status": 200,
  "data": {
    "link": {
      "id": "3Ynbgne8ae",
      "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/kvnJA1eJAD%2CNEnJdnQbRm?auth_id=qQR91voJge&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=qQR91voJge
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/links/kvnJA1eJAD%2CNEnJdnQbRm?auth_id=qQR91voJge&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 9e0d5776-1926-4ab7-b9bf-c9741d15bb31
X-Runtime: 0.020048
Content-Length: 485

Body

{
  "status": 200,
  "data": {
    "contacts": [
      {
        "id": "NEnJdnQbRm",
        "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": "kvnJA1eJAD",
        "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=KRg80Zy9j0&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=KRg80Zy9j0
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/links?auth_id=KRg80Zy9j0&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 1c96db91-9ecd-43ac-97c9-6149fb45fa1d
X-Runtime: 0.057411
Content-Length: 482

Body

{
  "status": 200,
  "data": {
    "links": [
      {
        "id": "qxk9ELVbRK",
        "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": "k5V9Vxz8lr",
        "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

Search for matching Messages in an account based on a query.

Endpoint

GET /v1/messages

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
query	Query to search Messages (default: iterate through all messages)	string
page	Page to request (default: 1)	integer
direction	Direction of the message ("in" for received messages, "out" for sent messages)	string
status	Message delivery status (ie: queued, delivered, undelivered, failed)	string
from	Phone number message was sent from	string
to	Phone number message was sent to	string
created_at[from]	Select messages created after this date	unix_timestamp
created_at[to]	Select messages created before this date (default: now)	unix_timestamp

Request

Route

GET /v1/messages?auth_id=1K2b2kj9WR&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=hear&page=1&direction=in&status=delivered&from=%2B15105551234&to=%2B14155551234&created_at%5Bfrom%5D=1636412490.227594&created_at%5Bto%5D=1636418550.227652

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=1K2b2kj9WR
auth_secret=YYYYYYYYYYYYYYYYYYYY
query=hear
page=1
direction=in
status=delivered
from=+15105551234
to=+14155551234
created_at={"from"=>"1636412490.227594", "to"=>"1636418550.227652"}

cURL

curl -g "https://www.avochato.com/v1/messages?auth_id=1K2b2kj9WR&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=hear&page=1&direction=in&status=delivered&from=%2B15105551234&to=%2B14155551234&created_at%5Bfrom%5D=1636412490.227594&created_at%5Bto%5D=1636418550.227652" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 4f2e2727-6123-4e5e-91ba-88e115983f7e
X-Runtime: 0.086858
Content-Length: 608

Body

{
  "status": 200,
  "data": {
    "messages": [
      {
        "uuid": "a4cf6b1d-ea4c-4936-950c-9832ccb63557",
        "account_id": "3NbrBjObr6",
        "ticket_id": "MvbX0QObRm",
        "contact_id": "DjJBNnmJoO",
        "sender_id": null,
        "sender_type": null,
        "to": "+14155551234",
        "from": "+15105551234",
        "direction": "in",
        "origin": null,
        "message": "I kept hearing that you had great service 😀!",
        "contents": [

        ],
        "segments": 1,
        "carrier": null,
        "external_id": null,
        "status": "delivered",
        "error_code": 0,
        "reason": null,
        "status_callback": null,
        "created_at": 1636418490.16605,
        "sent_at": 1636418490.18145,
        "event_id": "jRbkRye81P",
        "element_id": "NEnJd5D8Rm",
        "element_type": "SmsMessage"
      }
    ]
  },
  "page": 1
}

Search Messages by timestamp

Search for matching Messages based on a query

Endpoint

GET /v1/messages

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
query	Query to search Messages (default: iterate through all messages)	string
page	Page to request (default: 1)	integer
direction	Direction of the message ("in" for received messages, "out" for sent messages)	string
status	Message delivery status (ie: queued, delivered, undelivered, failed)	string
from	Phone number message was sent from	string
to	Phone number message was sent to	string
created_at[from]	Select messages created after this date	unix_timestamp
created_at[to]	Select messages created before this date (default: now)	unix_timestamp

Request

Route

GET /v1/messages?auth_id=Pe6bedR8Xw&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=hear&page=1&direction&status=delivered&from=%2B15105551234&to=%2B14155551234&created_at%5Bfrom%5D=1636418430.581555&created_at%5Bto%5D=1636418550.581589&document=false

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=Pe6bedR8Xw
auth_secret=YYYYYYYYYYYYYYYYYYYY
query=hear
page=1
direction=
status=delivered
from=+15105551234
to=+14155551234
created_at={"from"=>"1636418430.581555", "to"=>"1636418550.581589"}
document=false

cURL

curl -g "https://www.avochato.com/v1/messages?auth_id=Pe6bedR8Xw&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=hear&page=1&direction&status=delivered&from=%2B15105551234&to=%2B14155551234&created_at%5Bfrom%5D=1636418430.581555&created_at%5Bto%5D=1636418550.581589&document=false" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: ef3f0d84-1bf0-470e-8379-0a59809f4d98
X-Runtime: 0.038312
Content-Length: 608

Body

{
  "status": 200,
  "data": {
    "messages": [
      {
        "uuid": "df3d6663-282e-45fb-abed-8c8dfa28819a",
        "account_id": "5V9Vxwr8lr",
        "ticket_id": "ePJl7N59ar",
        "contact_id": "nL8ajAwb7N",
        "sender_id": null,
        "sender_type": null,
        "to": "+14155551234",
        "from": "+15105551234",
        "direction": "in",
        "origin": null,
        "message": "I kept hearing that you had great service 😀!",
        "contents": [

        ],
        "segments": 1,
        "carrier": null,
        "external_id": null,
        "status": "delivered",
        "error_code": 0,
        "reason": null,
        "status_callback": null,
        "created_at": 1636418490.51692,
        "sent_at": 1636418490.53196,
        "event_id": "xB9NQPxbYO",
        "element_id": "RkAJv0zb0o",
        "element_type": "SmsMessage"
      }
    ]
  },
  "page": 1
}

Send Message

Send a Message to any Contact based on their phone

Endpoint

POST /v1/messages

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
phone required	Phone number to send the message to	string
message required	Text to send to the recipient	string
from	(E.164 format) Phone Number to use to send this message. Must be a valid Avochato number that belongs to this inbox.	string
mark_addressed	Mark this conversation as "addressed" (default: false)	boolean
media_url	Media attachment to send via MMS (500kb limit)	url
tags	Comma-separated list of tags to apply to this contact	string
status_callback	Send a callback via http POST to this domain when the delivery status is updated	url

Request

Route

POST /v1/messages

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "3OLb4XRb4Y",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "phone": "+14155553333",
  "message": "test message",
  "from": "+15105551234",
  "mark_addressed": "true",
  "tags": "Some Tag, Another Tag",
  "status_callback": "https://my.domain.com"
}

cURL

curl "https://www.avochato.com/v1/messages" -d '{"auth_id":"3OLb4XRb4Y","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+14155553333","message":"test message","from":"+15105551234","mark_addressed":"true","tags":"Some Tag, Another Tag","status_callback":"https://my.domain.com"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 8e3b5ef6-8c8f-4126-90ac-36ab733be369
X-Runtime: 0.271246
Content-Length: 583

Body

{
  "status": 200,
  "data": {
    "message": {
      "uuid": "8b707d5a-4072-42f5-ac3f-592a8d1e8248",
      "account_id": "xk9ELZBbRK",
      "ticket_id": "nL8aA2j87N",
      "contact_id": "nMJLNy3bvZ",
      "sender_id": "AnJQz2K8y1",
      "sender_type": "User",
      "to": "+14155553333",
      "from": null,
      "direction": "out",
      "origin": "api",
      "message": "test message",
      "contents": [

      ],
      "segments": 1,
      "carrier": "twilio",
      "external_id": null,
      "status": "queued",
      "error_code": 0,
      "reason": null,
      "status_callback": "https://my.domain.com",
      "created_at": 1636418491.06657,
      "sent_at": 1636418491.06401,
      "event_id": "Rg80K2yJj0",
      "element_id": "PDz9n7gJe3",
      "element_type": "SmsMessage"
    }
  }
}

Send a Scheduled Message

Schedule a Message to deliver to a Contact at a specific date and time in the future

Endpoint

POST /v1/messages

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
phone required	Phone number to send the message to	string
message required	Text to send to the recipient	string
scheduled_for required	Unix Timestamp, Schedule this message to send at a date in the future	unix_timestamp
from	(E.164 format) Phone Number to use to send this message. Must be a valid Avochato number that belongs to this inbox.	string
mark_addressed	Mark this conversation as "addressed" (default: false)	boolean
media_url	Media attachment to send via MMS (500kb limit)	url
tags	Comma-separated list of tags to apply to this contact	string
status_callback	Send a callback via http POST to this domain when the delivery status is updated	url

Request

Route

POST /v1/messages

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "EZA9PRn8rw",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "phone": "+14155553333",
  "message": "test message",
  "scheduled_for": 1636419091.52388,
  "from": "+15105551234",
  "mark_addressed": "true",
  "tags": "Some Tag, Another Tag",
  "status_callback": "https://my.domain.com"
}

cURL

curl "https://www.avochato.com/v1/messages" -d '{"auth_id":"EZA9PRn8rw","auth_secret":"YYYYYYYYYYYYYYYYYYYY","phone":"+14155553333","message":"test message","scheduled_for":1636419091.52388,"from":"+15105551234","mark_addressed":"true","tags":"Some Tag, Another Tag","status_callback":"https://my.domain.com"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 39855b99-1207-4183-a901-bd44bf116770
X-Runtime: 0.145085
Content-Length: 451

Body

{
  "status": 200,
  "data": {
    "message": {
      "account_id": "vnJA1WOJAD",
      "ticket_id": "AnJQLrK9y1",
      "contact_id": "N6bwQZlJDM",
      "sender": "person_21",
      "message": "test message",
      "media_url": null,
      "aborted": false,
      "sent": {
        "element_id": null,
        "element_type": null
      },
      "scheduled_for": 1636419091.0,
      "cancel_on": null,
      "aborter_id": null,
      "aborted_by": "User",
      "abort_reason": null,
      "event_id": "5V9VxnM8lr",
      "element_id": "BLP9MzeJqY",
      "element_type": "PendingMessage",
      "sent_at": 1636418491.63532
    }
  }
}

Ticket Assignment

Ticket Assignment represents which user on your team owns a conversation. The owner assigned to a conversation will receive notifications of incoming calls and texts from that contact.

Auto Assign

You can automatically reassign one or more Tickets to any user in the Auto Assignment Roster by id. If there are no active users in your Auto Assignment Roster, ownership will remain unchanged. See Settings > Auto Assignment

Endpoint

PUT /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
user_id required	autoassign	string

Request

Route

PUT /v1/tickets/weboaLBJXm

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "v7Mb6lAJER",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "user_id": "autoassign"
}

cURL

curl "https://www.avochato.com/v1/tickets/weboaLBJXm" -d '{"auth_id":"v7Mb6lAJER","auth_secret":"YYYYYYYYYYYYYYYYYYYY","user_id":"autoassign"}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: a9e5967e-9172-4222-bfc9-216c994b4aaa
X-Runtime: 0.166652
Content-Length: 370

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "weboaLBJXm",
        "uuid": "bc5afca2-bcfe-4f60-9adf-9fadf684d322",
        "contact": "EG8jnAO8Ql",
        "user_id": "MvbX7qO8Rm",
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418489.002201,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  }
}

Unassign

You can unassign one or more Tickets by id.

Endpoint

PUT /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
user_id required	unassign	string

Request

Route

PUT /v1/tickets/5D9R07x8VA

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "EDR8zqeJA2",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "user_id": "unassign"
}

cURL

curl "https://www.avochato.com/v1/tickets/5D9R07x8VA" -d '{"auth_id":"EDR8zqeJA2","auth_secret":"YYYYYYYYYYYYYYYYYYYY","user_id":"unassign"}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: e690af21-2f65-4fe1-b61e-ea600bf9cba8
X-Runtime: 0.070518
Content-Length: 362

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "5D9R07x8VA",
        "uuid": "a1852086-f302-46d4-aa5b-0f82c22c647a",
        "contact": "zjJ7W6PJ5y",
        "user_id": null,
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418489.848063,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  }
}

Update Assignment with user_email

You can assign a User to be the owner of one or more Tickets by email.

Endpoint

PUT /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
user_email	User email of the new owner	string

Request

Route

PUT /v1/tickets/oWbqp1B8qn%2CeAbZv0abDM

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "z1N8xpj837",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "user_email": "person_8@example.com"
}

cURL

curl "https://www.avochato.com/v1/tickets/oWbqp1B8qn%2CeAbZv0abDM" -d '{"auth_id":"z1N8xpj837","auth_secret":"YYYYYYYYYYYYYYYYYYYY","user_email":"person_8@example.com"}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 36af5fa2-4ae6-4783-8c1a-23fa513fc5a1
X-Runtime: 0.143977
Content-Length: 708

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "eAbZv0abDM",
        "uuid": "4f281f9a-850a-4f8b-b129-e815455eab57",
        "contact": "lYJp6lobmw",
        "user_id": "ePJlYv58ar",
        "unaddressed": false,
        "status": "Pending",
        "origin": "Avochato",
        "created_at": 1636418489.306066,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      },
      {
        "id": "oWbqp1B8qn",
        "uuid": "8ee8bf85-8fa2-4efb-8735-680e6ccbb3c7",
        "contact": "5D9RB0G9VA",
        "user_id": "ePJlYv58ar",
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418489.330812,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  }
}

Update Assignment with user_id

You can assign a User to be the owner of one or more Tickets by id.

Endpoint

PUT /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
user_id	User ID of the new owner	string

Request

Route

PUT /v1/tickets/EG8jAkNJQl%2C3y832jnJVN

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "BDr8GxVbPl",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "user_id": "DjJBNR6JoO"
}

cURL

curl "https://www.avochato.com/v1/tickets/EG8jAkNJQl%2C3y832jnJVN" -d '{"auth_id":"BDr8GxVbPl","auth_secret":"YYYYYYYYYYYYYYYYYYYY","user_id":"DjJBNR6JoO"}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: f1267cbc-e8a6-46c5-96ba-8d7763cf9164
X-Runtime: 0.116395
Content-Length: 708

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "3y832jnJVN",
        "uuid": "14c4a402-8a47-4c2a-b5eb-c7a2c5035fcf",
        "contact": "MvbX70D8Rm",
        "user_id": "DjJBNR6JoO",
        "unaddressed": false,
        "status": "Pending",
        "origin": "Avochato",
        "created_at": 1636418489.573771,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      },
      {
        "id": "EG8jAkNJQl",
        "uuid": "cffeb752-a859-48c1-9599-302dbc9def41",
        "contact": "d6Jmxz497m",
        "user_id": "DjJBNR6JoO",
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418489.596555,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  }
}

Ticket Status

Ticket Status represents the state of a conversation, and can be used to organize your inbox. Tickets marked as Closed are archived and do not appear in the inbox by default.

Close a Ticket

Mark one or more Tickets as Closed. Note: this will also automatically mark the ticket as ‘Addressed’

Endpoint

PUT /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
status	Use the 'Closed' Status to close a ticket	string

Request

Route

PUT /v1/tickets/vnJA1gnJAD

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "xoWbqWLJqn",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "status": "Closed"
}

cURL

curl "https://www.avochato.com/v1/tickets/vnJA1gnJAD" -d '{"auth_id":"xoWbqWLJqn","auth_secret":"YYYYYYYYYYYYYYYYYYYY","status":"Closed"}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 1a6c2d5e-ecca-46b7-8755-75bc6d5d6ae0
X-Runtime: 0.103245
Content-Length: 372

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "vnJA1gnJAD",
        "uuid": "39723208-91c3-487e-ad9a-2092b43d2f8c",
        "contact": "YnbgEE6Jae",
        "user_id": "xk9EznEJRK",
        "unaddressed": false,
        "status": "Closed",
        "origin": "Avochato",
        "created_at": 1636418493.011041,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  }
}

Update Status

You can update the status of one or more Tickets

Endpoint

PUT /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
status	The current Ticket Status. Options include "New", Open", "Pending", "Closed"	string

Request

Route

PUT /v1/tickets/webYqDmbaE%2CEnJdn2pbRm

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "43y83ad9VN",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "status": "Pending"
}

cURL

curl "https://www.avochato.com/v1/tickets/webYqDmbaE%2CEnJdn2pbRm" -d '{"auth_id":"43y83ad9VN","auth_secret":"YYYYYYYYYYYYYYYYYYYY","status":"Pending"}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: bff6fb61-0eea-44fb-89c7-bc0030e7c28b
X-Runtime: 0.110298
Content-Length: 705

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "EnJdn2pbRm",
        "uuid": "dbda06ec-b4d7-4dfd-8c76-86a7cde4114e",
        "contact": "LxJD55E8n2",
        "user_id": null,
        "unaddressed": false,
        "status": "Pending",
        "origin": "Avochato",
        "created_at": 1636418493.2290409,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      },
      {
        "id": "webYqDmbaE",
        "uuid": "713306a2-308e-4b61-9e0e-d49600c08852",
        "contact": "Dz9nXXj8e3",
        "user_id": "vnJAvln8AD",
        "unaddressed": false,
        "status": "Pending",
        "origin": "Avochato",
        "created_at": 1636418493.2574332,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  }
}

Tickets

Tickets represent a unique conversation with a Contact in an Avochato Account.

Fetch Previous Tickets

You can fetch information about previous tickets by source ticket id

Endpoint

GET /v1/tickets/:id/previous

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
id required	(URL parameter) Source Ticket id	string

Request

Route

GET /v1/tickets/e6beaRMbXw/previous?auth_id=WAnJQWLby1&auth_secret=YYYYYYYYYYYYYYYYYYYY

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=WAnJQWLby1
auth_secret=YYYYYYYYYYYYYYYYYYYY

cURL

curl -g "https://www.avochato.com/v1/tickets/e6beaRMbXw/previous?auth_id=WAnJQWLby1&auth_secret=YYYYYYYYYYYYYYYYYYYY" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 08a43001-65c3-4c31-8b21-ab09ecc5b445
X-Runtime: 0.025820
Content-Length: 325

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "K2b2xa7JWR",
        "uuid": "87ef0c80-fbda-4030-acd7-cac41f5eb2a0",
        "channel": "sms",
        "contact": "5D9RBBG9VA",
        "created_at": 1636418495.59309,
        "closed_at": 1636414895.5902,
        "user": {
          "id": "ZA9P4019rw",
          "name": "Person 29"
        },
        "device_type": null,
        "option_data": null,
        "tags": [

        ],
        "account_subdomain": "account_36"
      }
    ]
  }
}

Fetch Tickets

You can fetch Tickets by ids

Endpoint

GET /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
page	Page to request

Request

Route

GET /v1/tickets/Dz9nV219e3%2COobKaMrJ7E?auth_id=PxB9NVx9YO&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=PxB9NVx9YO
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/tickets/Dz9nV219e3%2COobKaMrJ7E?auth_id=PxB9NVx9YO&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 2cd505b2-ed3c-4305-84f1-b65c78c5c1fe
X-Runtime: 0.029206
Content-Length: 710

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "OobKaMrJ7E",
        "uuid": "84ebb564-420c-4a55-945d-69ab141c36b1",
        "contact": "oWbq77XJqn",
        "user_id": "e6beWrMJXw",
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418495.2045069,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      },
      {
        "id": "Dz9nV219e3",
        "uuid": "5aa2d6ed-1e07-4fe9-8991-ad914badc17e",
        "contact": "eAbZnn0bDM",
        "user_id": null,
        "unaddressed": false,
        "status": "Pending",
        "origin": "Avochato",
        "created_at": 1636418495.154303,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  },
  "page": 1
}

List all Tickets

You can retrieve a paginated list of all Tickets within an account

Endpoint

GET /v1/tickets

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
page	Page to request

Request

Route

GET /v1/tickets?auth_id=enL8a1O87N&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=enL8a1O87N
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/tickets?auth_id=enL8a1O87N&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: b96032a6-d6f3-4d8d-ac73-705e3f176494
X-Runtime: 0.035142
Content-Length: 710

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "LxJDvmqbn2",
        "uuid": "83af0461-02ff-4b9b-9c4a-a08861ccaf76",
        "contact": "webommeJXm",
        "user_id": "K2b2qg78WR",
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418495.021421,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      },
      {
        "id": "kAJvDkWb0o",
        "uuid": "3e5ddfc4-869e-4b14-9aa5-8fa096b17b0a",
        "contact": "PG9ywwk8aO",
        "user_id": null,
        "unaddressed": false,
        "status": "Pending",
        "origin": "Avochato",
        "created_at": 1636418494.9539158,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  },
  "page": 1
}

Search Tickets

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=BLP9Mer9qY&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=status%3AOpen&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=BLP9Mer9qY
auth_secret=YYYYYYYYYYYYYYYYYYYY
query=status:Open
page=1

cURL

curl -g "https://www.avochato.com/v1/tickets?auth_id=BLP9Mer9qY&auth_secret=YYYYYYYYYYYYYYYYYYYY&query=status%3AOpen&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 971cdd7d-1dfd-40b5-b19b-18274bebb754
X-Runtime: 0.050888
Content-Length: 379

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "Dr8GnBRJPl",
        "uuid": "d3a2f1b6-a269-47af-af7d-4b79d415dde2",
        "contact": "EG8jnnO8Ql",
        "user_id": "OLb4p2rb4Y",
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418495.395822,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  },
  "page": 1
}

Update Unaddressed

You can mark a ticket as Addressed or Unaddressed automatically

Endpoint

PUT /v1/tickets/:ids

Parameters

Name	Description	type
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
ids required	(URL parameter) Comma separated list of Ticket id(s)	string
unaddressed	Flag whether the current ticket remains unaddressed. True or False	boolean

Request

Route

PUT /v1/tickets/QL9WLvxJWq

Headers

Content-Type: application/json
Host: www.avochato.com

Body

{
  "auth_id": "0nMJLeN8vZ",
  "auth_secret": "YYYYYYYYYYYYYYYYYYYY",
  "unaddressed": false
}

cURL

curl "https://www.avochato.com/v1/tickets/QL9WLvxJWq" -d '{"auth_id":"0nMJLeN8vZ","auth_secret":"YYYYYYYYYYYYYYYYYYYY","unaddressed":false}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: d1c32b5f-6b48-4929-99f4-fa47d6b296df
X-Runtime: 0.057824
Content-Length: 370

Body

{
  "status": 200,
  "data": {
    "tickets": [
      {
        "id": "QL9WLvxJWq",
        "uuid": "97f52b4a-041c-47d3-a7bc-bcfa605669e1",
        "contact": "d6Jmxx497m",
        "user_id": "QL9Wyex8Wq",
        "unaddressed": false,
        "status": "Open",
        "origin": "Avochato",
        "created_at": 1636418495.818435,
        "device_type": null,
        "device": null,
        "os": null,
        "os_version": null,
        "browser": null,
        "browser_version": null,
        "ip": null,
        "widget_referrer_url": null
      }
    ]
  }
}

Users

Users represent a unique user an Avochato Account.

List all Users

You can retrieve a paginated list of all Users within an account

Endpoint

GET /v1/users

Parameters

Name	Description
auth_id required	Auth Id field
auth_secret required	Authentication Secret field
page	Page of users to request

Request

Route

GET /v1/users?auth_id=2jRbkve81P&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1

Headers

Content-Type: application/json
Host: www.avochato.com

Query Parameters

auth_id=2jRbkve81P
auth_secret=YYYYYYYYYYYYYYYYYYYY
page=1

cURL

curl -g "https://www.avochato.com/v1/users?auth_id=2jRbkve81P&auth_secret=YYYYYYYYYYYYYYYYYYYY&page=1" -X GET \
	-H "Content-Type: application/json" \
	-H "Host: www.avochato.com"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 4daacf15-b9f0-4c52-bb05-53afa47f50c7
X-Runtime: 0.080201
Content-Length: 251

Body

{
  "status": 200,
  "data": {
    "users": [
      {
        "email": "person_22@example.com",
        "id": "1N8xMONb37",
        "name": "Person 25"
      },
      {
        "email": "bob.mctest@test.com",
        "id": "Dr8GzDRJPl",
        "name": "Bob McTest"
      },
      {
        "email": "other.bob@test.com",
        "id": "DR8zpyP9A2",
        "name": "Other Bob"
      }
    ]
  },
  "page": 1
}

Avochato API

Accounts

Fetch Accounts

Endpoint

Parameters

Request

Route

Headers

Query Parameters

cURL

Response

Status

Headers

Body

List Accounts

Endpoint

Parameters

Request

Route

Headers

Query Parameters

cURL

Response

Status

Headers

Body

Broadcasts

Create Broadcast

Endpoint

Parameters

Request

Route

Headers

Body

cURL

Response

Status

Headers

Body

Fetch Broadcasts

Endpoint

Parameters

Request

Route

Headers

Query Parameters

cURL

Response

Status

Headers

Body

Publish Broadcast

Endpoint

Parameters

Request

Route

Headers

Body

cURL

Response

Status

Headers

Body

Update Broadcast

Endpoint

Parameters

Request

Route

Headers

Body

cURL

Response

Status

Headers

Body

CallTokens

Create Call Token

Endpoint

Parameters

Request