/notification/:id

put

https://www.formstack.com/api/v2/notification/{id}.json

Update the specified notification email

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Update the specified notification email

PUT /api/v2/notification/12345.json HTTP/1.1
Host: www.formstack.com
Authorization: Bearer [[app:oauth_token]]
Accept: application/json
Content-Type: application/json

from_type=field&from_value=12345&recipients=user%40example.com&subject=Example&type=link

curl -X PUT -i -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer [[app:oauth_token]]" -d "from_type=field&from_value=12345&recipients=user%40example.com&subject=Example&type=link" https://www.formstack.com/api/v2/notification/12345.json

Field Logic

See Field Logic for more information about the logic property.

Path Params

int32

required

Notification ID

Body Params

name

string

Name of the notification email

from_type

string

required

The type of from address (noreply, custom, field)

from_value

string

required

Custom email address or field id

recipients

string

required

Email address to send notification to (split with return character "\n")

subject

string

required

The subject of the email

type

string

required

What is included in the message (data, link, or fields)

hide_empty

boolean

Defaults to false

Flag to not include empty fields in the email

show_section

boolean

Defaults to false

Flag to show section headings in email

message

string

The email message (if type = fields)

attach_limit

int32

Only attach files if under this limit (in KBytes)

format

string

Whether the Notification Email should be Rich HTML or Plain Text (html, plain)

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Field Logic

200200

400400

404404

500500