Client
Get Client
- Endpoint:
GET /clients/settings
- JSON request data:
| Name | Type | Read-only | Comment |
|---|---|---|---|
| id | integer | yes | Id of client |
| name | string | no | The client's name |
| description | string | no | The client's description |
| logo | File | no | The client's logo |
| string | yes | The client's email | |
| phone | string | no | The client's phone |
| fax | string | no | The client's fax |
| rera | string | no | The client's rera |
| rera_expired_at | string | no | The client's rera expired date |
| dtcm | numeric | no | The client's dtcm |
| dtcm_expired_at | string | no | The client's dtcm expired date |
| license_authority | string | no | license authority |
| address | string | no | The client's address |
| pobox | string | no | The client's pobox / postalcode |
| city | string | no | The client's city |
| country | string | yes | The client's country |
| group | string | no | The client's groups : 'fulladmin', 'open', 'restrictive', 'customize' |
| created_at | datetime | yes | The client's created date (W3C format) |
| updated_at | datetime | yes | The client's updated date (W3C format) |
| portals | array | no | array of portals code |
| watermark | Watermark object | no | Watermark settings |
Watermark data :
| Name | Type | Read-only | Comment |
|---|---|---|---|
| type | string | yes | The client's watermark type : 'text' or 'image' |
| position | string | no | The client's watermark position : 'center', 'top_left', 'top_right', 'bottom_left', 'bottom_right' |
| opacity | integer | no | 0 to 100 |
in case of watermark image, you'll get these extra data:
| Name | Type | Read-only | Comment |
|---|---|---|---|
| image | File | yes | The client's watermark image |
| size | string | no | The client's watermark text |
in case of watermark text, you'll get these extra data:
| Name | Type | Read-only | Comment |
|---|---|---|---|
| text | string | yes | The client's watermark text |
| font | string | no | 'opensans', 'roboto' or 'cambria' |
| font_ratio | string | no | 0 to 1 |
Portal data :
| Name | Type | Read-only | Comment |
|---|---|---|---|
| code | string | yes | Portal code |
| enabled | boolean | no | If portal is enabled or not |
| last_generated | date | no | date when feed was generated |
| last_fetched | date | no | date when feed was fetched |
| enabled | boolean | no | If portal is enabled or not |
- JSON response example:
{
"client": {
"id": 2,
"name": "Illusion test - Company",
"description": "testing",
"logo": {
"id": 5646034,
"link": "https:\/\/s3-ap-southeast-1.amazonaws.com\/mycrm-pro-accounts-v2\/client\/logo\/2\/orhQkd9Ljz24GO0q.png",
"created_at": "2017-10-23T15:51:42+04:00"
},
"email": "jonathan@propertyfinder.ae",
"phone": "+971 55 783 4988",
"fax": "+971 55 783 4998",
"rera": "11958",
"rera_expired_at": "2020-09-09",
"dtcm": 123434,
"dtcm_expired_at": "2020-09-09",
"address": "123 main street",
"pobox": "123",
"city": "Dubai marina",
"country": "AE",
"license_authority": "testing authority",
"watermark": {
"position": "center",
"type": "image",
"text": null,
"image": {
"id": 23754276,
"link": "https:\/\/s3-ap-southeast-1.amazonaws.com\/mycrm-pro-accounts-v2\/client\/watermark\/2\/EZZQ5u2CghXbGnQf.png",
"created_at": "2019-10-01T15:05:12+04:00"
},
"size": 80,
"font": null,
"opacity": 50,
"font_ratio": null,
"is_locked": false
},
"created_at": "2014-11-07T16:22:16+04:00",
"updated_at": "2020-08-04T07:05:06+04:00",
"unique_dtcm": false,
"rera_mandatory": false,
"verified_skipped": false,
"subscription": "paid",
"subscription_status": "signed",
"roles": {
"admin": {
"property.read": true,
"property.read.other": true,
"property.update": true,
"property.update.other": true,
"property.approve": true,
"property.approve.other": true,
"property.publish": true,
"property.publish.other": true,
"lead.read": true,
"lead.read.other": true,
"lead.update": true,
"lead.update.other": true,
"landlord.read": true,
"landlord.update": true,
"user.read": true,
"user.update": true,
"client.read": true,
"client.update": true,
"profile.update": true,
"profile.read": true,
"landlord.read.other": true,
"landlord.update.other": true,
"lead.read.other.attributes": true,
"landlord.read.other.attributes": true,
"property.read.other.attributes": true,
"property.delete": true,
"lead.delete": true,
"landlord.delete": true,
"property.delete.other": true,
"lead.delete.other": true,
"landlord.delete.other": true
},
"manager": {
"property.read": true,
"property.read.other": true,
"property.update": true,
"property.update.other": true,
"property.approve": true,
"property.approve.other": false,
"property.publish": true,
"property.publish.other": true,
"lead.read": true,
"lead.read.other": true,
"lead.update": true,
"lead.update.other": false,
"landlord.read": true,
"landlord.update": true,
"user.read": true,
"user.update": true,
"client.read": true,
"client.update": false,
"profile.update": true,
"profile.read": true,
"landlord.read.other": true,
"landlord.update.other": true,
"lead.read.other.attributes": true,
"landlord.read.other.attributes": true,
"property.read.other.attributes": true,
"property.delete": true,
"lead.delete": true,
"landlord.delete": true,
"property.delete.other": true,
"lead.delete.other": false,
"landlord.delete.other": false
},
"agent": {
"property.read": true,
"property.read.other": true,
"property.update": true,
"property.update.other": false,
"property.approve": false,
"property.approve.other": false,
"property.publish": false,
"property.publish.other": false,
"lead.read": true,
"lead.read.other": true,
"lead.update": true,
"lead.update.other": false,
"landlord.read": true,
"landlord.update": true,
"user.read": true,
"user.update": true,
"client.read": true,
"client.update": false,
"profile.update": true,
"profile.read": true,
"landlord.read.other": true,
"landlord.update.other": false,
"lead.read.other.attributes": false,
"landlord.read.other.attributes": false,
"property.read.other.attributes": false,
"property.delete": false,
"lead.delete": false,
"landlord.delete": false,
"property.delete.other": false,
"lead.delete.other": false,
"landlord.delete.other": false
}
},
"group": "customize",
"portals": [{
"code": "propertyfinder",
"enabled": true,
"last_generated": "2020-08-03T17:14:50+04:00",
"last_fetched": "2020-08-03T17:12:53+04:00"
}, {
"code": "dubizzle",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "gulfnews",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "privatesite",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "yzerproperty",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "genericportal",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "rightmove",
"enabled": true,
"last_generated": null,
"last_fetched": null
}],
"packages": {
"list": ["package.activity-logs", "package.calendar-management", "package.custom-reference-number", "package.custom.fields", "package.dashboard", "package.drag-drop", "package.genius-reporting", "package.lead-status-update", "package.matching", "package.mls", "package.owner-management", "package.pf-floor-plan", "package.realtime-publication", "package.status-page", "package.transactions", "package.users-permission-managements", "package.wordpress-integration", "package.zapier-integration"],
"configuration": {
"max-allowed-users": "4"
}
},
"right_move_branch_id": null,
"contract_infos": {
"has_smart_ads": false,
"has_call_tracking": false,
"listing_size": 0,
"used_listing": 0,
"used_premium": 0,
"premium_size": 0,
"used_featured": 0,
"featured_size": 0,
"used_rental": 0,
"rental_size": 0,
"location_based_contract_infos": []
},
"pf_flex": true
}
}
Update Client
- Endpoint:
PUT /clients/settings
- JSON request data:
| Name | Type | Read-only | Comment |
|---|---|---|---|
| id | integer | yes | Id of client |
| portals | array | no | Portals associated to the client (not expanded by default) |
| name | string | no | The client's name |
| description | string | no | The client's description |
| logo | integer/string | no | Upload token related to the new logo or current file ID |
| string | yes | The client's email | |
| phone | string | no | The client's phone |
| fax | string | no | The client's fax |
| rera | string | no | The client's rera |
| rera_expired_at | string | no | The client's rera expired date |
| address | string | no | The client's address |
| pobox | string | no | The client's pobox / postalcode |
| city | string | no | The client's city |
| country | string | yes | The client's country |
| group | string | no | The client's groups : 'fulladmin', 'open', 'restrictive', 'customize' |
| created_at | datetime | yes | The client's created date (W3C format) |
| updated_at | datetime | yes | The client's updated date (W3C format) |
| portals | array | no | array of portal code |
| watermark | Watermark object | no | Watermark settings |
- JSON response example:
{
"client": {
"id": 2,
"name": "Illusion test - Company",
"description": "testing",
"logo": {
"id": 5646034,
"link": "https:\/\/s3-ap-southeast-1.amazonaws.com\/mycrm-pro-accounts-v2\/client\/logo\/2\/orhQkd9Ljz24GO0q.png",
"created_at": "2017-10-23T15:51:42+04:00"
},
"email": "jonathan@propertyfinder.ae",
"phone": "+971 55 783 4988",
"fax": "+971 55 783 4998",
"rera": "11958",
"rera_expired_at": "2020-09-09",
"dtcm": 123434,
"dtcm_expired_at": "2020-09-09",
"address": "123 main street",
"pobox": "123",
"city": "Dubai marina",
"country": "AE",
"license_authority": "testing authority",
"watermark": {
"position": "center",
"type": "image",
"text": null,
"image": {
"id": 23754276,
"link": "https:\/\/s3-ap-southeast-1.amazonaws.com\/mycrm-pro-accounts-v2\/client\/watermark\/2\/EZZQ5u2CghXbGnQf.png",
"created_at": "2019-10-01T15:05:12+04:00"
},
"size": 80,
"font": null,
"opacity": 50,
"font_ratio": null,
"is_locked": false
},
"created_at": "2014-11-07T16:22:16+04:00",
"updated_at": "2020-08-04T07:05:06+04:00",
"unique_dtcm": false,
"rera_mandatory": false,
"verified_skipped": false,
"subscription": "paid",
"subscription_status": "signed",
"roles": {
"admin": {
"property.read": true,
"property.read.other": true,
"property.update": true,
"property.update.other": true,
"property.approve": true,
"property.approve.other": true,
"property.publish": true,
"property.publish.other": true,
"lead.read": true,
"lead.read.other": true,
"lead.update": true,
"lead.update.other": true,
"landlord.read": true,
"landlord.update": true,
"user.read": true,
"user.update": true,
"client.read": true,
"client.update": true,
"profile.update": true,
"profile.read": true,
"landlord.read.other": true,
"landlord.update.other": true,
"lead.read.other.attributes": true,
"landlord.read.other.attributes": true,
"property.read.other.attributes": true,
"property.delete": true,
"lead.delete": true,
"landlord.delete": true,
"property.delete.other": true,
"lead.delete.other": true,
"landlord.delete.other": true
},
"manager": {
"property.read": true,
"property.read.other": true,
"property.update": true,
"property.update.other": true,
"property.approve": true,
"property.approve.other": false,
"property.publish": true,
"property.publish.other": true,
"lead.read": true,
"lead.read.other": true,
"lead.update": true,
"lead.update.other": false,
"landlord.read": true,
"landlord.update": true,
"user.read": true,
"user.update": true,
"client.read": true,
"client.update": false,
"profile.update": true,
"profile.read": true,
"landlord.read.other": true,
"landlord.update.other": true,
"lead.read.other.attributes": true,
"landlord.read.other.attributes": true,
"property.read.other.attributes": true,
"property.delete": true,
"lead.delete": true,
"landlord.delete": true,
"property.delete.other": true,
"lead.delete.other": false,
"landlord.delete.other": false
},
"agent": {
"property.read": true,
"property.read.other": true,
"property.update": true,
"property.update.other": false,
"property.approve": false,
"property.approve.other": false,
"property.publish": false,
"property.publish.other": false,
"lead.read": true,
"lead.read.other": true,
"lead.update": true,
"lead.update.other": false,
"landlord.read": true,
"landlord.update": true,
"user.read": true,
"user.update": true,
"client.read": true,
"client.update": false,
"profile.update": true,
"profile.read": true,
"landlord.read.other": true,
"landlord.update.other": false,
"lead.read.other.attributes": false,
"landlord.read.other.attributes": false,
"property.read.other.attributes": false,
"property.delete": false,
"lead.delete": false,
"landlord.delete": false,
"property.delete.other": false,
"lead.delete.other": false,
"landlord.delete.other": false
}
},
"group": "customize",
"portals": [{
"code": "propertyfinder",
"enabled": true,
"last_generated": "2020-08-03T17:14:50+04:00",
"last_fetched": "2020-08-03T17:12:53+04:00"
}, {
"code": "dubizzle",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "gulfnews",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "privatesite",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "yzerproperty",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "genericportal",
"enabled": true,
"last_generated": null,
"last_fetched": null
}, {
"code": "rightmove",
"enabled": true,
"last_generated": null,
"last_fetched": null
}],
"packages": {
"list": ["package.activity-logs", "package.calendar-management", "package.custom-reference-number", "package.custom.fields", "package.dashboard", "package.drag-drop", "package.genius-reporting", "package.lead-status-update", "package.matching", "package.mls", "package.owner-management", "package.pf-floor-plan", "package.realtime-publication", "package.status-page", "package.transactions", "package.users-permission-managements", "package.wordpress-integration", "package.zapier-integration"],
"configuration": {
"max-allowed-users": "4"
}
},
"right_move_branch_id": null,
"contract_infos": {
"has_smart_ads": false,
"has_call_tracking": false,
"listing_size": 0,
"used_listing": 0,
"used_premium": 0,
"premium_size": 0,
"used_featured": 0,
"featured_size": 0,
"used_rental": 0,
"rental_size": 0,
"location_based_contract_infos": []
},
"pf_flex": true
}
}
Client Actions
- Endpoint:
PATCH /clients/settings
- JSON request:
Some actions are available:
Refresh client package:
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| op | string | yes | Operation to execute (refresh) |
| path | string | yes | Path "/contract_infos" to update the state. |
| value | null | yes | null |
- JSON request example with mixed operations:
{
"operations": [
{ "op": "refresh", "path": "/contract_infos", "value": null}
]
}
GET /clients/credits
- Allowed for:
Anyone who can read properties
{
"credits": {
"value": 100,
"valid_from": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z"
}
}
- Error Messages from API side
** If client is not on PF
{
"error": "InvalidAction",
"messages": [
"Client is not on Property Finder."
]
}
** If not credit Pf Client
{
"error": "InvalidAction",
"messages": [
"Not Found"
]
}