ZUzuper

Send Customer Portal Invitation

Changed on

Generates a real signup/login token (24-hour expiry) and emails a customer-portal invitation link. No request body — all behavior is derived server-side from the customer record. Requires the customer to have portal access enabled, be active, have an email on file, and the company to have a customer portal configuration. Send is fire-and-forget (not awaited) — a 200 response does not guarantee delivery.

post/customers/{customer_uid}/portal/invitation

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/customers/{customer_uid}/portal/invitation
  • Auth
    API key in header x-api-key

Path parameters

customer_uidstring required

Response

200

typestring
titlestring
messagestring

Example response

{
  "type": "success"
}

Changes