Skip to content

Create an invitation with optional pre-seeded metadata

POST
/api/server/v1/invitations
curl --request POST \
--url https://api.torii.so/api/server/v1/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "example", "expiresInDays": 1, "redirectUrl": "example", "publicMetadata": {}, "privateMetadata": {} }'
Media type application/json
object
email
required
string
expiresInDays
integer | null format: int32
redirectUrl
string | null
publicMetadata
required
object
key
additional properties
any
privateMetadata
required
object
key
additional properties
any
Example generated
{
"email": "example",
"expiresInDays": 1,
"redirectUrl": "example",
"publicMetadata": {},
"privateMetadata": {}
}

OK

Media type application/json
object
id
required
string format: uuid
environmentId
required
string format: uuid
email
required
string
status
required
string
Allowed values: PENDING ACCEPTED REVOKED EXPIRED
expiresAt
required
string format: date-time
createdAt
required
string format: date-time
acceptedAt
string | null format: date-time
revokedAt
string | null format: date-time
Example
{
"status": "PENDING"
}