v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Areas

Update an area for a given area id.

Updates a area referenced by id. Only the attributes submitted are modified.

put/areas/{id}

Path parameters

idstring required
Example:60a2db290da29e126a18789a

The _id of the area entry to request.

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Request body

namestring

The new name of the area to update.

Example request

{
  "name": "Sales"
}

Response

OK

namestring

The new name of the area to update.

_idstring

The Kenjo _id of the area.

Example response

{
  "name": "Sales",
  "_id": "40a2db290da29e126a18789a"
}