kustomer-client
    Preparing search index...

    Function updateCustomerAttributes

    • 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

      This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single customer. To learn more, see Rate limiting.

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

      Custom attributes are optional and allow you to specify custom key-value pairs.

      Kustomer uses a naming convention for custom attributes to specify the field data type with a name suffix:

      • Num number or null
      • At date-time or null
      • Str string or null, length: [ 0 .. 1024 ] characters
      • Txt string or null, length: [ 0 .. 1024 ] characters
      • Bool boolean or null
      • Url string or null, format: uri

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      activeUsers: unknown[];
                      avatarUrl: null
                      | string;
                      birthdayAt: null | string;
                      conversationCounts: {
                          all: number;
                          done: number;
                          open: number;
                          snoozed: number;
                      };
                      createdAt: string;
                      defaultLang: string;
                      displayColor: string;
                      displayIcon: string;
                      displayName: string;
                      emails: { email: string; type: string }[];
                      externalId: string;
                      externalIds: {
                          externalId: string;
                          id: null | string;
                          verified: boolean;
                      }[];
                      gender: string;
                      lastActivityAt: string;
                      lastConversation: {
                          id: string;
                          sentiment: { confidence: number; polarity: number };
                          tags: unknown[];
                      };
                      lastCustomerActivityAt: string;
                      lastMessageIn: { sentAt: string; sentiment: null
                      | string };
                      lastSeenAt: string;
                      locale: string;
                      locations: { address: string; type: string }[];
                      modifiedAt: string;
                      name: string;
                      phones: { phone: string; type: string }[];
                      presence: string;
                      preview: {
                          previewAt: string;
                          subject: string;
                          text: string;
                          type: string;
                      };
                      progressiveStatus: string;
                      recentLocation: { updatedAt: string };
                      rev: number;
                      sentiment: { confidence: number; polarity: number };
                      sharedEmails: unknown[];
                      sharedExternalIds: unknown[];
                      sharedPhones: unknown[];
                      sharedSocials: unknown[];
                      signedUpAt: null | string;
                      socials: { type: string; url: string; userid: string; username: string }[];
                      tags: string[];
                      timeZone: null | string;
                      updatedAt: string;
                      urls: { url: string }[];
                      username: null | string;
                      verified: boolean;
                      watchers: unknown[];
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      messages: { links: { self: string } };
                      modifiedBy: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility

    On This Page

    NoteCompanyCustom Attributes