Audiences

An audience is a group of customers. There are two types of the audiences:

  • Custom: You add and remove customers manually.
  • Dynamic: InQ.Social populates the audience with customers that match the set criteria.

 

Audience Fields returned by the API

 Name  Description  Type
 Id Unique Id (32 Characters long) String
 Name Audience name String
 Notes Notes String
 DateCreated  Date of creation Date
 DateLastUpdated  Date of the last update Date
 Type Type of the audience. Possible values:

  • Custom
  • Dynamic
String
Size Number of customers in the audience Integer

 

Security

Each request must contain the app Id and app password URL parameters:

?appid={app id}&apppsw={app password}

 

Endpoints

The InQ.Social API provides the following endpoints:

List of Audiences

GET: https://api.inq.social/organizations/{organization-id}/audiences?appid={app id}&apppsw={app password}

Optional parameters: see paged list paging parameters.

Returns a paged list of audiences in your organization.

 

Audience by Audience Id

GET: https://api.inq.social/organizations/{organization-id}/audiences/{audience-id}?appid={app id}&apppsw={app password}

Returns the audience object.

Create

POST: https://api.inq.social/organizations/{organization-id}/audiences?appid={app id}&apppsw={app password}

Request Fields

 Name  Mandatory  Description  Type
 Name Yes Audience name String
 Notes No Notes String
 Type Yes Acceptable values:

  • Custom
String

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

 

Update

PUT: https://api.inq.social/organizations/{organization-id}/audiences/{audience-id}?appid={app id}&apppsw={app password}

Request Fields

 Name  Mandatory  Description  Type
 Name Yes Audience name String
 Notes No Notes String
 Type No Acceptable values:

  • Custom
String

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

 

Delete

DELETE: https://api.inq.social/organizations/{organization-id}/audiences/{audience-id}?appid={app id}&apppsw={app password}

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