kustomer-client
    Preparing search index...

    Function getaDraftForwardById

    • Get draft forward by ID Retrieves a draft forward based on the unique forward ID.

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

      Legacy Role Equivalent Permission Set Role
      org.user.draft.read org.permission.draft.read

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      app: string;
                      body: string;
                      channel: string;
                      createdAt: string;
                      from: { email: string; name: string };
                      modifiedAt: string;
                      status: string;
                      to: { email: string; name: string }[];
                      updatedAt: string;
                  };
                  id: string;
                  relationships: {
                      attachments?: {
                          data: { id: string; type: string };
                          links: { self: string };
                      }[];
                      createdBy: {
                          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