Gravity Forms

App · 16 actions

Manage Gravity Forms forms and entries on your WordPress site, validate and submit form inputs, read results, and send entry notifications.

Actions

ActionWhat it does
Create entryCreate entry.
Create formCreate form.
Delete entryDelete entry.
Delete formDelete form.
Get entryGet entry.
Get formGet form.
Get form field filtersGet form field filters.
Get form resultsGet form results.
List entriesList entries.
List form entriesList form entries.
List formsList forms.
Send entry notificationsSend entry notifications.
Submit formSubmit form.
Update entryUpdate entry.
Update formUpdate form.
Validate submissionValidate submission.

Create entry

Create entry.

Inputs

Formform_idtextRequired
Select a form or use its ID.
Field valuesfield_valuesobjectRequired
Fill in the form fields. Values use Gravity Forms field IDs.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "1": "QA value",
    "form_id": "1",
    "id": "1"
  }
}

Create form

Create form.

Inputs

TitletitletextRequired
The title.
FieldsfieldslistRequired
Gravity Forms field definitions. Each needs an id, type and label.
Descriptiondescriptiontext
The description.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "fields": [
      {
        "id": 1,
        "label": "QA value",
        "type": "text"
      }
    ],
    "id": 1,
    "title": "QA form"
  }
}

Delete entry

Delete entry.

Inputs

Entry identry_idtextRequired
An entry ID returned by a previous step.
Forceforcenumber
0 moves to trash; 1 permanently deletes. Defaults to trash.One of: 0, 1.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": {
      "id": "qa-resource"
    }
  }
}

Delete form

Delete form.

Inputs

Formform_idtextRequired
Select a form or use its ID.
Forceforcenumber
0 moves to trash; 1 permanently deletes. Defaults to trash.One of: 0, 1.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": {
      "id": "qa-resource"
    }
  }
}

Get entry

Get entry.

Inputs

Entry identry_idtextRequired
An entry ID returned by a previous step.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "1": "QA value",
    "form_id": "1",
    "id": "1"
  }
}

Get form

Get form.

Inputs

Formform_idtextRequired
Select a form or use its ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "fields": [
      {
        "id": 1,
        "label": "QA value",
        "type": "text"
      }
    ],
    "id": 1,
    "title": "QA form"
  }
}

Get form field filters

Get form field filters.

Inputs

Formform_idtextRequired
Select a form or use its ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": {
      "id": "qa-resource"
    }
  }
}

Get form results

Get form results.

Inputs

Formform_idtextRequired
Select a form or use its ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": {
      "id": "qa-resource"
    }
  }
}

List entries

List entries.

Inputs

Searchsearchobject
Entry search options: status, start_date, end_date and field_filters.
Pagingpagingobject
Pagination: {"offset":0,"page_size":20}.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entries": [],
    "total_count": 0
  }
}

List form entries

List form entries.

Inputs

Formform_idtextRequired
Select a form or use its ID.
Searchsearchobject
Entry search options: status, start_date, end_date and field_filters.
Pagingpagingobject
Pagination: {"offset":0,"page_size":20}.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entries": [],
    "total_count": 0
  }
}

List forms

List forms.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "1": {
      "entries": "0",
      "id": "1",
      "title": "QA form"
    }
  }
}

Send entry notifications

Send entry notifications.

Inputs

Entry identry_idtextRequired
An entry ID returned by a previous step.
Notification idsnotification_idstext
Comma-separated notification IDs. Leave empty to process all configured notifications.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": {
      "id": "qa-resource"
    }
  }
}

Submit form

Submit form.

Inputs

Formform_idtextRequired
Select a form or use its ID.
Field valuesfield_valuesobjectRequired
Fill in the submitted form inputs. Submissions run notifications and add-on feeds.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "is_valid": true,
    "page_number": 0,
    "source_page_number": 1
  }
}

Update entry

Update entry.

Inputs

Entry identry_idtextRequired
An entry ID returned by a previous step.
Field valuesfield_valuesobjectRequired
Fill in the form fields. Values use Gravity Forms field IDs.
Statusstatustext
The status.One of: active, spam, trash.
Is readis_readnumber
The is read.One of: 0, 1.
Is starredis_starrednumber
The is starred.One of: 0, 1.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "1": "QA value",
    "form_id": "1",
    "id": "1"
  }
}

Update form

Update form.

Inputs

Formform_idtextRequired
Select a form or use its ID.
Titletitletext
The title.
Fieldsfieldslist
Gravity Forms field definitions. Each needs an id, type and label.
Descriptiondescriptiontext
The description.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "fields": [
      {
        "id": 1,
        "label": "QA value",
        "type": "text"
      }
    ],
    "id": 1,
    "title": "QA form"
  }
}

Validate submission

Validate submission.

Inputs

Formform_idtextRequired
Select a form or use its ID.
Field valuesfield_valuesobjectRequired
Fill in the submitted form inputs. Submissions run notifications and add-on feeds.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "is_valid": true,
    "page_number": 0,
    "source_page_number": 1
  }
}

On this page