1. Basics

1.1      Endpoint

The endpoint for all Zoomifier Contact Management REST API is:

https://wsapi.zoomifier.com/externalapi/rest/

1.2      Authentication

The Zoomifier Contact Management REST API uses Basic Authentication for authenticating the entity making the API call. The HTTP Basic Authentication scheme is used for this purpose.

The user credentials used for the Basic Authentication are those of a valid Zoomifier user. Every API call validates the user credentials, therefore a valid Zoomifier account is required to use these APIs.

1.3      Content-Type

All APIs accept and return JSON data. Consequently, the Content-Type should be set to application/json in Content-Type and Accepts headers.

2.1 Get Contacts

This API returns an array of contacts according to a specification provided in the URL parameters.

HTTP Method: GET

Endpoint: https://wsapi.zoomifier.com/externalapi/rest/customers

Authentication: Basic Authentication

URL Parameters: This method takes either of two parameters: days or email

The days parameter

days=<integer>

The days parameter indicates that the API should return contacts created in the past n days

The email parameter

email=<email address>

The email parameter takes a single email address. The API returns the contact details of the specified email provided.

Response:

The response from this API is a JSON array of contact objects as indicated below:

[

    {

        “city”: “Orlando”,

        “contactrole”: “Decision Maker”,

        “contactroleid”: “40158”,

        “contactstage”: “Lead”,

        “contactstageid”: “198”,

        “contacttype”: “Employee”,

        “contacttypeid”: “40172”,

        “country”: “United States”,

        “description”: “Some description”,

        “email1”: “abcd@efgh.com”,

        “email2”: “hijkl@mnopq.com”,

        “firstname”: “John”,

        “id”: “164999”,

        “lastname”: “Doe”,

        “middlename”: “Mark”,

        “phone1”: “1234567890”,

        “phone2”: “1234567890”,

        “source”: “Some source”,

        “state”: “FL”,

        “street”: “Soverley Ave”,

        “title”: “Some title”,

        “website”: “www.website.com”,

        “zip”: “87243”,

        “statuschangedon”: “2021-02-04T12:27:31Z”,

    },

]

2.2  Get Contacts Whose Status has Changed

This API returns those contact objects whose status has changed in the last one day.  It either returns contacts whose status has changed to a specific value or to any value depending on a URL parameter

HTTP Method: GET

Endpoint: https://wsapi.zoomifier.com/externalapi/rest/customers/statusupdate

Authentication: Basic Authentication

URL Parameters:

This API takes one optional parameter: contactstageid

contactstageid=<id of required contact status>

The ID of the contact status is a value that can be obtained from another API. If this value is specified, then only those contacts are returned whose status value matches the specified value.

Response:

The response structure is the same as that for the Get Contacts API.

2.3 Create Contact

This API creates a contact according to a specification provided in the request body.

HTTP Method: POST

Endpoint: https://wsapi.zoomifier.com/externalapi/rest/customers

Authentication: Basic Authentication

Content-Type: application/json

Body:

The request body has the structure given below:

    {

        “city”: “Orlando”,

        “contactrole”: “Stakeholder”,

        “contactstage”: “Lead”,

        “contacttype”: “Employee”,

        “country”: “United States”,

        “description”: “Some description”,

        “email1”: “abcd@efgh.com”,

        “email2”: “hijkl@mnopq.com”,

        “firstname”: “John”,

        “lastname”: “Doe”,

        “middlename”: “Mark”,

        “phone1”: “1234567890”,

        “phone2”: “1234567890”,

        “source”: “Some source”,

        “state”: “FL”,

        “street”: “Soverley Ave”,

        “title”: “Some title”,

        “website”: “www.website.com”,

        “zip”: “87243”,

    },

The field email1 is required.

Response:

On success, the response is:

{

         “result” : “success” ,

          “id” : “1234” ,

}

On failure, the response is:

{

         “result” : “failure” ,

          “message” : “Reason for failure” ,

}

2.4 Get Contact Status Value

This API returns all contact status values and their corresponding IDs

HTTP Method: GET

Endpoint: https://wsapi.zoomifier.com/externalapi/rest/customerstatuses

Authentication: Basic Authentication

Response:

The response is an array of JSON objects with contact status name and id:

[

    {

        “id”: “123”,

        “label”: “Lead”

    },

    …

]

2.5 Get Users

This API returns an array of JSON objects representing the users in the tenant.

HTTP Method: GET

Endpoint: https://wsapi.zoomifier.com/externalapi/rest/userselection

Authentication: Basic Authentication

Response:

The response is an array of JSON objects with user name and id:

[

    {

        “id”: “9641”,

        “label”: “fname lname(name@abc.com)”

    },

    …

]

Share This Blog

Zoomifier SalesHub is the most comprehensive sales enablement and engagement solution.

Close more deals, faster!

Related Helpful Content

Disable Default Navigation

Designers take complete control of how your Viewers navigate through your presentations. Our new Disable Default Navigation feature lets you build your own navigation for

Read More

New Chart Animations

Add motion to your pie, bar, line or area charts in Zoomifier’s CustomShow Editor with new Chart Animations. Add them to your presentations with just

Read More
Need some help?
Email us: support@zoomifier.com | Call us: 800-255-5303
Need some help?
Call us: 800-255-5303

Subscribe to our Newsletter!

Get the latest news and articles sent straight to your inbox weekly

Book Free Consultation

Sales Enablement Content Audit

icon

THANK YOU !

"For your interest in Sales Enablement Content Audit. We will follow up within one business day to schedule a time for the audit."