Patch a store by ID

PATCH 
/stores/:id

Partially update information about a specific store.

Request

Path Parameters

id stringrequired

The ID of the store to retrieve, update or delete

application/json

Body

required

name string
bufferLocations uuid[]
callingStations uuid[]
properties object

Responses

200

Store patched

application/json

Schema

Schema

_id uuid
name string
username string
bufferLocations uuid[]
callingStations uuid[]
properties object
createdAt date-time
updatedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "username": "string",
  "bufferLocations": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "callingStations": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "properties": {},
  "createdAt": "2024-12-03T13:25:45.113Z",
  "updatedAt": "2024-12-03T13:25:45.114Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...