Clients Update API

Route

PUT

Purpose


Parameters


token string 1 required
Authentication token for either an application or session.
view string 1
View of object your would like to be returned.
Possible values
  • default
  • client_read
  • planox_client_read_profile
  • planox_client_read_tours
  • planox_client_read_branding
  • planox_client_read_preferences
  • contract_type_view

id integer 3 required
id of record that is being updated.
session_view string 100
View of session object you would like returned.
application_view string 110
View of application object you would like returned.
first_name string 400
First name of client.
last_name string 500
Last name of client.
email string 600
Email of client.
phone string 700
Phone of client.
password string 800
Password of client.
active boolean 900
Active status of client
assistant_first_name string 1000
Assistant first name that can be referenced by PlanOmatic
assistant_last_name string 1100
Assistant last name that can be referenced by PlanOmatic
assistant_phone string 1200
Assistant phone number that can be referenced by PlanOmatic
assistant_emails string 1300
Comma separated list of emails that will be CC'd on order emails.
additional_emails string 1400
Comma separated list of emails that will be CC'd on order completion emails.
employee_notes string 1500
Internal notes about the client for PlanOmatic's reference.
realtor_license string 1600
Realtor license number.
bio text 1700
Realtor bio to be shown in certain marketing materials.
display_name string 1800
If the client wishes to override there user name on branding materials such as tours and brocures, they can use this field.
use_display_name boolean 1900
Boolean that controls whether the display_name is show on branding material instead of the user's name.
display_email string 2000
If the client wishes to override there email on branding materials such as tours and brocures, they can use this field.
use_display_email boolean 2100
Boolean that controls whether the display_email is show on branding material instead of the user's name.
display_phone string 2200
If the client wishes to override there phone on branding materials such as tours and brocures, they can use this field.
use_display_phone boolean 2300
Boolean that controls whether the display_phone is show on branding material instead of the user's name.
branding_name string 2400
If a client wishes to override their company's branding name, they can do it with this field.
branding_website string 2500
If a client wishes to override their company's branding website, they can do it with this field.
branding_notes string 2600
If a client wishes to override their company's branding notes, they can do it with this field.
branding_phone string 2700
If a client wishes to override their company's branding phone, they can do it with this field.
branding_address string 2800
If a client wishes to override their company's branding street address, they can do it with this field.
branding_address2 string 2900
If a client wishes to override their company's branding street2 address, they can do it with this field.
branding_city string 3000
If a client wishes to override their company's branding city, they can do it with this field.
branding_province_iso string 3100
If a client wishes to override their company's branding province, they can do it with this field.
branding_postal_code string 3200
If a client wishes to override their company's branding postal_code, they can do it with this field.
use_parent_branding boolean 3300
If a client wishes to override toggle between their company's branding and their custom company branding, they can do it with this feild.

Request Body Example: application/json

Responses

action-successful 200

This status indicates that the request was successful. If the request returns data, it can be found in the data key.

invalid-token 401

This status is returned when the authentication token passed is invalid.

session-expired 401

This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.

client-required 401

This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.

missing-param 400

This status is returned when a required param was not passed with the request.

invalid-param 400

This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.

application-crash 500

This status is returned when there is an internal server error. Please try again later.

mandrill-email-failed 500

This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.

invalid-content-type 400

This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.

route-non-existent 500

Response returned when HTTP route does not exist.

Uncommon Responses

The responses below are not very common.

no-params-decoded Uncommon

This status is returned the request body was decoded, but no params where found.

invalid-encoded-params Uncommon

This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.

route-not-found Uncommon

This status is returned when the route record being requested hasn't been deployed yet.

identify-request-error Uncommon

This status is returned when there is an internal server error before the route could be identified. Please try again later.

service-not-found Uncommon

This status is returned when the route's API service record being requested hasn't been deployed yet.