Property Users Collection

Property User is an association between a Property and and User, represents who can manage a property and with which role and access rights.
Property Users List
Retrieve list of properties associated with user.
Request
Success Response
Error Response
Request:
1
GET https://staging.channex.io/api/v1/property_users?filter[property_id]=PROPERTY_ID
Copied!
Success Response Example
Status Code: 200 OK
1
{
2
  "data": [
3
    {
4
      "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
5
      "type": "property_user"
6
      "attributes": {
7
        "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
8
        "overrides": null,
9
        "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
10
        "role": "owner",
11
        "user_id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184"
12
      },
13
      "relationships": {
14
        "property": {
15
          "data": {
16
            "id": "52397a6e-c330-44f4-a293-47042d3a3607",
17
            "type": "property"
18
          }
19
        },
20
        "user": {
21
          "data": {
22
            "id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184",
23
            "type": "user",
24
            "email": "[email protected]",
25
            "name": "Channex User"
26
          }
27
        }
28
      }
29
    }
30
  ]
31
}
Copied!
Unauthorised Error Response
Status Code: 401 Unauthorized
1
{
2
  "errors": {
3
    "code": "unauthorized",
4
    "title": "Unauthorized"
5
  }
6
}
Copied!
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a list of Property User objects in the answer.

Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided. 
Invite User to Property
Create new Property User.
Request
Success Response
Error Response
Request:
1
POST https://staging.channex.io/api/v1/property_users
Copied!
Query body (JSON):
1
{
2
  "invite": {
3
    "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
4
    "user_email": "[email protected]",
5
    "role": "user",
6
    "overrides": {}
7
  }
8
}
Copied!
Success Response Example
Status Code: 201 Created
1
{
2
  "data": {
3
    "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
4
    "type": "property_user"
5
    "attributes": {
6
      "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
7
      "overrides": null,
8
      "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
9
      "role": "owner",
10
      "user_id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184"
11
    },
12
    "relationships": {
13
      "property": {
14
        "data": {
15
          "id": "52397a6e-c330-44f4-a293-47042d3a3607",
16
          "type": "property"
17
        }
18
      },
19
      "user": {
20
        "data": {
21
          "id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184",
22
          "type": "user",
23
          "email": "[email protected]",
24
          "name": "Channex User"
25
        }
26
      }
27
    }
28
  }
29
}
Copied!
Bad Request Error Response
Status Code: 400 Bad Request
1
{
2
  "errors": {
3
    "code": "bad_request",
4
    "title": "Bad Request",
5
    "details": "User already invited"
6
  }
7
}
Copied!
Unauthorised Error Response
Status Code: 401 Unauthorized
1
{
2
  "errors": {
3
    "code": "unauthorized",
4
    "title": "Unauthorized"
5
  }
6
}
Copied!
Forbidden Error Response
Status Code: 403 Forbidden
1
{
2
  "errors": {
3
    "code": "forbidden",
4
    "title": "Forbidden"
5
  }
6
}
Copied!
Validation Error Response
Status Code: 422 Unprocessable Entity
1
{
2
  "errors": {
3
    "code": "validation_error",
4
    "title": "Validation Error",
5
    "details": {
6
      "user_email": [
7
        "can't be blank"
8
      ]
9
    }
10
  }
11
}
Copied!
Fields
property_id [required]
String with valid UUID for Property object what you would use as target for invitation.
user_email [required]
String with a valid email address of invited user.
Note: If user is not registered at our system, we are create they account automatically and send email with instructions to on-board into channex.io.
role [required]
String with a valid role name.
Right now you can use 2 roles - owner and user.
overrides [optional]
JSON Object with access policies overrides.
Returns
Success
Method can return a Success result with 201 Created HTTP Code if operation is successful. Will contain a Property User object in the answer.

Bad Request Error
Method can return a Bad Request Error result with 400 Bad Request HTTP Code if provided user already invited.

Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided.

Forbidden Error
Method can return a Forbidden Error result with 403 Forbidden HTTP Code if current user not have permissions to invite user into provided property.
Validation Error
Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.
Get Property User by ID
Retrieve Property User by ID.
Request
Success Response
Error Response
Request:
1
GET https://staging.channex.io/api/v1/property_users/:id
Copied!
Success Response Example
Status Code: 200 OK
1
{
2
  "data": {
3
    "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
4
    "type": "property_user"
5
    "attributes": {
6
      "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
7
      "overrides": null,
8
      "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
9
      "role": "owner",
10
      "user_id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184"
11
    },
12
    "relationships": {
13
      "property": {
14
        "data": {
15
          "id": "52397a6e-c330-44f4-a293-47042d3a3607",
16
          "type": "property"
17
        }
18
      },
19
      "user": {
20
        "data": {
21
          "id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184",
22
          "type": "user",
23
          "email": "[email protected]",
24
          "name": "Channex User"
25
        }
26
      }
27
    }
28
  }
29
}
Copied!
Validation Error Response
Status Code: 401 Unauthorized
1
{
2
  "errors": {
3
    "code": "unauthorized",
4
    "title": "Unauthorized"
5
  }
6
}
Copied!
Forbidden Error Response
Status Code: 403 Forbidden
1
{
2
  "errors": {
3
    "code": "forbidden",
4
    "title": "Forbidden"
5
  }
6
}
Copied!
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Property User object in the answer.

Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided. 

Forbidden Error
Method can return a Forbidden Error result with 403 Forbidden HTTP Code if current user not have permissions to call this action.
Update Property User
Update property access information.
Request
Success Response
Error Response
Request:
1
PUT https://staging.channex.io/api/v1/property_users/:id
Copied!
Query body (JSON):
1
{
2
  "property_user": {
3
    "role": "user",
4
    "overrides": null
5
  }
6
}
Copied!
Success Response Example
Status Code: 200 OK
1
{
2
  "data": {
3
    "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
4
    "type": "property_user"
5
    "attributes": {
6
      "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
7
      "overrides": null,
8
      "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
9
      "role": "owner",
10
      "user_id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184"
11
    },
12
    "relationships": {
13
      "property": {
14
        "data": {
15
          "id": "52397a6e-c330-44f4-a293-47042d3a3607",
16
          "type": "property"
17
        }
18
      },
19
      "user": {
20
        "data": {
21
          "id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184",
22
          "type": "user",
23
          "email": "[email protected]",
24
          "name": "Channex User"
25
        }
26
      }
27
    }
28
  }
29
}
Copied!
Unauthorised Error Response
Status Code: 401 Unauthorized
1
{
2
  "errors": {
3
    "code": "unauthorized",
4
    "title": "Unauthorized"
5
  }
6
}
Copied!
Forbidden Error Response
Status Code: 403 Forbidden
1
{
2
  "errors": {
3
    "code": "forbidden",
4
    "title": "Forbidden"
5
  }
6
}
Copied!
Resource Not Found Error Response
Status Code: 404 Not Found
1
{
2
  "errors": {
3
    "code": "resource_not_found",
4
    "title": "Resource Not Found"
5
  }
6
}
Copied!
Validation Error Response
Status Code: 422 Unprocessable Entity
1
{
2
  "errors": {
3
    "code": "validation_error",
4
    "title": "Validation Error",
5
    "details": {
6
      "role": [
7
        "can't be blank"
8
      ]
9
    }
10
  }
11
}
Copied!
Fields
Through this method you can update only two fields - role and overrides. Please see Invite User to Property for more detailed information.
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Property User object in the answer.

Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided.

Forbidden Error
Method can return a Forbidden Error result with 403 Forbidden HTTP Code if current user not have permissions to call this action.

Resource Not Found Error
Method can return a Resource Not Found Error result with 404 Not Found HTTP Code if requested Property User is not defined.
Validation Error
Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.
Withdraw Property User Access
Revoke Property User access to a specific property.
Request
Success Response
Error Response
Request:
1
DELETE https://staging.channex.io/api/v1/property_users/:id
Copied!
Success Response Example
Status Code: 200 OK
1
{
2
  "meta": {
3
    "message": "Success"
4
  }
5
}
Copied!
Bad Request Error Response
Status Code: 400 Bad Request
1
{
2
  "errors": {
3
    "code": "bad_request",
4
    "details": "User can not withdraw themself",
5
    "title": "Bad Request"
6
  }
7
}
Copied!
Unauthorised Error Response
Status Code: 401 Unauthorized
1
{
2
  "errors": {
3
    "code": "unauthorized",
4
    "title": "Unauthorized"
5
  }
6
}
Copied!
Forbidden Error Response
Status Code: 403 Forbidden
1
{
2
  "errors": {
3
    "code": "forbidden",
4
    "title": "Forbidden"
5
  }
6
}
Copied!
Resource Not Found Error Response
Status Code: 404 Not Found
1
{
2
  "errors": {
3
    "code": "resource_not_found",
4
    "title": "Resource Not Found"
5
  }
6
}
Copied!
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful.

Bad Request Error
Method can return a Bad Request Error result with 400 Bad Request HTTP Code if user will try to remove them self.

Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided.

Forbidden Error
Method can return a Forbidden Error result with 403 Forbidden HTTP Code if current user not have permissions to call this action.

Resource Not Found Error
Method can return a Resource Not Found Error result with 404 Not Found HTTP Code if requested Property User is not defined.

FOR PMS - Previous

Properties Collection

Next - FOR PMS

Groups Collection

Last modified 2yr ago

Copy link

Contents

Property Users List

Returns

Invite User to Property

Fields

Returns

Get Property User by ID

Withdraw Property User Access

Returns