forms.md

pardot-client - Forms

API References

• https://developer.salesforce.com/docs/marketing/pardot/guide/object-field-reference.html#form
• https://developer.salesforce.com/docs/marketing/pardot/guide/forms-v3.html
• https://developer.salesforce.com/docs/marketing/pardot/guide/forms-v4.html

Version Note

Behaves the same in APIv3 and APIv4.

Object Types

interface Form {
  id: number;
  name: string;
  campaign: {
    id: number;
    name: string;
  };
  embedCode: string;
  created_at: string;
  updated_at: string;
}

Methods

query

Retrieve a list of forms according to the parameters.

const queryResponse = await pardot.forms.query(params);

Parameters

• params: FormQueryParams (optional)

interface FormQueryParams {
  id_greater_than?: number;
  id_less_than?: number;
  created_after?: DateString;
  created_before?: DateString;
  updated_after?: DateString;
  updated_before?: DateString;
  limit?: number;
  offset?: number;
  sort_order?: 'ascending' | 'descending';
  sort_by?: 'created_at' | 'id' | 'updated_at';
}

Return

A query response containing zero, one, or more forms.

interface FormQueryResponse {
  result: {
    total_results: number;
    form?: Form | Form[];
  };
}

---

read

Retrieve a form by its id.

const formResponse = await pardotClient.forms.read(id);

Parameters

• id: Form id (required)

Return

A response containing a form.

interface FormResponse {
  form: Form;
}