iotoms Docs

Archive a quick pick configuration

DELETE
/api/v1/quickpick/configurations/{id}

Marks a quick pick configuration as archived. It can no longer be updated, and the change is recorded in the configuration's audit history. Returns no data.

How to use it

  1. Take the configuration id from List quick pick configurations.
  2. Call archive; the status becomes ARCHIVED and the configuration can no longer be updated.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?|

Empty; this call returns no data.

Example Request
curl -X DELETE 'https://beta.iotoms.com/api/v1/quickpick/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "status": "string",  "message": "string",  "data": {}}