Introduction
The /entries/[ENTRY_ID]/notifications endpoint is used to send notifications for an entry.
Authentication
See REST API v2 Authentication.
The capability gravityforms_edit_entries is required to use POST requests at this endpoint.
This can be filtered using gform_rest_api_capability_post_entries_notifications.
Sending a Notification
The /entries/[ENTRY_ID]/notifications endpoint is used to send notifications for an entry.
Method
This endpoint accepts POST requests in order to send notifications.
Path
/gf/v2/entries/[ENTRY_ID]/notifications
Required Properties
There are no required properties.
Optional Properties
The request body can also include the following properties.
| Key | Type | Description |
|---|---|---|
| _notifications | string | Comma-separated list of notification IDs to be processed. |
| _event | string | The event to trigger. The default is form_submission. |
Response
Success
A successful response will contain an array of notification IDs for the notifications processed.
Failure
A failed response will provide a JSON string of the error code and message.
| Key | Type | Description |
|---|---|---|
| code | string | Error code.not_found |
| message | string | Human-readable error message. |
| data[status] | integer | HTTP response status code |
Usage Examples
cURL Request
curl --location --request POST 'https://rocket.test/wp-json/gf/v2/entries/159/notifications' \
--user 'ck_5f86565df60696c43af25f9194e106800770b8e9:cs_be0190310fefc061c564168670d0a96d68873c29'
Response
[
"64f23a145de7b",
"64f8e7b9abaea"
]