Class FormsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo replace replaceWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new FormsApi(configuration, requestFactory?, responseProcessor?): FormsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: FormsApiRequestFactory
- OptionalresponseProcessor: FormsApiResponseProcessor
Returns FormsApi
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:15

Methods

archiveWithHttpInfo

archiveWithHttpInfo(formId, _options?): Promise<HttpInfo<void>>
Archive a form definition. New submissions will not be accepted and the form definition will be permanently deleted after 3 months. Archive a form definition
Parameters
- formId: string
  The ID of the form to archive.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:28

create

create(formDefinitionCreateRequestBase, _options?): Promise<FormDefinitionBase>
Add a new hubspot form Create a form
Parameters
- formDefinitionCreateRequestBase: FormDefinitionCreateRequestBase
- Optional_options: Configuration
Returns Promise<FormDefinitionBase>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:58

createWithHttpInfo

createWithHttpInfo(formDefinitionCreateRequestBase, _options?): Promise<HttpInfo<FormDefinitionBase>>
Add a new hubspot form Create a form
Parameters
- formDefinitionCreateRequestBase: FormDefinitionCreateRequestBase
- Optional_options: Configuration
Returns Promise<HttpInfo<FormDefinitionBase>>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:48

getById

getById(formId, archived?, _options?): Promise<FormDefinitionBase>
Returns a form based on the form ID provided. Get a form definition
Parameters
- formId: string
  The unique identifier of the form
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<FormDefinitionBase>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:80

getByIdWithHttpInfo

getByIdWithHttpInfo(formId, archived?, _options?): Promise<HttpInfo<FormDefinitionBase>>
Returns a form based on the form ID provided. Get a form definition
Parameters
- formId: string
  The unique identifier of the form
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<HttpInfo<FormDefinitionBase>>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:69

getPage

getPage(after?, limit?, archived?, formTypes?, _options?): Promise<CollectionResponseFormDefinitionBaseForwardPaging>
Returns a list of forms based on the search filters. By default, it returns the first 20 hubspot forms Get a list of forms
Parameters
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- OptionalformTypes: (
      | "hubspot"
      | "captured"
      | "flow"
      | "blog_comment"
      | "all")[]
  The form types to be included in the results.
- Optional_options: Configuration
Returns Promise<CollectionResponseFormDefinitionBaseForwardPaging>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:106

getPageWithHttpInfo

getPageWithHttpInfo(after?, limit?, archived?, formTypes?, _options?): Promise<HttpInfo<CollectionResponseFormDefinitionBaseForwardPaging>>
Returns a list of forms based on the search filters. By default, it returns the first 20 hubspot forms Get a list of forms
Parameters
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- OptionalformTypes: (
      | "hubspot"
      | "captured"
      | "flow"
      | "blog_comment"
      | "all")[]
  The form types to be included in the results.
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseFormDefinitionBaseForwardPaging>>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:93

replace

replace(formId, hubSpotFormDefinition, _options?): Promise<FormDefinitionBase>
Update all fields of a hubspot form definition. Update a form definition
Parameters
- formId: string
- hubSpotFormDefinition: HubSpotFormDefinition
- Optional_options: Configuration
Returns Promise<FormDefinitionBase>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:128

replaceWithHttpInfo

replaceWithHttpInfo(formId, hubSpotFormDefinition, _options?): Promise<HttpInfo<FormDefinitionBase>>
Update all fields of a hubspot form definition. Update a form definition
Parameters
- formId: string
- hubSpotFormDefinition: HubSpotFormDefinition
- Optional_options: Configuration
Returns Promise<HttpInfo<FormDefinitionBase>>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:117

update

update(formId, hubSpotFormDefinitionPatchRequest, _options?): Promise<FormDefinitionBase>
Update some of the form definition components Partially update a form definition
Parameters
- formId: string
  The ID of the form to update.
- hubSpotFormDefinitionPatchRequest: HubSpotFormDefinitionPatchRequest
- Optional_options: Configuration
Returns Promise<FormDefinitionBase>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:150

updateWithHttpInfo

updateWithHttpInfo(formId, hubSpotFormDefinitionPatchRequest, _options?): Promise<HttpInfo<FormDefinitionBase>>
Update some of the form definition components Partially update a form definition
Parameters
- formId: string
  The ID of the form to update.
- hubSpotFormDefinitionPatchRequest: HubSpotFormDefinitionPatchRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<FormDefinitionBase>>
- Defined in codegen/marketing/forms/types/PromiseAPI.ts:139

Class FormsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FormsApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<FormDefinitionBase>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<FormDefinitionBase>>

getById

Parameters

Returns Promise<FormDefinitionBase>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<FormDefinitionBase>>

getPage

Parameters

Returns Promise<CollectionResponseFormDefinitionBaseForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseFormDefinitionBaseForwardPaging>>

replace

Parameters

Returns Promise<FormDefinitionBase>

replaceWithHttpInfo

Parameters

Returns Promise<HttpInfo<FormDefinitionBase>>

update

Parameters

Returns Promise<FormDefinitionBase>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<FormDefinitionBase>>

Settings

On This Page