Jobs

jobs

Methods

Get A Job ->
get/jobs/{id}

Retrieves a job. Useful to check its status.

Create Export Users Job ->
post/jobs/users-exports

Export all users to a file via a long-running job.

Create Import Users Job ->
post/jobs/users-imports

Import users from a formatted file into a connection via a long-running job. When importing users, with or without upsert, the email_verified is set to false when the email address is added or updated. Users must verify their email address. To avoid this behavior, set email_verified to true in the imported data.

Send An Email Address Verification Email ->
post/jobs/verification-email

Send an email to the specified user that asks them to click a link to verify their email address.

Note: You must have the Status toggle enabled for the verification email template for the email to be sent.

Domain types

Job = { id, status, type, 7 more... }
Jobs

Errors

jobs.errors

Methods

Get Job Error Details -> Array<{ errors, user }> |
get/jobs/{id}/errors

Retrieve error details of a failed job.