PATCH/desk/api/v2/customers/update.json
Update multiple customers.
Update all the given properties for matching resources. Any omitted properties will be unchanged.
The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- firstName
- lastName
- organization
- verifiedEmail
- permission
- addMethod
- linkedinURL
- facebookURL
- twitterHandle
- jobTitle
- phone
- mobile
- address
- externalId
- avatarURL
- trusted
- welcomeEmailSent
- password
- createdAt
- updatedAt
- deletedAt
- createdBy
- updatedBy
- state
Body Params
Customer represents a Customer.
- Name
addMethod
- Type
- string
- Description
- Specifies whether the customer was added to a company via domain matching (automatic) or by an agent manually. (read-only)
- Name
address
- Type
- string
- Description
- Customer address
- Name
avatarURL
- Type
- string
- Description
- Customer avatar URL
- Name
company
- Type
- object
- Name
contacts
- Type
- array
- Description
- RelContacts is a list of the customer's contacts relationships
- Name
createdAt
- Type
- string
- Description
- CreatedAt is a read-only date marking the creation time.
- Name
createdBy
- Type
- object
- Name
customerwelcomeemails
- Type
- array
- Description
- RelWelcomeEmails is a historicaal record of welcome emails sent to the customer
- Name
deletedAt
- Type
- string
- Description
- DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
- Name
deletedBy
- Type
- object
- Name
email
- Type
- string
- Description
- The email address of the customer. Email ticket replies and chat transcriptions will be sent to the customer at this address.
- Name
externalId
- Type
- string
- Description
- Customer external ID
- Name
extraData
- Type
- string
- Description
- Provides a free-form reference field for additional customer information.
- Name
facebookURL
- Type
- string
- Description
- The Facebook URL address of the customer.
- Name
filter_args
- Type
- object
- Description
- RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
- Name
firstName
- Type
- string
- Description
- An optional field to store the first name of the customer.
- Name
id
- Type
- integer
- Name
jobTitle
- Type
- string
- Description
- Customer job title
- Name
lastName
- Type
- string
- Description
- An optional field to store the last name of the customer.
- Name
linkedinURL
- Type
- string
- Description
- The Linkedin URL address of the customer.
- Name
mobile
- Type
- string
- Description
- Customer mobile
- Name
notes
- Type
- string
- Description
- Provides a free-form reference field for additional customer information.
- Name
numTickets
- Type
- integer
- Description
- Number of customer tickets
- Name
organization
- Type
- string
- Description
- Organization is the name of the organization that the customer is in. This feature has been deprecated in favor of "companies".
- Name
password
- Type
- dictionary[string, object]
- Description
- password can either hold plain-text passwords or encrypted ones. There's two main assumptions being made: - Unmarshalled passwords are plain-text, the value is not exported and can not be manually handled. - Scanned passwords are encrypted
- Name
permission
- Type
- string
- Description
- Overrides the company ticket permission settings (own or all). Is only valid for customers that belong to a company.
- Name
phone
- Type
- string
- Description
- Customer phone
- Name
pmperson
- Type
- object
- Name
state
- Type
- string
- Description
- State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
- Name
trusted
- Type
- boolean
- Description
- Trusted customers images are displayed automatically
- Name
twitterHandle
- Type
- string
- Description
- The Twitter Handle of the customer.
- Name
updatedAt
- Type
- string
- Description
- UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
- Name
updatedBy
- Type
- object
- Name
verifiedEmail
- Type
- boolean
- Description
- Specifies whether the customer has verified their email address (read-only)
- Name
welcomeEmailSent
- Type
- boolean
- Description
- Whether the customer portal welcome email was sent to this customer. If the portal is enabled and the customer was sent the email it can be resent via the resend api.
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
BulkOpResponse is a bulk operation response
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
200 OK
BulkOpResponse
{
"jobId": "string"
}