Create an app invite
Creates a new app invite for a company.
Requires an app client credentials token. The invite is created in pending status
and includes a generated invite code.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request body for creating a new app invite.
The base URL for the invite link. Must be a valid URI with a scheme and host.
"https://example.com/invite"
The ID of the app installation to create the invite for.
42
Optional custom JSON data to associate with the invite.
An optional display name for the invite. Maximum 1000 characters.
"Partner onboarding invite"
An optional name for the invitee. Maximum 1024 characters.
"Jane Smith"
A list of tags to associate with the invite. Each tag is max 128 characters.
Response
Successfully created the app invite.
An app invite with full details.
Unique identifier for the app invite.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Summary information about an app.
The 24-character invite code.
"abc123def456ghi789jkl012"
Summary information about a company.
The timestamp when the invite was created.
"2025-01-01T00:00:00Z"
The lifecycle status of an app invite.
pending, active, archived "pending"
The timestamp when the invite was last updated.
"2025-01-15T10:30:00Z"
The full invite URL constructed from the base URL and invite code.
"https://example.com/invite?code=abc123def456ghi789jkl012"
The timestamp when the invite was activated, or null if not yet activated.
"2025-01-15T10:30:00Z"
Custom JSON data associated with the invite.
An optional display name for the invite.
"Partner onboarding invite"
An optional name for the invitee. Maximum 1024 characters.
"Jane Smith"
A list of tags associated with the invite. Each tag is max 128 characters.

