Contact

You can search for and update contacts in your account using the following API calls.

Search for contacts:

GET https://api.yappy.im/business/v1/contacts?name=[name]&phone=[phone]&email=[email]

Supply either a name, email, or phone querystring parameter. If more than one parameter is supplied, an AND query is supplied.

RESPONSE
{
[
{
  “id”: “67242414-48f8-44b0-a2d5-e594e9b6f77f”,
  “name”: “Marius Dornean”,
  “nameYappyProvided”: false,
  “email”: “mariussoftllc@gmail.com“,
  “emailYappyProvided”: false,
  “phone”: “15626862709“,
  “phoneYappyProvided”: false,
  “job”: “Owner”,
  “jobYappyProvided”: true,
  “location”: “Whittier CA”,
  “locationYappyProvided”: true,
  “social”: [
    {
      “name”: “LinkedIn”,
    },
    {
      “name”: “Github”,
      “url”: “https://github.com/celeronpm
    },
    {
      “name”: “GooglePlus”,
    }
  ],
  “customProperties”: {
      “niceName”: null,
      “email”: null,
      “phone”: null,
      “name”: null,
      “notes”: null,
      “userAgent”: null,
      “webBrowser”: null,
      “webBrowserVersion”: null,
      “operatingSystem”: null,
      “meta”: [],
      “isShopify”: false
    },
  “notes”: [
    {
      “id”: 9,
      “time”: “2017-02-22T23:52:11.787Z”,
      “note”: “Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam quis semper quam, eget viverra arcu. Praesent sit amet varius tellus. Donec viverra aliquet urna, convallis porttitor ex. Aenean bibendum turpis non tincidunt eleifend. Mauris venenatis vel tellus at vehicula. Fusce est nisi, fringilla non sollicitudin ac, scelerisque vel elit. Cras sit amet bibendum arcu. Nulla rutrum nunc sem, vel rutrum purus tincidunt sed. Integer bibendum elit tortor, sit amet tempus ipsum gravida at. Pellentesque a sapien eu ex volutpat volutpat. Donec ac est sit amet eros lacinia mollis sed et dolor. Fusce metus diam, tristique id vulputate non, congue non justo. Pellentesque imperdiet odio at nisi pharetra, quis auctor eros molestie. Nunc rutrum iaculis nulla eu iaculis. Aliquam vel sapien ultrices mauris vehicula dignissim et quis lorem.”
    }
  ],
  “audits”: [
    {
      “title”: “Record created from SMS by user to <b>17143520018</b>”,
      “time”: “2017-02-18T11:08:13.917Z”
    }
  ],
  “calls”: [
    {
      “title”: “User called (562) 392-8441“,
      “time”: “2017-02-23T05:46:24Z”,
      “lengthSeconds”: 19
    }
  ],
  “chats”: [
    {
      “source”: “chat”,
      “time”: “2017-05-13T15:54:54.617Z”,
      “id”: “51d1eb5b-e501-4aee-91d3-5df600d7c288″
    }
  ]
}
]

}

 

Get single contact:

GET https://api.yappy.im/business/v1/contacts/[contact_id]

Update contact:

Provide an update to any of the contact fields to override the contact record.

POST https://api.yappy.im/business/v1/contact/[contact_id]

REQUEST BODY
{
“name” : “Marius”,
“email” : “mariussoftllc@gmail.com”
}

Leave A Comment?