kustomer-client
    Preparing search index...

    Function getCustomAttributeMetadata

    • Get custom attribute metadata Retrieves the metadata properties for the custom attributes of a specific resource (for example, Company, Conversation, Customer, Message, and KObject (custom Object)).

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

      Legacy Role Equivalent Permission Set Role
      org.user.metadata.read org.permission.metadata.read
      org.admin.metadata.read

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      properties: {
                          myCustomStr: {
                              displayName: string;
                              enumeration: string[];
                              modifiedAt: string;
                              modifiedBy: string;
                              type: string;
                              updatedAt: string;
                          };
                          ordersId: {
                              displayName: string;
                              modifiedAt: string;
                              modifiedBy: string;
                              multi: boolean;
                              target: string;
                              type: string;
                              updatedAt: string;
                          };
                          shopifyCustomerIdNum: { displayName: string; type: string };
                      };
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility