Create Property User API

Invite a user to a property

post

/property_users

Invite a user to a property. A user without a Channex account gets one, and an onboarding email. An address already invited to the property is refused. The created access is returned with 201 Created.

Authorizations

user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Body

Request body accepted when inviting a user to a property.

Responses

201

201 Created response wrapping a resource body.

application/json

JSON:API document wrapping a single resource.

400

The request body could not be parsed as JSON.

application/json

401

Authentication credentials are missing or invalid.

application/json

403

The authenticated user lacks permission to perform this action.

application/json

422

The request has missing or invalid arguments; details lists the messages per argument.

application/json

post/property_users

POST /api/v1/property_users HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "invite": {
    "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
    "role": "owner",
    "overrides": {},
    "user_email": "[e-mail]"
  }
}

{
  "data": {
    "type": "property_user",
    "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
    "attributes": {
      "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
      "user_id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184",
      "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
      "role": "owner",
      "overrides": {}
    },
    "relationships": {
      "property": {
        "data": {
          "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
          "type": "property"
        }
      },
      "user": {
        "data": {
          "type": "user",
          "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
          "attributes": {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "name": "Channex User",
            "email": "[e-mail]"
          }
        }
      }
    }
  }
}