Skip to content
Acriva

CreateInvitation

POST
/api/v1/t/{tenant}/invitations
curl --request POST \
  --url https://example.com/api/v1/t/example/invitations \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string
roleId
required
string format: uuid
Examplegenerated
{
  "email": "example",
  "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Created

Media typeapplication/json
object
id
required
string format: uuid
email
required
string
roleId
required
string format: uuid
roleName
required
string
status
required
Allowed values: Pending Accepted Revoked Expired
invitedBy
required
string format: uuid
createdAt
required
string format: date-time
expiresAt
required
string format: date-time
acceptedAt
required
null | string format: date-time
Example
{
  "status": "Pending"
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}