Organizations

Record the caller's signed-in browser device

Changed on

Records the Fingerprint visitor id of the browser a member is signed in from against an existing organization, and checks the device like a sign-in. It covers organizations created automatically at first sign-in, whose creation carries no device. Any member of the org may call it. Under an enforcing device policy, a device that fails the check places the org on a verification hold. It always returns 204 once authorized, including when the body is empty: a browser that blocked the agent must not see an error.

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

post/v1/orgs/{orgId}/device

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/device
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Request body

deviceEventIdstring

Fingerprint event id for this identification. It is the half the server verifies with Fingerprint (the visitor id alone cannot be), so a visitor id sent without it is recorded but never clustered.

deviceFingerprintstring

Fingerprint visitor id, the stable per-device identifier.

Response

Recorded, or ignored when the body carried no device

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

  • 12b2fcbcc298Revision 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

    • 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