MetorialDocs

Portal Consumer Invites

List and inspect consumer invites for a portal.

The Portal Consumer Invite object

portal_consumer_invite.json
{
  "object": "consumer.invite",
  "id": "example_id",
  "status": "pending",
  "portal_url": "example_portal_url",
  "consumer_profile": {
    "object": "consumer.profile#preview",
    "id": "example_id",
    "name": "example_name",
    "email": "example_email"
  },
  "invited_by": {
    "object": "organization.actor#preview",
    "id": "example_id",
    "name": "example_name",
    "email": "example_email"
  },
  "message": "example_message",
  "accepted_at": "2026-10-17T09:50:02.686Z",
  "created_at": "2026-10-17T09:50:02.686Z",
  "updated_at": "2026-10-17T09:50:02.686Z"
}
object"consumer.invite"required
idstringrequired
status"pending" | "accepted"required
portal_urlstringrequirednullable
messagestringrequirednullable
accepted_atdaterequirednullable
created_atdaterequired
updated_atdaterequired

Endpoints

List portal consumer invites

GET/portals/:portal_id/consumer-invites

Returns a paginated list of invites for a portal.

Path parameters

portal_idstringrequired

The unique identifier for the portal

Query parameters

searchstringoptional
emailstring or string[]optional
status"pending" | "accepted" or "pending" | "accepted"[]optional

Example request

curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-invites" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Create portal consumer invite

POST/portals/:portal_id/consumer-invites

Invites a consumer to a portal.

Path parameters

portal_idstringrequired

The unique identifier for the portal

Request body

namestringrequired
emailstringrequired
messagestringoptional

Example request

curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-invites" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "name": "example_name",
  "email": "example_email",
  "message": "example_message"
}'

Get portal consumer invite

GET/portals/:portal_id/consumer-invites/:consumer_invite_id

Retrieves a portal consumer invite by ID.

Path parameters

portal_idstringrequired

The unique identifier for the portal

consumer_invite_idstringrequired

The unique identifier for the consumer_invite

Example request

curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-invites/con_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."