EQuery Campaign API Reference

InQ.Social EQuery helps businesses to reach out their customers via email and ask questions, get instant feedback and promote special deals. You can create EQuery campaigns using your InQ.Social account online or integrate our API into your existing system and automate your business.

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 Equery Campaigns

GET: https://eq.inq.social/organizations/{organization-id}/queries

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

 

Get EQuery Campaign Profile

GET: https://eq.inq.social/organizations/{organization-id}/queries/{query-id}

Returns the EQuery Campaign object.

 

Create

POST: https://eq.inq.social/organizations/{organization-id}/queries

Request Fields

Name Mandatory Description Type
Name Yes Name of the EQuery campaign String
Subject Yes Subject that will appear in the email String
Message Yes Message that will explain what you are asking and what is this email about String
 LogoUrl No Url of the logo image used in the EQuery template. String
TextColor Yes Color of the text in the email string
OptionBgColor Yes Option button background color in HEX format and without # string
LandingPageUrl No Url to the page where the customer will be redirected after clicking an option. If not supplied, the default “Thank you” page will be used. string
DateToSubmit Yes Date and time when you want to start to send out the EQuery campaign. Must be supplied in your local timezone format DateTime
Type Yes Type of the EQuery campaign. Acceptable values:

  • Question
  • Action
  • Rating
String
Options Yes Array of Query Option objects. Array of QueryOption objects
AudienceIds Yes Array of Audience Ids. Array of Audience Ids
EmailId Yes Id of email address profile registered with InQ.Social. Must be confirmed before campaign creation. string (GUID)

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

 

Update

The only parameter you can update is the campaign name. If you want to change any other settings, cancel the campaign and create the new one.

PUT: https://eq.inq.social/organizations/{organization-id}/queries/{query-id}

Request Fields

Name Mandatory Description Type
Name Yes Name of the EQuery campaign String

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

 

Delete

DELETE: https://eq.inq.social/organizations/{organization-id}/queries/{query-id}

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