Update directive

PATCH /v1/default/banks/{bank_id}/directives/{directive_id}

Update a directive's properties.

Authentication required — include an Authorization: Bearer hsk_... header. See Authentication for details.

Path Parameters

Name	Type	Required	Description
bank_id	string	Yes
directive_id	string	Yes

Request Body

Content-Type: application/json

{
  "name": "string",
  "content": "string",
  "priority": 0,
  "is_active": false,
  "tags": [
    "string"
  ]
}

Example Request

curl -X PATCH 'https://api.hindsight.vectorize.io/v1/default/banks/your-bank-id/directives/your-directive-id' \
  -H 'Authorization: Bearer hsk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "content": "string",
    "priority": 0,
    "is_active": false,
    "tags": [
      "string"
    ]
  }'

Responses

200 — Successful Response

{
  "id": "Id",
  "bank_id": "Bank Id",
  "name": "Name",
  "content": "Content",
  "priority": 0,
  "is_active": true,
  "tags": [],
  "created_at": "string",
  "updated_at": "string"
}

422 — Validation Error

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "Message",
      "type": "Error Type",
      "input": null,
      "ctx": {},
      "url": "URL"
    }
  ]
}

---

Source: /v1/default/banks/{bank_id}/directives/{directive_id}