---
title: "POST /stages/invitation/invitations/"
method: POST
path: "/stages/invitation/invitations/"
tags: ["stages"]
---

# POST /stages/invitation/invitations/

`POST /stages/invitation/invitations/`

Invitation Viewset

## Request body

- InvitationRequest — Invitation Serializer
  - `name` string, required
  - `expires` string, date-time, nullable
  - `fixed_data` object
  - `single_use` boolean — When enabled, the invitation will be deleted after usage.
  - `flow` string, uuid, nullable — When set, only the configured flow can use this invitation.

## Response `201`

- Invitation — Invitation Serializer
  - `pk` string, uuid, required
  - `name` string, required
  - `expires` string, date-time, nullable
  - `fixed_data` object
  - `created_by` PartialUser, required — Partial User Serializer, does not include child relations.
    - `pk` integer, required
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `name` string, required — User's display name.
    - `is_active` boolean — Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
    - `last_login` string, date-time, nullable
    - `email` string, email
    - `attributes` object
    - `uid` string, required
  - `single_use` boolean — When enabled, the invitation will be deleted after usage.
  - `flow` string, uuid, nullable — When set, only the configured flow can use this invitation.
  - `flow_obj` Flow, required — Flow Serializer
    - `pk` string, uuid, required
    - `policybindingmodel_ptr_id` string, uuid, required
    - `name` string, required
    - `slug` string, required — Visible in the URL.
    - `title` string, required — Shown as the Title in Flow pages.
    - `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration', required
    - `background` string — Background shown during execution
    - `background_url` string, required — Get the URL to the background image
    - `background_themed_urls` ThemedUrls, required — Themed URLs - maps theme names to URLs for light and dark themes
      - `light` string, nullable
      - `dark` string, nullable
    - `stages` string[], required
    - `policies` string[], required
    - `cache_count` integer, required — Get count of cached flows
    - `policy_engine_mode` 'all' | 'any'
    - `compatibility_mode` boolean — Enable compatibility mode, increases compatibility with password managers on mobile devices.
    - `export_url` string, required — Get export URL for flow
    - `layout` 'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
    - `denied_action` 'message_continue' | 'message' | 'continue'
    - `authentication` 'none' | 'require_authenticated' | 'require_unauthenticated' | 'require_superuser' | 'require_redirect' | 'require_outpost' | 'require_token'

## Other responses

- `400`
- `403`

---

[API](https://skmtc.dev/goauthentik/apis/authentik.md) · [All operations](https://skmtc.dev/goauthentik/apis/authentik/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/goauthentik/authentik/revisions/4e42e86021d7/schema)