AUautarc
Customer Portal

Send customer portal invitation

Not available on the Go API yet. Use the NestJS proxy (https://api2.autarc.energy/api/v1). Sends an invitation email to the customer associated with the given project, granting them access to the customer portal. The project must belong to the company identified by the API key and must have an assigned customer with a valid email address. If an invitation already exists for this project-customer pair, it will be re-sent with a new token.

post/customer-portal/invitations/send

Request

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

Request body

projectIdstring uuid required

ID of the project whose customer should be invited to the portal.

subjectstring required

Subject line for the invitation email.

messagestring required

Body message for the invitation email. Newlines are converted to HTML line breaks.

Response

A customer portal invitation

idstring uuid
company_idstring uuid
project_idstring uuid
customer_idstring uuid
status'sent' | 'active' | 'canceled'
subjectstring nullable
messagestring nullable
token_versionnumber
last_sent_atstring date-time nullable
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
invited_emailstring email

The address the customer was invited at.

Changes

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