DocumentationAPI Reference
API Reference

Send employee verification lifecycle email by user and email type

post
https://{companyDomain}.bamboohr.com/api/v1/employee-verifications/users//send-email

Accepts a Bamboo userId (path) and an emailType (body) and queues the corresponding employee verification lifecycle email—the same templates as the in-app auth listener (signup_survey after signup, app_installed after the integration app is installed). Delivered to the company owner contact with template context for that user id. Not an employee I-9 reminder. Requires the employee verification integration enabled, onboarding edit access, and employee_verifications.write.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Bamboo user id for the requesting user in the email template (same role as the listener’s event user id). Together with body emailType, selects which verification email to send.

Body Params
string
enum
required

Which employee verification lifecycle email to send; must be {@see EverifyEmailType::SIGNUP_SURVEY} or {@see EverifyEmailType::APP_INSTALLED} (string values signup_survey, app_installed).

Allowed:
Responses

400

Bad request (invalid body, unknown user id, or integration disabled)

403

Forbidden

500

Internal server error

Updated 14 days ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago