jira.js
    Preparing search index...

    Function validateCustomerRequest

    • Validates a customer request payload without creating (persisting) a request.

      This endpoint runs exactly the same structural and semantic validations as Create customer request — including ProForma form validation — but performs no mutation: no issue is created and no side effects (attachments, comments, analytics) run.

      The response is intentionally verbose and structured so that it can be consumed by automated agents (for example an LLM repairing an invalid payload): every failure carries a machine-readable location (field id / form entity) and a human-readable reason. A valid payload returns HTTP 200 with valid: true; an invalid payload returns HTTP 400 with valid: false together with the field, form and general validation errors.

      Permissions required: Permission to create requests in the specified service desk.

      Parameters

      • client: Client
      • parameters: {
            channel?: string;
            form?: { answers?: Record<string, any>; [key: string]: unknown };
            isAdfRequest?: boolean;
            raiseOnBehalfOf?: string;
            requestFieldValues?: Record<string, any>;
            requestParticipants?: string[];
            requestTypeId?: string;
            serviceDeskId?: string;
        }
        • Optionalchannel?: string

          (Experimental) Shows extra information for the request channel.

        • Optionalform?: { answers?: Record<string, any>; [key: string]: unknown }
          • Optionalanswers?: Record<string, any>

            JSON mapping of form field answers containing form field IDs and corresponding values.

        • OptionalisAdfRequest?: boolean

          (Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF).

        • OptionalraiseOnBehalfOf?: string

          The accountId of the customer that the request is being raised on behalf of.

        • OptionalrequestFieldValues?: Record<string, any>

          JSON map of Jira field IDs and their values representing the content of the request.

        • OptionalrequestParticipants?: string[]

          List of customers to participate in the request, as a list of accountId values.

        • OptionalrequestTypeId?: string

          ID of the request type for the request.

        • OptionalserviceDeskId?: string

          ID of the service desk in which to create the request.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              errorMessage?: string;
              errorMessages?: string[];
              fieldErrors?: { field?: string; message?: string; [key: string]: unknown }[];
              formErrors?: {
                  code?: string;
                  context?: { id?: string; type?: string; [key: string]: unknown }[];
                  detail?: string;
                  status?: number;
                  title?: string;
                  [key: string]: unknown;
              }[];
              reasonKey?: string;
              valid?: boolean;
              [key: string]: unknown;
          },
      >