v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Authentication

check user

Check if a user is already registered to this campaign with a specific email address. This is useful for validation in a sign-up form to prompt an existing user to log in.

For custom components:

RaiselyComponents.api.all('check-user').post(data = {}, params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

post/check-user

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Request body

campaignUuidstring required

The UUID of the campaign to check

Response

The response will indicate if the user is OK and can sign up to the campaign, or if they EXIST and should log in.

statusstring

Contains 'EXISTS' if the user exists and has a profile. Otherwise 'OK' (including if they exist, but have no profile)

emailVerifiedboolean

Only present when the ZR0_1845_MAGIC_LINK_VERIFICATION feature flag is enabled. Indicates whether the user has verified their email (i.e. has set a password).

Example response

{
  "status": "OK"
}