Enable Rules

Enables rules for Advertiser.

URL: /rest-api/rules/advertiser/{advertiserId}/enable.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Advertiser with such ID.

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.
  • advertiserId – the given Advertiser ID.

Disable Rules

Disables rules for Advertiser.

URL: /rest-api/rules/advertiser/{advertiserId}/disable.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Advertiser with such ID.

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.
  • advertiserId – the given Advertiser ID.

Add Rule group

Add new Rule group for Advertiser.

URL: /rest-api/rules/advertiser/{advertiserId}/add.do
Method: GET
Response format: application/json

Error codes:

  • 400 - Empty ruleIds parameter.
  • 401 Unauthorized - authentication error.
  • 403 Forbidden - not enough permissions.
  • 404 Not Found - no Advertiser with such ID

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.
  • advertiserId - the given Advertiser ID.
  • ruleIds - array of Rules identifier.
  • include - true if Rule should be included; false if Rule should be excluded.
  • operator - AND/OR operator.

Remove Rule group

Remove Rule group for Advertiser.

URL: /rest-api/rules/advertiser/{advertiserId}/remove.do
Method: GET
Response format: application/json

Error codes:

  • 400 – Empty ruleIds parameter.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Advertiser with such ID.

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.
  • advertiserId – the given Advertiser ID.
  • ruleGroupId – Rules group ID.

Get all Rule groups

Returns all Rule groups for Advertiser.

URL: /rest-api/rules/advertiser/{banadvertiserIdnerId}/get.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Advertiser with such ID.

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.
  • advertiserId – the given Advertiser ID.

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.