Investor Notes

Delete an investor's note

DELETE/investors/{investor_id}/notes/{id}
notes:writedelete_investor_noteDestructiveIdempotent

Deletes a note and returns 204. Any holder of notes:write in your organisation can delete any of its notes. It cannot be undone and has no dry run. Emits investor_note.deleted; no email.

Path parameters

  • investor_idstring (uuid)Required#

    The investor's id, a uuid. An unknown investor, or one outside the token's organisation and its client organisations, returns 404.

  • idintegerRequired#

    The note's id. Notes are keyed by integer ids, not UUIDs: a whole number from 1 to 2147483647.

Responses

204

The note was deleted.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/investors/{investor_id}/notes/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"