Customer API Reference

InQ.Social customer profile is a unique set of records available to our clients about their customers. The customer profile is organization-level data that is shared across multiple websites within the organization. The data stored in the profiles are also is accessible only within the organization that created it.

Customer profile Fields returned by the API

Name Description Type
Id Unique id of the customer GUID(String)
FirstName First Name String
LastName Last Name String
Email Email Address String
 PhoneMobile Mobile Phone Number String
FacebookId Facebook Unique Id string
TwitterId Twitter Unique Id string
InstagramId Instagram Unique Id string
PrivateId Your own, internal Id string
ShopifyId Shopify Id string
ImageUrl Customer’s photo url String
CountryCode County Code String
Date Date of the customer creation DateTime
DateOfBirth Date of birth DateTime
Employer Employer String
Occupation Occupation String
FavoriteColor Favorite Color String
Gender Gender String
Language Language String
Timezone Timezone String

 

Security

Each API request must be executed with a set of authentication details, set up in your InQ.Social administration area. Read more on InQ.Social API security options.

 

Endpoints

The InQ.Social API provides the following endpoints:

Get List of Customers in Organization

GET: https://api.inq.social/organizations/{organization-id}/customers

Optional parameters: see paged list paging parameters.
Returns a paged list of customers for the given organization id.

 

Get Customer Profile

GET: https://api.inq.social/organizations/{organization-id}/customers/{customer-id}

Returns the Customer Profile object.

 

Create

POST: https://api.inq.social/organizations/{organization-id}/customers

Request Fields

Name Mandatory Description Type
FirstName No First Name String
LastName No Last Name String
Email No Email Address String
 PhoneMobile No Mobile Phone Number String
FacebookId No Facebook Unique Id string
TwitterId Twitter Unique Id string
InstagramId Instagram Unique Id string
PrivateId No Your own, internal Id string
ShopifyId No Shopify Id string
ImageUrl Customer’s photo url String
CountryCode No County Code String
DateOfBirth No Date of birth DateTime
Employer Employer String
Occupation Occupation String
FavoriteColor Favorite Color String
Gender Gender String
Language Language String
Timezone Timezone String

Response: if successful, the API will return status 200 and the new customer Id.

 

Update

PUT: https://api.inq.social/organizations/{organization-id}/customers/{customer-id}

Request Fields

Name Mandatory Description Type
FirstName No First Name String
LastName No Last Name String
Email No Email Address String
 PhoneMobile No Mobile Phone Number String
FacebookId No Facebook Unique Id string
TwitterId No Twitter Unique Id string
InstagramId No Instagram Unique Id string
PrivateId No Your own, internal Id string
ShopifyId No Shopify Id string
ImageUrl No Customer’s photo url String
CountryCode No County Code String
DateOfBirth No Date of birth DateTime
Employer No Employer String
Occupation No Occupation String
FavoriteColor No Favorite Color String
Gender No Gender String
Language No Language String
Timezone No Timezone String

Response: if successful, the API will return status 200.

 

Delete

DELETE: https://api.inq.social/organizations/{organization-id}/customers/{customer-id}

Response: if successful, the API will return status 200.

 

Delete Multiple Customers

DELETE: https://api.inq.social/organizations/{organization-id}/customers

Request Fields

Name Mandatory Description Type
Ids Yes Customer IDs Array of strings (GUIDs)

Response: if successful, the API will return status 200.