Overwrite Customer

If you want to do a partial update without overwriting existing data or update the entire customer record (emails, phones, etc.) in one call, check out the new Update Customer endpoint.

This endpoint only updates the following fields (i.e. the Customer entity), to update additional customer information please see:

There are similar endpoints to delete or add customer data.

When a field is not set in the request, it’s the same as if it was set with null value and it will be overwritten.

Request

PUT /v2/customers/101 HTTP/1.1
Authorization: Bearer oauth_token
Content-Type: application/json

{
  "firstName" : "Vernon",
  "lastName" : "Bear",
  "photoUrl" : "https://api.helpscout.net/img/some-avatar.jpg",
  "photoType" : "twitter",
  "jobTitle" : "CEO and Co-Founder",
  "location" : "Greater Dallas/FT Worth Area",
  "background" : "I've worked with Vernon before and he's really great.",
  "age" : "30-35",
  "gender" : "Male",
  "organization" : "Acme, Inc"
}

Path Parameters

/v2/customers/{customerId}

Request fields

Path Type Required Description
firstName String N First name of the customer. When defined it must be between 1 and 40 characters.
lastName String N Last name of the customer. When defined it must be between 1 and 40 characters.
phone String N Optional phone number that will be used when creating a new customer
photoUrl String N URL of the customer’s photo. Max length 200 characters.
jobTitle String N Job title. Max length 60 characters.
photoType String N Type of photo. Accepted values are:
unknown
gravatar
twitter
facebook
googleprofile
googleplus
linkedin
instagram
background String N This is the Notes field from the user interface. Max length 200 characters.
location String N Location of the customer. Max length 60 characters.
organization String N Organization. Max length 60 characters.
gender String N Gender of this customer. Accepted values are:
male
female
unknown
age String N Customer’s age

Response

HTTP/1.1 204 No Content
↑Back to top
© Help Scout 2024