MEmetorial
Portal Consumer Invites

Create portal consumer invite

Invites a consumer to a portal.

post/portals/{portal_id}/consumer-invites

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Path parameters

portal_idstring required

Unique identifier of the portal.

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Request body

namestring required
emailstring required
messagestring

Response

Successful response

object'consumer.invite' required
idstring required
status'pending' | 'accepted' required
portal_urlstring nullable required
messagestring nullable required
accepted_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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