POST
/
v1
/
invitations
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.organizations.createInvitation({
  body: {},
})
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "invitedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token": "<string>",
  "expiresAt": "<string>",
  "revokedAt": "<string>",
  "revokedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>"
}

Body

application/json
organizationId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
email
string
required

a string matching the pattern ^[^\s@]+@[^\s@]+.[^\s@]+$

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
role
enum<string>
required
Available options:
admin,
member
teamId
string<uuid>

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
membershipType
enum<string>
Available options:
team,
client

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
organizationId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
email
string
required

a string matching the pattern ^[^\s@]+@[^\s@]+.[^\s@]+$

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
role
enum<string>
required
Available options:
admin,
member,
viewer
status
enum<string>
required
Available options:
pending,
accepted,
revoked,
expired
invitedByUserId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
token
string
required
expiresAt
string
required
revokedAt
string | null
required
revokedByUserId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
teamId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
membershipType
enum<string>
required
Available options:
team,
client
createdAt
string
required