Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Update Customer Attributes

Updates customer attributes.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.customer.write|org.permission.customer.update|

Note

This endpoint is subject to "Object Rate Limiting", meaning that a single user is limited in how many updates they can make to a single Customer. Please see the API Rate Limiting section of the documentation for additional details.

Company

If you omit the company, the customer will no longer be linked to it.

Custom Attributes

Custom attributes are optional and allow you to specify custom key value pairs. They follow a convention which allows us to specify the field data type with a name suffix:

Suffix
  • Num or null
  • At or null
  • Str or null, length: [ 0 .. 1024 ] characters
  • Txt or null, length: [ 0 .. 1024 ] characters
  • Bool or null
  • Url or null, format:

Input

type: object properties: parameters: type: object properties: id: type: string description: (Required) Unique ID of the customer. required: - id title: Parameters data: type: string example: >- "{\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"externalId\": \"<string>\",\n \"username\": \"<string>\",\n \"signedUpAt\": \"<dateTime>\",\n \"lastActivityAt\": \"<dateTime>\",\n \"lastCustomerActivityAt\": \"<dateTime>\",\n \"lastSeenAt\": \"<dateTime>\",\n \"avatarUrl\": \"<uri>\",\n \"externalIds\": [\n {\n \"externalId\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedExternalIds\": [\n {\n \"externalId\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"<email-relaxed>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedEmails\": [\n {\n \"email\": \"<email-relaxed>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"<phone-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedPhones\": [\n {\n \"phone\": \"<phone-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"whatsapps\": [\n {\n \"phone\": \"<whatsapp-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"facebookIds\": [\n {\n \"pageId\": \"<string>\",\n \"userId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"instagramIds\": [\n {\n \"pageId\": \"<string>\",\n \"threadId\": \"<string>\",\n \"username\": \"<string>\",\n \"instagramId\": \"<string>\"\n }\n ],\n \"socials\": [\n {\n \"type\": \"<string>\",\n \"username\": \"<string>\",\n \"userid\": \"<string>\",\n \"url\": \"<uri>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedSocials\": [\n {\n \"type\": \"<string>\",\n \"username\": \"<string>\",\n \"userid\": \"<string>\",\n \"url\": \"<uri>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"<url>\",\n \"type\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"latitude\": \"<number>\",\n \"longitude\": \"<number>\",\n \"countryCode\": \"<string>\",\n \"countryName\": \"<string>\",\n \"regionCode\": \"<string>\",\n \"regionName\": \"<string>\",\n \"cityName\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"areaCode\": \"<string>\"\n }\n ],\n \"locale\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"sentiment\": {\n \"polarity\": \"<number>\",\n \"confidence\": \"<number>\"\n },\n \"custom\": \"<object>\",\n \"birthdayAt\": \"<dateTime>\",\n \"gender\": \"<string>\",\n \"createdAt\": \"<dateTime>\",\n \"importedAt\": \"<dateTime>\",\n \"rev\": \"<number>\",\n \"defaultLang\": \"<string>\"\n}" title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string displayName: type: string displayColor: type: string displayIcon: type: string externalId: type: string externalIds: type: array items: type: object properties: externalId: type: string verified: type: string id: type: string sharedExternalIds: type: string signedUpAt: type: string avatarUrl: type: string username: type: string emails: type: array items: type: object properties: type: type: string email: type: string sharedEmails: type: string phones: type: array items: type: object properties: type: type: string phone: type: string sharedPhones: type: string socials: type: array items: type: object properties: type: type: string userid: type: string username: type: string url: type: string sharedSocials: type: string urls: type: array items: type: object properties: url: type: string locations: type: array items: type: object properties: type: type: string address: type: string activeUsers: type: string watchers: type: string recentLocation: type: object properties: updatedAt: type: string locale: type: string gender: type: string tags: type: array items: type: string timeZone: type: string birthdayAt: type: string presence: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string lastSeenAt: type: string lastActivityAt: type: string lastCustomerActivityAt: type: string lastMessageIn: type: object properties: sentAt: type: string sentiment: type: string lastConversation: type: object properties: id: type: string sentiment: type: object properties: confidence: type: string polarity: type: string tags: type: string defaultLang: type: string conversationCounts: type: object properties: all: type: string snoozed: type: string open: type: string done: type: string preview: type: object properties: previewAt: type: string type: type: string text: type: string subject: type: string sentiment: type: object properties: polarity: type: string confidence: type: string progressiveStatus: type: string verified: type: string rev: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string messages: type: object properties: links: type: object properties: self: type: string modifiedBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string