Custom Form API Guide

Custom Form API

Info
We have created a public API collection for Custom Form module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public collections can be found in the following FAQ post.
1. Amasty\Customform\Api\AnswerRepositoryInterface - class for managing form answers:
  1. POST /V1/amasty_customform/answer, method="save" - create an answer;
  2. PUT /V1/amasty_customform/answer/:answerId, method="save" - edit an answer;
  3. DELETE /V1/amasty_customform/answer/:answerId, method="deleteById" - delete an answer;
  4. GET /V1/amasty_customform/answer, method="get" - get information about an answer;
  5. GET /V1/amasty_customform/answer/all, method="getList" - get a list with all answers;
  6. GET /V1/amasty_customform/answer/list_filter, method="getListFilter" - get a list with filtered answers.

2. Amasty\Customform\Api\FormRepositoryInterface - class for managing forms:
  1. POST /V1/amasty_customform/form, method="save" - create a form;
  2. PUT /V1/amasty_customform/form/:formId, method="save" - edit a form;
  3. DELETE /V1/amasty_customform/form/:formId, method="deleteById" -delete a form;
  4. GET /V1/amasty_customform/form, method="get" - get information about a form;
  5. GET /V1/amasty_customform/form/all, method="getList" - get a list with all forms.

      • Related Articles

      • What Amasty extensions support API?

        Each Amasty extension that has API support, includes the etc/webapi.xml file. The webapi.xml file contains API configurations with the list of available API requests. For example, a request from the Custom Form module interface: 1 - endpoint URL; 2 - ...

      • Can I test how your modules work with API?

        Our team have created a public Postman workspace where we provide access to API collections from our modules. You can copy these API collections to test them in your own Magento installation together with our modules, and some collections can be ...

      • Custom Form | GraphQL methods

        Queries customform (formId: Int) description: get information about custom form by ID Mutations amCustomFormSubmit (input: AmFormSubmitInput) description: submit form

      • Custom Stock Status API

        We have created a public API collection for Custom Stock Status module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public ...

      • Request a Quote API

        We have created a public API collection for Request a Quote with sample queries and data, you can copy it to run local tests in your Magento environment. More details about using public collections can be found in the following FAQ post. 1. ...