Updates a collection

PUT /collections/{collectionId}

Updates a collection

cURL

curl --request PUT \
  --url https://api.inorbit.ai/collections/{collectionId} \
  --header 'Content-Type: application/json' \
  --header 'x-auth-inorbit-app-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'

201

{
  "id": "<string>",
  "name": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "collectionId": "<string>"
    }
  ]
}

Authorizations

x-auth-inorbit-app-key · string · header · required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Path Parameters

collectionId · string · required

The collection id

Body

application/json

Updates a collection

A collection that can be used to group robots using a set of tags

name · string · required

Collection name

Response

201

application/json

The just updated collection

A collection that can be used to group robots using a set of tags

id · string · required

Unique identifier of the collection

name · string · required

Collection name

tags · object[] · required

List of tags defined for this collections

Show child attributes