---
title: "Create an Invitation for a Schema App"
method: POST
path: "/invites/schemaApp"
tags: ["SchemaApps"]
---

# Create an Invitation for a Schema App

`POST /invites/schemaApp`

## Request

- Base URL: `https://api.smartthings.com/v1`
- URL: `https://api.smartthings.com/v1/invites/schemaApp`
- Auth: one of:
  - OAuth 2
    - Implicit: `https://auth-global.api.smartthings.com`
    - Scopes: `mobile`
  - OAuth 2
    - Implicit: `https://auth-global.api.smartthings.com`
    - Scopes: `w:invitations`
- TypeScript: <https://skmtc.dev/smartthings/apis/smartthings-api/docs/invites/schemaApp/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a Schema app invitation. You may specify an acceptance limit and invitation description when creating your invitation.

## Headers

- `Authorization` string, string, required

## Request body

- CreateSchemaAppInviteRequest: A request to create a schema app invitation
  - `schemaAppId` string: The unique Id of the schema app
  - `description` string: Optional. Adds an invitation description shown to users who accept your invitation.
  - `acceptLimit` integer: Optional. Limits the number of acceptances of an invitation. If not provided, invitation is limited to 500 installations.

## Response `200`

Success

- CreateSchemaAppInviteResponse: A response to a create Schema App invitation request
  - `invitationId` string: The unique identifier for the created invitation
  - `shortCode` string: Optional. The short code associated with the invitation

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too many requests
- `default`: Unexpected error

## Changes

- **2026-11-07** `2788a4236800`: 2 info
  - the security scope `mobile` was added to the endpoint's security scheme `Bearer`
  - the security scope `w:invitations` was removed from the endpoint's security scheme `Bearer`
- **2026-07-27** `145c21700100`: 2 info
  - the security scope `mobile` was added to the endpoint's security scheme `Bearer`
  - the security scope `w:invitations` was removed from the endpoint's security scheme `Bearer`
- **2026-01-22** `6acc46f51053`: 2 info
  - the security scope `mobile` was added to the endpoint's security scheme `Bearer`
  - the security scope `w:invitations` was removed from the endpoint's security scheme `Bearer`
- **2025-05-16** `b04d2dce35dd`: 2 info
  - the security scope `mobile` was added to the endpoint's security scheme `Bearer`
  - the security scope `w:invitations` was removed from the endpoint's security scheme `Bearer`
- **2025-02-11** `32f2af0e7ed1`: 2 info
  - the security scope `mobile` was added to the endpoint's security scheme `Bearer`
  - the security scope `w:invitations` was removed from the endpoint's security scheme `Bearer`

[Operation history](https://skmtc.dev/smartthings/apis/smartthings-api/changes/invites/schemaApp/post.md)

---

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