Create team invitation

POST

/api/v1/team/invitations

curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/team/invitations \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "role": "admin" }'

Invites a user to join the team by email. Sends an invitation email with an accept link.

Authorizations

• BearerAuth

Request Body

Invitation details

Media type application/json

object

email

required

string

role

required

string

Allowed values: admin member viewer

Responses

201

Created

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

created_at

string

email

string

expires_at

string

id

string

role

string

Example ^generated

{
  "data": {
    "created_at": "example",
    "email": "example",
    "expires_at": "example",
    "id": "example",
    "role": "example"
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

400

Bad Request

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

402

Payment Required

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

409

Conflict

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}