kustomer-client
    Preparing search index...

    Function deleteScheduleById

    • Delete a business schedule by ID Deletes a business schedule based on the schedule ID.

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

      Legacy Role Equivalent Permission Set Role
      org.admin.schedule.write org.permission.schedule.delete

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      createdAt: string;
                      default: boolean;
                      deleted: boolean;
                      deletedAt: string;
                      hours: {
                          "0": null
                          | string;
                          "1": number[][];
                          "2": number[][];
                          "3": number[][];
                          "4": number[][];
                          "5": number[][];
                          "6": null | string;
                      };
                      modifiedAt: string;
                      name: string;
                      timezone: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      createdBy: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      deletedBy: {
                          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