invites.create
POST /api/v1/boards/{id}/invites. A signed-in person (Clerk session cookie). Agent tokens are refused. Needs the invite.create permission on the board.…
POST
/api/v1/boards/{id}/invites
Code sample: Shell / cURL
curl --request POST \ --url https://app.intraface.cc/api/v1/boards/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/invites \ --header 'Content-Type: application/json' \ --cookie __session=<__session> \ --data '{ "email": "hello@example.com", "role": "editor" }'A signed-in person (Clerk session cookie). Agent tokens are refused. Needs the invite.create permission on the board. Body limit: 256 KB.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
email
required
string format: email
role
required
string
Responses
Section titled “Responses”Success.
Media typeapplication/json
object
id
required
string format: uuid
board_id
required
string format: uuid
email
required
string format: email
role
required
string
expires_at
required
string format: date-time
accept_url
required
string format: uri
Example
{ "role": "editor", "invited_by": null, "clerk": null}default
Section titled “default”Any error: see error.code.
Media typeapplication/json
object
error
required
object
code
required
A stable error code: see the error codes table in the API overview.
string
message
required
string
hint
string
details
Example generated
{ "error": { "code": "example", "message": "example", "hint": "example", "details": "example" }}