POST
Create tenant invitation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

renter_id
string<uuid>
required

Path parameter renter_id.

Body

application/json

JSON request payload for tenant_create_invitation.

Request payload for create tenant invitation.

email
string<email> | null

Email address associated with the user or renter.

Maximum string length: 254
phone
string | null

Phone number associated with the renter or user.

Maximum string length: 40
expires_in_days
integer<int64> | null

expires in days value for create tenant invitation request.

Required range: 1 <= x <= 30

Response

Tenant API operation succeeded

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.