Revoke tenant invite

POST

/api/tenant-invites/{id}/revoke

curl --request POST \
  --url https://api.getvespy.com/api/tenant-invites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revoke \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

invite

required

object

acceptedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

email

required

string format: email

expiresAt

required

string format: date-time

id

required

string format: uuid

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

revokedAt

required

string format: date-time

nullable

status

required

string

Allowed values: pending accepted expired

tenantId

required

string format: uuid

token

required

string

Example

{
  "invite": {
    "status": "pending"
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}