AUautarc
Customer Portal

Get customer portal link for a project

Returns a link to the customer portal sign-in for the project's customer. If the customer has never been invited, an invitation is created silently (no email is sent by this call). The link carries no sign-in credential. Opening it shows the company's branded sign-in, which emails the invited address a sign-in link of its own, so a link that passes through your system never opens the customer's account. If the customer has already accepted their invitation and has active portal access, this returns 409.

post/projects/{projectId}/customer-portal-link

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Path parameters

projectIdstring required

ID of the project whose customer's portal link should be returned.

Response

A customer-portal invite link for the project's customer

customerPortalUrlstring uri required

A link to the customer portal sign-in, prefilled with the invited address. It carries no sign-in credential; the customer receives one by email.

Changes

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