HomeEscape API

Service

Name	Edit Property Contact
Description	Edit the contact person of a property
Method	PUT
URL	/properties/{property}/contact
Example	/api/properties/11111111/contact
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Id of the property.
name	text	yes	Name of the person of contact.
email	text	yes	Email of the contact person.
email_display	bool	yes	If want to show the email.
name_display	bool	yes	If want to show the name of contact.
code1	number	yes	Country calling code for the phone number 1.
phone1	number	yes	Phone 1 of the contact person.
phone1_display	bool	yes	If want to show the contact phone 1.
phone1_sms	bool	yes	If want to receive sms alert in the contact phone 1.
code2	number	yes	Country calling code for the phone number 2.
phone2	number	no	Phone 2 of the contact person.
phone2_display	bool	no	If want to show the contact phone 2.
phone2_sms	bool	no	If want to receive sms alert in the contact phone 2.
code3	number	yes	Country calling code for the phone number 3.
phone3	number	no	Phone 3 of the contact person.
phone3_display	bool	no	If want to show the contact phone 3.
phone3_sms	bool	no	If want to receive sms alert in the contact phone 3.
fax	text	no	Fax of person of contact.
fax_display	bool	no	If want to show the fax.
languages	array	yes	Specifies the language spoken by the owner. Check here.
other_contacts	array	no	Add other person of contact. Check here.

Response

            
                {
                    "code": R111,
                    "message": "Success"
                }

Response Codes

Code	Message	Cause	Possible Frontend Message [Behavior]
`EC000`	`Internal error in API`	Internal error connecting the database	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
`EC001`	`User not found`	Token user id doesn't match our records	"Sorry, We couldn't find your information!"
`EC002`	`Property not found`	Property id doesn't match our records	"Sorry, We couldn't find that property!"
`EC014`	`Property doesn't belong to that user`	The user logged in is not the property's owner	"Sorry, you do not have access to that property!"
`R000`	`Fail`	The property contact wasn't created
`R111`	`Success`	The operation was successful
`SC006`	`User no authorization`	The token role is not valid for using the API services	"You have been logged out." - [Take the user to the login screen]
`SC014`	`Expired token`	The token has expired	"You have been logged out." - [Take the user to the login screen]
`VID112`	`Invalid input for property`	Property id is not a number	[Call the API again using a valid value for property id]
`VID130`	`Invalid input for contact name`	Name is empty or it doesn't have only letters	"Please fill out this field" - "Contact name must have only letters"
`VID131`	`Invalid input for contact name_display`	Name_display is not in [0, 1]	[Call the API again using a valid value for name_display]
`VID132`	`Invalid input for contact phone1`	Phone1 doesn't have only numbers	"Please fill out this field" - "Please match the requested format (ex: 3334445555)"
`VID133`	`Invalid input for contact phone1_display`	Phone1_display is not in [0, 1]	[Call the API again using a valid value for phone1_display]
`VID134`	`Invalid input for contact phone1_sms`	Phone1_sms is not in [0, 1]	[Call the API again using a valid value for phone1_sms]
`VID135`	`Invalid input for contact phone2`	Phone2 doesn't have only numbers	"Please match the requested format (ex: 3334445555)"
`VID136`	`Invalid input for contact phone2_display`	Phone2_display is not in [0, 1]	[Call the API again using a valid value for phone2_display]
`VID137`	`Invalid input for contact phone2_sms`	Phone2_sms is not in [0, 1]	[Call the API again using a valid value for phone2_sms]
`VID138`	`Invalid input for contact phone3`	Phone3 doesn't have only numbers	"Please match the requested format (ex: 3334445555)"
`VID139`	`Invalid input for contact phone3_display`	Phone3_display is not in [0, 1]	[Call the API again using a valid value for phone3_display]
`VID140`	`Invalid input for contact phone3_sms`	Phone3_sms is not in [0, 1]	[Call the API again using a valid value for phone3_sms]
`VID101`	`Invalid input for email`	Email is empty or it doesn't meet the email's format	"Please fill out this field" - "Please enter a valid email address (ex: email@homeescape.com)"
`VID141`	`Invalid input for email_display`	Email_display is not in [0, 1]	[Call the API again using a valid value for email_display]
`VID142`	`Invalid input for fax`	Fax doesn't have only numbers	"Please match the requested format (ex: 3334445555)"
`VID143`	`Invalid input for fax_display`	Fax_display is not in [0, 1]	[Call the API again using a valid value for email_display]
`VID144`	`Invalid input for languages`	Languages is not an array with 8 items or its items are not in [0,1]. At least one must be 1	"Please select at least one language" - [Call the API again using a valid array of languages]
`VID146`	`Invalid input for name in other_contacts "x"`	Name in other_contacts is empty or it doesn't have only letters	"Please fill out this field" - "Contact name must have only letters"
`VID147`	`Invalid input for email in other_contacts "x"`	Email in other_contacts is empty or it doesn't meet the email's format	"Please fill out this field" - "Please enter a valid email address (ex: email@homeescape.com)"
`VID148`	`Invalid input for phone in other_contacts "x"`	Phone in other_contacts doesn't have only numbers	"Please match the requested format (ex: 3334445555)"
`VID149`	`Invalid input for sms in other_contact "x"`	Sms in other_contacts is not in [0, 1]	[Call the API again using a valid value for sms in other_contacts "x"]
`VID145`	`Invalid input for array other_contacts`	Other_contacts is not an array with less than 5 items	[Call the API again using a valid array of other_contacts]
`VID280`	`Invalid input for code1`	Code1 doesn't have only numbers	"Please select an item in the list" - [Call the API again using a valid value for code1]
`VID281`	`Invalid input for code2`	Code2 doesn't have only numbers	[Call the API again using a valid value for code2]
`VID283`	`Invalid input for code3`	Code3 doesn't have only numbers	[Call the API again using a valid value for code3]
`VID284`	`Invalid input for code in other_contacts "x"`	Code in other_contacts doesn't have only numbers	[Call the API again using a valid value for code in other_contacts "x"]