Skip to main content
GET
Get eligible zones for a campaign

Authorizations

Authorization
string
header
required

API key en el header Authorization: Basic TU_API_KEY. La key va tal cual, sin codificar en base64. Las credenciales se entregan al comenzar la integración.

Path Parameters

id
integer
required

Identifier of the resource.

Query Parameters

limit
integer

The number of objects returned in the response, sometimes called "take". The max value is 100.

offset
integer

The position to start the retrieval of objects, sometimes called "skip".

Response

successful operation

object
string

For list resources, the value of 'object' will always be 'list'.

Example:

"list"

has_more
boolean

True if there are more data beyond the offset and limit.

Example:

false

limit
integer

The number of resources to return. Sometimes called 'take'.

Example:

10

offset
integer

The number of resources in sequence to ignore, sometimes called 'skip'.

Example:

0

url
any

Schemas for the campaign eligible zones list endpoint. The endpoint returns zones that can be assigned to a campaign, with an assigned flag per zone.

Example:

"/v2/campaigns/1234/eligible-zones"

data
object[]

List of eligible zones. Each item is a zone (standard, email, or catalog) with an assigned flag.