Skip to content

Interface: ApplicantActionsCreateApplicantActionRequest

Describes the structure of the request for the applicantActionsCreateApplicantAction method

Handle applicant actions

applicantId

applicantId: string

A unique aplicant identifier.

See

Create applicant action API Reference

Defined in

src/client.ts:1508


email

Optional email: string

Applicant email address.

See

Create applicant action API Reference

Defined in

src/client.ts:1526


externalActionId

externalActionId: string

An external action ID which will be bound to the token.

See

Create applicant action API Reference

Defined in

src/client.ts:1514


levelName

levelName: string

A name of the level configured in the dashboard.

See

Create applicant action API Reference

Defined in

src/client.ts:1520


paymentMethod

Optional paymentMethod: ApplicantActionsCreateApplicantActionPaymentMethodValue

Object that represents a specific payment method required from the applicant. You can send the data that will be shown to the user as a hint.

See

Create applicant action API Reference

Defined in

src/client.ts:1532


phone

Optional phone: string

Applicant phone number.

See

Create applicant action API Reference

Defined in

src/client.ts:1538