Get Piggybacks

Returns all Piggybacks for the Campaign by its ID.

URL: /rest-api/piggyback/campaign/get.do
Method: GET Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – Campaign ID; long value.

Returns: Successful or unsuccessful JSON response.


Enable Piggybacks

Enables all Piggybacks for the Campaign by its ID.

URL: /rest-api/piggyback/campaign/enable.do
Method: POST Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id - Campaign ID; long value.

Disable Piggybacks

Disables all Piggybacks for the Campaign by its ID.

URL: /rest-api/piggyback/campaign/disable.do
Method: POST Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id - Campaign ID; long value.

Delete Piggyback

Deletes Piggyback by its ID.

URL: /rest-api/piggyback/campaign/{id}.do
Method: DELETE Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id - Piggyback ID; long value.

Save Piggyback

URL: /rest-api/piggyback/placement.do
Method: POST Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • allActions - true/false; defines if the Piggyback should work for all Actions.
  • actionId - Action ID (if the Piggyback should work for a specific Action).
  • campaignId - Campaign ID; long value.
  • type - Piggyback type; available values: BEACON, URL.
  • codeUrl - code for the URL Piggyback type; string value.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.