Skip to content
invites

Mint coordinator invites (owner grant-authed)

POST
/admin/v1/invites
curl --request POST \
--url https://aggregator.example.com/admin/v1/invites \
--header 'Content-Type: application/json' \
--data '{ "grant": "example", "recipients": [ { "email": "example", "name": "example" } ] }'

Authed by the owner grant token. A valid grant mints/refreshes one 14-day invite per recipient and emails each. An expired grant mints nothing and re-mails a fresh grant to the registered owner (recovery). Per-org rate limited. Only registered when ORG_HIERARCHY_ENABLED=true.

Media typeapplication/json
object
grant
required
string
>= 1 characters
recipients
required
Array<object>
>= 1 items <= 10 items
object
email
required
string
>= 3 characters
name
string
Examplegenerated
{
"grant": "example",
"recipients": [
{
"email": "example",
"name": "example"
}
]
}

Default Response

Media typeapplication/json
object
recovered
required
boolean
sent
required
integer
resent
required
integer
invalid
required
Array<object>
object
email
required
string
reason
required
string
Examplegenerated
{
"recovered": true,
"sent": 1,
"resent": 1,
"invalid": [
{
"email": "example",
"reason": "example"
}
]
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}