Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.

post/invite/check

Request

Base URL
{{ server_url }}/v1
Auth
none declared
TypeScript
https://skmtc.dev/athenian/apis/title/docs/invite/check/post.ts
A function with typed inputs. Its response is checked against the schema.

urlstring url required

Invitation URL. Users are supposed to click it and become admins or regular account members.

{
  "url": "https://app.athenian.co/i/deadf88d"
}

Result of checking an invitation URL: invitation type, whether it is correctly formed and is enabled.

activeboolean

Value indicating whether the invitation is still enabled.

type'admin' | 'regular'

Invited user's account membership status.

validboolean required

Value indicating whether the invitation URL is correctly formed.

{
  "active": true,
  "type": "regular",
  "valid": true
}

No recorded changes to this operation across all 70 revisions of this API.