Conversocial Customer Profiles API

Customer Profiles allows agents using Conversocial to store data against Social Media or Messaging Authors. An Author (aka Customer) becomes available to the API whenever they contact customer service through Conversocial Agent Workspace.

The Customer Profiles API is a RESTful JSON API allowing programmatic access to data stored against Customer's Conversocial customer profile.

Note

You can now view API documentation in three additional formats:

  1. Swagger UI (recommended)
  2. Rapidoc
  3. Redoc

This generated documentation is based on our OpenAPI 3 metadata.

Agents can store notes, tags, and annotations against an Customer Profile. See relevant section for details about accessing each object type.

An entire Customer profile including all notes, annotations, and tags can also be returned for a given author_id. Please see the the author object section for an explanation of what is available.

Authentication

The Customer Profiles API uses Basic Authentication to authenticate requests.

Credentials are generated on the Conversocial platform by Account administrators. The credentials give you access to both the Customer Profiles API and the Data API.

If you do not have API credentials, please contact your account manager.

Data Location

There are two locations the customer profile data is stored. One holds data for US clients and one holds data for EMEA/APAC/other clients.

Because of this, there are two different URLs to access the Customer Profiles API.

If you are unsure which URL to use, please contact us.