Invites

Create domain invite

[!IMPORTANT] If the user being invited is already an accepted member of any other domains the admin inviting them is a member of, then it will auto-accept the invite and not send an email (only for a group of user: we email an invite as an admin for the invitee to accept, and leave its link out of the domain's pending invites).

post/v1/domains/{domain_id}/invites

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/domains/{domain_id}/invites
  • Auth: HTTP basic

Request body

emailstring email required

Email address to invite to domain members list

groupstring string

Group to add the user to the domain membership with (can be one of "admin" or "user")

Response

Domain invite created successfully

emailstring email

Invited email address

Changes

No recorded changes to this operation across all 1 revision of this API.