SchemaApps

Create an Invitation for a Schema App

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

post/invites/schemaApp

Request

Base URL
https://api.smartthings.com/v1
Auth
- OAuth 2
  Implicithttps://auth-global.api.smartthings.com
  Scopesmobile
- or OAuth 2
  Implicithttps://auth-global.api.smartthings.com
  Scopesw: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.

Authorizationstring string required

OAuth token

schemaAppIdstring

The unique Id of the schema app

descriptionstring

Optional. Adds an invitation description shown to users who accept your invitation.

acceptLimitinteger

Optional. Limits the number of acceptances of an invitation. If not provided, invitation is limited to 500 installations.

Success

invitationIdstring

The unique identifier for the created invitation

shortCodestring

Optional. The short code associated with the invitation

Nov 7, 20262788a4236800 Revision changes
- info
  the security scope mobile was added to the endpoint's security scheme Bearer
- info
  the security scope w:invitations was removed from the endpoint's security scheme Bearer
Jul 27, 2026145c21700100 Revision changes
- info
  the security scope mobile was added to the endpoint's security scheme Bearer
- info
  the security scope w:invitations was removed from the endpoint's security scheme Bearer