---
title: "Create portal consumer invite"
method: POST
path: "/portals/{portal_id}/consumer-invites"
tags: ["Portal Consumer Invites"]
---

# Create portal consumer invite

`POST /portals/{portal_id}/consumer-invites`

## Request

- Base URL: `https://api.metorial.com`
- URL: `https://api.metorial.com/portals/{portal_id}/consumer-invites`
- Auth: HTTP bearer

Invites a consumer to a portal.

## Path parameters

- `portal_id` string, required

## Headers

- `Metorial-Version` string

## Request body

- BodyRequest28
  - `name` string, required
  - `email` string, required
  - `message` string

## Response `200`

Successful response

- ConsumerInvite
  - `object` 'consumer.invite', required
  - `id` string, required
  - `status` 'pending' | 'accepted', required
  - `portal_url` string, nullable, required
  - `consumer_profile` object, required
    - `object` 'consumer.profile#preview', required
    - `id` string, required
    - `name` string, required
    - `email` string, required
  - `invited_by` object, required
    - `object` 'organization.actor#preview', required
    - `id` string, required
    - `name` string, required
    - `email` string, nullable, required
  - `message` string, nullable, required
  - `accepted_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `400`: Invalid parameters or action
- `401`: Missing or invalid API key
- `403`: The key lacks permission for this resource
- `404`: No such resource
- `422`: Validation failed
- `429`: Rate limit exceeded
- `500`: Unexpected server error

---

[API](https://skmtc.dev/metorial/apis/metorial-api.md) - [All operations](https://skmtc.dev/metorial/apis/metorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metorial/apis/metorial-api/revisions/10ccc89f3eac?raw)