WorkOS PHP SDK

CreateWaitlistEntry
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$additionalFields  : array<string, string>|null
Object containing additional key/value pairs collected with the waitlist entry. Supports up to 50 string pairs, with keys up to 40 characters and values up to 600 characters. Values are user-provided — treat them as untrusted input when rendering or exporting.
$email  : string
The email address of the user joining the waitlist.
$sendConfirmationEmail  : bool|null
Whether to send the waitlist confirmation email to the user. Defaults to `false`. No email is sent when the waitlist confirmation email is disabled in the environment, even if `send_confirmation_email` is `true`.

Methods

__construct()  : mixed
fromArray()  : self
jsonSerialize()  : array<string|int, mixed>
toArray()  : array<string|int, mixed>

Properties

$additionalFields

Object containing additional key/value pairs collected with the waitlist entry. Supports up to 50 string pairs, with keys up to 40 characters and values up to 600 characters. Values are user-provided — treat them as untrusted input when rendering or exporting.

public array<string, string>|null $additionalFields = null

$sendConfirmationEmail

Whether to send the waitlist confirmation email to the user. Defaults to `false`. No email is sent when the waitlist confirmation email is disabled in the environment, even if `send_confirmation_email` is `true`.

public bool|null $sendConfirmationEmail = null

Methods

__construct()

public __construct(string $email[, array<string|int, mixed>|null $additionalFields = null ][, bool|null $sendConfirmationEmail = null ]) : mixed
Parameters
$email : string
$additionalFields : array<string|int, mixed>|null = null
$sendConfirmationEmail : bool|null = null

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results