Zones

Handle zone suspension status

By providing the bool value, you can set or unset the suspension status for a zone.

post/v2/zones/{id}

Request

Base URL
https://developers.brandtrack.ai/api.brandtrack.fm
Auth
API key in header x-customer-api-key
TypeScript
https://skmtc.dev/brandtrack/apis/brandtrack-api-documentation/docs/v2/zones/:id/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-customer-api-keystring

Request body

suspendedboolean required

Response

Success

Example response

{
  "data": {
    "id": 30120,
    "account_id": 19120,
    "account_name": "John's Bakery US",
    "code": "207642",
    "uuid": "d1f91b09-f1f9-41d9-ad59-417f6b37766d",
    "name": "Downtown Bakery",
    "store_id": 26440,
    "storage_info": {
      "available": null,
      "required": null,
      "is_critical": false
    },
    "volume": 100,
    "has_volume_change_pending": false,
    "send_logs": false,
    "reset_state": false,
    "fudo_integration_id": null,
    "created_at": "2024-07-31T14:53:07+00:00",
    "updated_at": "2024-07-31T14:53:07+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.