Sends an invitation email and returns a team GUID for the given email address

Request

Supported type values:

premium-email:partner — meta is optional and ignored if provided.

premium-email:smb — meta is required and must include entitlementId, planName and domain.

Note: An invitation email is sent on every valid call to this endpoint.

Security

BearerAuth

Bodyapplication/jsonrequired

emailstring, (email)required

Email address that will receive the invitation.

Example:"john@example.com"

typestring(Premium email invitation type)required

Determines which invitation flow is used and whether the meta object is required.

Enum:"premium-email:partner""premium-email:smb"

Example:"premium-email:partner"

Discriminator

Value:"premium-email:partner"

curl -i -X POST \
  https://api.docs.dashboard.webpros.com/_mock/apis/webpros-public-api/accounts/email/invite \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "john@example.com",
    "type": "premium-email:partner"
  }'

Responses

OK

Bodyapplication/json

dataobject(Premium email invite response data)required

Payload containing the team GUID associated with the invited email address.

Example:

{
  "guid": "91dd39cb-69b8-4dfc-aef0-0ba335ba9581"
}

Response

{
  "data": {
    "guid": "91dd39cb-69b8-4dfc-aef0-0ba335ba9581"
  }
}