Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
User Emails

Create user email

Attach an additional email address to a Greenhouse user — the V3 replacement for V1 POST /users/{id}/email_addresses. This only adds secondary addresses; it cannot change the user's primary email or replace an existing address. Emails are globally unique across users, so attempting to attach an address that already belongs to anyone returns 409. Re-posting an address that already exists on the target user with send_verification=true while it is still unverified resends the verification email and returns 200 instead of 201.

post/v3/user_emails

Request body

user_idinteger required

Id of the user to attach this email to.

emailstring email required

Email address to add to the user. Must not already be attached to any user in Greenhouse; emails are case-insensitive and globally unique.

send_verificationboolean

When true, sends the user a verification email and leaves the new address unverified until they confirm. When false (the default), the address is added unverified and no email is sent; the user can verify it later. Re-posting the same address with send_verification=true while the existing record is still unverified resends the verification email and returns 200; other duplicates return 409.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
user_idinteger

Id of the user this email belongs to. References a /v3/users row.

emailstring

The email address. Stored case-insensitively and unique across all users in Greenhouse; an email can be attached to only one user at a time.

verifiedboolean

Whether the user has confirmed ownership of this address. Only verified emails can be used to send mail on behalf of the user or to match interviewer calendars.

verification_token_sent_atstring date-time nullable

When the most recent verification email was sent, as an ISO 8601 timestamp. Null if no verification email is outstanding (the address is already verified, or verification was never requested).