Skip to content

Update a Client's customer score

POST
/api/partners/v1/company/{company_id}/customer-score/

The client must belong to the company, and is being matched using email and/or phone. The fields that can be updated are customer_score_name, customer_score_value, customer_score_maximum, customer_score_submitted_at

company_id
required
integer

The company id.

Example
12345
object
score_name
string
Customer Satisfaction
score_value
integer
maximum_score
integer
submitted_at
string
2022-06-05T00:34:00
email
string
test@example.com
phone
string
567-567-5678

Success

object
id

The id of the matched client

integer
customer_score_name

The updated score name

string
customer_score_value

The updated score value

integer
customer_score_maximum

The updated maximum value

integer
customer_score_submitted_at

The updated submitted at date

string

We were unable to authenticate your request with the provided API key.

object
error_type
string
CommunityNotFound
message
string
Could not find community with corresponding ID.

A client could not be matched using the provided email and/or phone.

object
error_type
string
RenterNotFound
message
string
Unable to match renter using phone or email.