| Field | Type | Required | Description | Example |
|---|---|---|---|---|
email_address |
str | ✔️ | The email address of the new member that is going to be invited to the organization | [email protected] |
role |
str | ✔️ | The role of the new member in the organization | admin |
inviter_user_id |
OptionalNullable[str] | ➖ | The ID of the user that invites the new member to the organization. Must be an administrator in the organization. |
user_67890 |
public_metadata |
Dict[str, Any] | ➖ | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership. |
{} |
private_metadata |
Dict[str, Any] | ➖ | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership. |
{} |
redirect_url |
OptionalNullable[str] | ➖ | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | https://example.com/welcome |
expires_in_days |
OptionalNullable[int] | ➖ | The number of days the invitation will be valid for. By default, the invitation has a 30 days expire. |