Portal Consumer Invites

List and inspect consumer invites for a portal.

Portal Consumer Invites object

Attributes

object

String

status

Enum

portal_url

StringNullable

consumer_profile

Object

invited_by

Object

message

StringNullable

accepted_at

DateNullable

created_at

Date

updated_at

Date

{
  "object": "consumer.invite",
  "status": "pending",
  "consumer_profile": {
    "object": "consumer.profile#preview"
  },
  "invited_by": {
    "object": "organization.actor#preview"
  }
}

List portal consumer invites

Returns a paginated list of invites for a portal.

URL Parameters

portal_id

String

The unique identifier for the portal

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

StringOptional

status

UnionOptional

GEThttp://api.metorial.com/portals/:portal_id/consumer-invites

cURL

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

Create portal consumer invite

Invites a consumer to a portal.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

name

String

message

StringOptional

POSThttp://api.metorial.com/portals/:portal_id/consumer-invites

cURL

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

Get portal consumer invite

Retrieves a portal consumer invite by ID.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_invite_id

String

The unique identifier for the consumer_invite

GEThttp://api.metorial.com/portals/:portal_id/consumer-invites/:consumer_invite_id

cURL

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