API explorerTeams
Create a 7-day join link (admin or owner)
Family capacity and administrative member limits apply. Accepting an invite is human-only: there is no agent route for it.
Loading API reference…
Required scopes: teams:write
POST
bearer teams:writeheader
AuthorizationBearer <token>A Notify agent token from notify auth login or the dashboard.
Scope: teams:write
id*stringapplication/json- body
email?stringMatch
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Format
emailLength
length <= 254domain?stringMatch
^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,}$Length
length <= 253role?stringDefault
"member"Value in
"admin""member"Success
application/json- response
invite*code*stringPlaintext join code, returned once.
url*stringJoin link a person opens to accept (accepting is human-only).
curl -X POST 'https://example.com/api/agent/teams/string/invites' \ -H 'Content-Type: application/json' \ -d '{}'{ "invite": { "id": "string", "teamId": "string", "email": "string", "domain": "string", "role": "owner", "invitedBy": "string", "expiresAt": "2019-08-24T14:15:22Z", "acceptedAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }, "code": "string", "url": "string"}