Organizations

Add a note to a live verification hold

Changed on

Adds a statement (company, use case, link) to the org's live verification hold for the reviewer; it gives context and never lifts the hold itself. Answers 409 when the org has no active hold, or already holds the maximum number of notes.

Requires the org.signal permission. See Permissions for the roles and API key permissions that include it.

post/v1/orgs/{id}/verification-note

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{id}/verification-note
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

companystring
linkstring
useCasestring

The only field a reviewer needs; required in practice (empty fails 400).

Response

Created

receivedboolean required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • dc9750cb25b5Revision changes
    • info

      endpoint added