kustomer-client
    Preparing search index...

    Function getMessageByExternalId

    • Get a Message by External ID Retrieves a single message using its unique external message ID.

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

      Legacy Role Equivalent Permission Set Role
      org.user.message.read org.permission.message.read
      Key Value Description
      externalID string Unique external ID of the message.

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      app: string;
                      channel: string;
                      createdAt: string;
                      direction: string;
                      externalId: string;
                      meta: {
                          cc: unknown[];
                          from: string;
                          inReplyTo: string;
                          recipient: { email: string; mailboxHash: string };
                          subject: string;
                          to: { email: string }[];
                      };
                      modifiedAt: string;
                      preview: string;
                      sentAt: string;
                      sentiment: { confidence: number; polarity: number };
                      size: number;
                      status: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { related: string; self: string };
                  relationships: {
                      conversation: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      customer: {
                          data: { id: string; type: string };
                          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