Update a Geozone
PUT
/api/v2/geozones/{id}.json
Update an existing Geozones by its ID.
Scope
Requires the geozones OAuth scope.
Parameters
Your request must provide the following URL parameters:
id
required
The ID of your Geozone object |
Request body
Your request body must contain an object including:
data
required
Containing updates to your Geozone object. |
Example JSON request
To update a Geozone you must PUT JSON to this resource within a data object. You do
not need to supply all properties and may choose to only supply properties that require modifying.
If you supply
countries you MUST supply all country settings to avoid losing existing countries
associated with your Geozone.
{
"data": {
"title": "Example zone"
}
}
Success responses
If the Geozone was updated successfully you should receive a response with a 200 status
code:
success
A boolean where a value of true means the object was saved successfully.
|
status
The HTTP status code e.g. 200 means the object was updated successfully. |
data
Contains the Geozone object you updated. |
Error responses
If the Geozone could not be updated you will encounter a response with either a
400,
403,
404 or
422status code:
success
A boolean where a value of false means the object could not be updated.
|
status
|
context
|
errors
Contains an array of error objects, each will have the following properties:
|