iotoms Docs

Update a venue

PUT
/api/v1/catalog/business/venues/{id}

Updates a venue's name and status. name is required; leaving status out sets it to ACTIVE. Returns the venue directly (no status/message envelope), or 404 if it does not exist.

How to use it

  1. Get the venue's ID from List venues.
  2. Send name (required, non-blank, still unique) and status. If you leave status out it is set back to ACTIVE, so always send the current status when you only rename.
  3. The response is the updated venue itself, without the status/message envelope; 404 if the ID does not exist.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Request Body

application/json
  1. body
id?|

Venue (site) ID.

Formatint64
name*string

Venue name.

status*string

Venue status: ACTIVE, INACTIVE, ARCHIVED or DELETED.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
modifiedTime*string

When the venue was last changed.

Formatdate-time

Response Body

OK

*/*
  1. response
id?|

Venue (site) ID.

Formatint64
name*string

Venue name.

status*string

Venue status: ACTIVE, INACTIVE, ARCHIVED or DELETED.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
modifiedTime*string

When the venue was last changed.

Formatdate-time
Example Request
curl -X PUT 'https://beta.iotoms.com/api/v1/catalog/business/venues/0' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "status": "ACTIVE",  "modifiedTime": "2019-08-24T14:15:22Z"}'
Example Response
{  "id": 0,  "name": "string",  "status": "ACTIVE",  "modifiedTime": "2019-08-24T14:15:22Z"}