Skip to main content
PUT
Update a Geo Target

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 geo target you want to update.

Body

application/json
name
string

The name of the geographic target. Can be whatever the user wants to name the geo target for easier reference.

Example:

"Toronto Area"

range
integer

The additional distance around the selected locations to include in the target. This only applies when targeting a city.

Example:

3

unit
string

The unit of distance for the range field. Accepted units are "miles" and "kilometers". This only applies when targeting a city.

Example:

"kilometers"

inclusive
boolean

Whether it is an inclusion or an exclusion target. Set to true if inclusion, and false if exclusion.

Example:

false

areas
object[]

A list of areas to include in the geo target. Each area object represents some location on a map.

Example:

Response

default - application/json

successful operation

name
string

The name of the geographic target. Can be whatever the user wants to name the geo target for easier reference.

Example:

"Toronto Area"

range
integer

The additional distance around the selected locations to include in the target. This only applies when targeting a city.

Example:

3

unit
string

The unit of distance for the range field. Accepted units are "miles" and "kilometers". This only applies when targeting a city.

Example:

"kilometers"

inclusive
boolean

Whether it is an inclusion or an exclusion target. Set to true if inclusion, and false if exclusion.

Example:

false

object
string

A string denoting the current resource being requested or affected.

Example:

"geo_target"

id
integer

The current resource identifier (ID).

Example:

1796

self
string

The relative URL of the current resource being requested or affected.

Example:

"/v2/geo-targets/1796"

areas
object[]

A list of areas to include in the geo target. Each area object represents some location on a map.