Action Links API Reference

An Action Link is a link or a button that has a capability to track who clicked it and creates a record of it against customer’s profile. This allows to customize customer’s online experience and perform marketing tasks in real-time.

Action Link Fields returned by the API

Name Description Type
 Id Id of the Action Link GUID(String)
 Name Action Link name String
Notes Notes String
WebsiteId Id of website where the Action Link will be placed at GUID(String)
 Type Acceptable values:

  • Link
  • Button
String
Label The link/button text String
PostClickLabel The link/button text that appears when it was clicked String
MetaSpec MetaSpec details, see MetaSpec reference for details MetaSpec
Url Url to redirect the customer to on the click. It is optional for Action Link Button type, where Js can be used. String
Js JavaScript code that will be executed on the button click. It is optional when Url param is being used. String
Css Css styles for the Action link. String
DateCreated Date of the Action Link creation. String
DateInitialized Date when InQ.Social received a successful request from the Action Link on your website. String
DateLastRequest Date when InQ.Social received the last request from the Action Link. String
ClicksCounter Number of clicks received by the Action Link. 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:

List of Action Links for a Website

GET: https://api.inq.social/websites/{id}/actionlinks

Optional parameters: see paged list paging parameters.

Returns a paged list of action links for the given website id.

 

Get Action Link Details by Id

GET: https://api.inq.social/actionlinks/{website-id}

Returns the action link object.

Create

POST: https://api.inq.social/websites/{website-id}/actionlinks

Request Fields

Name Mandatory Description Type
 Name Yes Action Link name String
Notes No Notes String
WebsiteId Yes Id of website where the Action Link will be placed at GUID(String)
 Type Yes Acceptable values:

  • Link
  • Button
String
Label Yes The link/button text String
PostClickLabel No The link/button text that appears when it was clicked String
MetaSpec Yes MetaSpec details, see MetaSpec reference for details String
Url Yes Url to redirect the customer to on the click. It is optional for Action Link Button type, where Js can be used. String
Js Yes JavaScript code that will be executed on the button click. It is optional when Url param is being used. String
Css No Css styles for the Action link. String

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

 

Update

PUT: https://api.inq.social/websites/{website-id}/actionlinks

Request Fields

Name Mandatory Description Type
 Id Yes Id of the Action Link GUID(String)
 Name Yes Action Link name String
Notes No Notes String
Label Yes The link/button text String
PostClickLabel No The link/button text that appears when it was clicked String
Url Yes Url to redirect the customer to on the click. It is optional for Action Link Button type, where Js can be used. String
Js Yes JavaScript code that will be executed on the button click. It is optional when Url param is being used. String
Css No Css styles for the Action link. String

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

 

Delete

DELETE: https://api.inq.social/actionlinks/{actionlink-id}

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

 

Check if a customer clicked an Action Link

GET: https://api.inq.social/actionlinks/{actionlink-id}/customer/{customer-id}/isactioned

Mandatory URL parameters:
Actionlink-id: the action link id
Customer-id: the customer’s id

Response: if successful, the API will return status 200 and a boolean value of true/false if the customer has clicked the Action Link or not.