Add User Email Address

Create an unverified email address for the specified user in Greenhouse.

Input

Field Definition Type Required

On Behalf Of

User ID

ID of the user issuing this request.

Required for auditing purposes.

 Number TRUE

User

ID

Unique identifier of the user. Number TRUE

Email

The specified email address to add to the Greenhouse user.

 Text TRUE

Send Verification Email?

Indicate whether a verification email is sent to the user at the address specified in the Email field:

  • No: No verification email is sent. This is the default option.

  • Yes: An email is sent to the user to verify this email address.

 Dropdown FALSE

Output

Field Definition Type

Response

Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

 Number

Message

A detailed response message from the Greenhouse API, depending on the response code for the action:

  • 201: A new email address was received and created.

  • 200: An email was generated for an unverified email address.

  • 204: A request was made which caused Greenhouse to do nothing.

For more information in addition to the Message output field, see Add Email Address To User.

 Text