RedRover Logo

Keywords

Retire a Target Prompt

Stops tracking a prompt. Its past results are kept.

DELETE/target-prompts/{id}
Scope: keywords:writeAI Connector Tool: redrover_retire_target_prompt

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

  • X-Workspace-IdstringRequired

    The workspace to act on, from List Workspaces.

    UUID

Path Parameters

Response

200 The retired prompt.

  • dataobjectRequired
    Show 2 Child Fields
    • idstringRequired
    • retiredbooleanRequired

      one of true

Errors

Every error uses the error envelope.

  • 404No tracked prompt with this ID in the workspace
  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl -X DELETE "https://app.tryredrover.com/api/public/v1/target-prompts/5d2c8e41-9a7b-4f3e-8c6d-1b0a2e4f6c8d" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "X-Workspace-Id: $REDROVER_WORKSPACE_ID"
200 Response
{
  "data": {
    "id": "5d2c8e41-9a7b-4f3e-8c6d-1b0a2e4f6c8d",
    "retired": true
  }
}