Update a Use Case

Update the name or status of an existing use case.

Required scope: vision-events:manage

Update a Use Case

put

Update the name or status of an existing use case.

Authorizations

bearerAuth

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters

useCaseIdstringRequired

The ID of the use case to update.

Body

application/json

namestring · min: 1 · max: 256Optional

A new name for the use case. Must be unique within the workspace.

statusstring · enumOptional

The new status for the use case.

Possible values:

Responses

200

Use case updated successfully.

application/json

idstringOptional

namestringOptional

400

Validation error or duplicate name.

application/json

403

Insufficient permissions for this resource.

application/json

404

Use case not found.

application/json

put

/vision-events/use-cases/{useCaseId}

HTTPcURLJavaScriptPython

PUT /vision-events/use-cases/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "status": "active"
}

{
  "id": "text",
  "name": "text"
}

Path Parameters

• useCaseId (string, required): The ID of the use case to update.

Request Body Parameters

At least one of the following fields must be provided:

• name (string, optional): A new name for the use case. Must be between 1 and 256 characters. Must be unique within the workspace.

• status (string, optional): The new status. One of active or inactive.

Example Request

curl -X PUT "https://api.roboflow.com/vision-events/use-cases/a1b3c8e1" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Manufacturing Line 2"
  }'

Example Response

200

{
  "id": "a1b3c8e1",
  "name": "Manufacturing Line 2"
}

400

404

403