HomeEscape API

Service

Name	Contact Support
Description	Send an email to the support team
Method	POST
URL	/contact/support
Example	/api/contact/support
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
user_type	number	yes	User type, 0 - Traveler, 1 - Owner
first_name	text	yes	User first name
last_name	text	yes	User last name
email	text	yes	User email
phone	number	no	User phone number
message	text	yes	Text explaining why the user need to contact the support team
subject	text	yes	Small description of the message
property	number	no	Property id related to the message, if apply

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."
`EC002`	`Property not found`	Property id doesn't match our records	"Sorry, We couldn't find that property!"
`EC011`	`Status not found`	Status: "pending" doesn't match our records	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
`EC025`	`Error when try to send email`	Error trying to send the email with the ticket	"Impossible to contact the support team by email right now"
`R000`	`Fail`	The user / support email is not valid	"Impossible to contact the support team by email right now"
`R111`	`Success`	The operation was successful	"We've received your ticket. A representative will get back to you soon!"
`SC006`	`User no authorization`	The token is not valid for using the API services	"Access Denied. Try contacting the support team."
`SC014`	`Expired token`	The token has expired	"Access Denied. Try contacting the support team."
`VID101`	`Invalid input for email`	Email don't meet the email's format	"Please fill out this field" - "Please enter a valid email address (ex: email@homeescape.com)"
`VID105`	`Invalid input for phone_number`	Phone number doesn't have only numbers	"Phone must have only numbers"
`VID106`	`Invalid input for first_name`	First name is empty or don't have only letters	"Please fill out this field" - "First name must have only letters"
`VID107`	`Invalid input for last_name`	Last name is empty or don't have only letters	"Please fill out this field" - "Last name must have only letters
`VID112`	`Invalid input for property`	Property id is not a number	[Call the API again using a valid value for property id]
`VID150`	`Invalid input for message`	Message is empty or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please fill out this field" - "Please enter a valid message"
`VID260`	`Invalid input for subject`	Subject is empty or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please fill out this field" - "Please enter a valid subject"
`VID261`	`Invalid input for user_type`	User_type is not in [0, 1]	"Please select if you are a Traveler or a Homeowner"