{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/form/:id/notification.json","auth":"required","basic_auth":false,"examples":{"codes":[]},"method":"post","try":false,"params":[{"name":"id","type":"int","default":"","desc":"Form ID","required":true,"in":"path","ref":"","_id":"5434b1ee0ef9c00800165412"},{"name":"name","type":"string","default":"","desc":"Name of the notification email","required":false,"in":"body","ref":"","_id":"5434b1ee0ef9c00800165411"},{"name":"from_type","type":"string","default":"","desc":"The type of from address (noreply, custom, field)","required":true,"in":"body","ref":"","_id":"5434b1ee0ef9c00800165410"},{"name":"from_value","type":"string","default":"","desc":"Custom email address or field id","required":true,"in":"body","ref":"","_id":"5434b1ee0ef9c0080016540f"},{"name":"recipients","type":"string","default":"","desc":"Email address to send notification to (split with return character \"\\n\")","required":true,"in":"body","ref":"","_id":"5434b1ee0ef9c0080016540e"},{"name":"subject","type":"string","default":"","desc":"The subject of the email","required":true,"in":"body","ref":"","_id":"5434b1ee0ef9c0080016540d"},{"name":"type","type":"string","default":"","desc":"What is included in the message (data, link, or fields)","required":true,"in":"body","ref":"","_id":"5434b1ee0ef9c0080016540c"},{"name":"hide_empty","type":"boolean","default":"0","desc":"Flag to not include empty fields in the email","required":false,"in":"body","ref":"","_id":"5434b1ee0ef9c0080016540b"},{"name":"show_section","type":"boolean","default":"0","desc":"Flag to show section headings in email","required":false,"in":"body","ref":"","_id":"5434b1ee0ef9c0080016540a"},{"name":"message","type":"string","default":"","desc":"The email message (if type = fields)","required":false,"in":"body","ref":"","_id":"5434b1ee0ef9c00800165409"},{"name":"attach_limit","type":"int","default":"","desc":"Only attach files if under this limit (in KBytes)","required":false,"in":"body","ref":"","_id":"5434b1ee0ef9c00800165408"},{"name":"format","type":"string","default":"","desc":"Whether the Notification Email should be Rich HTML or Plain Text (html, plaintext)","required":false,"in":"body","ref":"","_id":"5434b1ee0ef9c00800165407"},{"name":"logic","type":"object","default":"","desc":"Field logic. See Field Logic section below.","required":false,"in":"body","ref":"","_id":"582df53ee046d30f00d6b4b7"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"id\" : \"12345\"\n}","name":"Success"},{"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"A form id was not supplied\"\n}","name":"Form ID not specified","status":400},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid form id was not supplied\"\n}","name":"Form not found","status":404,"language":"json"},{"status":403,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"The action was forbidden by form permissions\"\n}","name":"Forbidden action"},{"name":"Error creating notification email","status":500,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"Could not create the notification email: Error specific message\"\n}"}]},"settings":"5e2b1ec0f26a2c00510363e5"},"next":{"description":"","pages":[]},"title":"/form/:id/notification","type":"endpoint","slug":"form-id-notification-post","excerpt":"Add a new notification email to the specified form","body":"Add a new notification email to the specified form\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /api/v2/form/12345/notification.json HTTP/1.1\\nHost: www.formstack.com\\nAuthorization: Bearer [[app:oauth_token]]\\nAccept: application/json\\nContent-Type: application/json\\n\\nfrom_type=field&from_value=12345&recipients=user%40example.com&subject=Example&type=link\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -X POST -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/form/12345/notification.json\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Field Logic\"\n}\n[/block]\nSee [Field Logic](doc:field-logic) for more information about the `logic` property.","updates":[],"order":47,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5434b1ee0ef9c00800165406","parentDoc":null,"user":"543469060ef9c00800164f01","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"_id":"54346a2a0ef9c00800164f28","releaseDate":"2014-10-07T22:33:14.982Z","createdAt":"2014-10-07T22:33:14.982Z","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8},"__v":2,"createdAt":"2014-10-08T03:39:26.662Z","editedParams":true,"editedParams2":true,"githubsync":"","project":"543469460ef9c00800164f0e","category":{"sync":{"isSync":false,"url":""},"pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"title":"REST API","slug":"rest-api","order":1,"from_sync":false,"reference":false,"_id":"5434918d0ef9c008001651ff","version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","createdAt":"2014-10-08T01:21:17.804Z"},"is_link":false}

post/form/:id/notification

Add a new notification email to the specified form

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Form ID

Body Params

name:
string
Name of the notification email
from_type:
required
string
The type of from address (noreply, custom, field)
from_value:
required
string
Custom email address or field id
recipients:
required
string
Email address to send notification to (split with return character "\n")
subject:
required
string
The subject of the email
type:
required
string
What is included in the message (data, link, or fields)
hide_empty:
boolean0
Flag to not include empty fields in the email
show_section:
boolean0
Flag to show section headings in email
message:
string
The email message (if type = fields)
attach_limit:
integer
Only attach files if under this limit (in KBytes)
format:
string
Whether the Notification Email should be Rich HTML or Plain Text (html, plaintext)
logic:
object
Field logic. See Field Logic section below.

Result Format


Documentation

Add a new notification email to the specified form [block:code] { "codes": [ { "code": "POST /api/v2/form/12345/notification.json HTTP/1.1\nHost: www.formstack.com\nAuthorization: Bearer [[app:oauth_token]]\nAccept: application/json\nContent-Type: application/json\n\nfrom_type=field&from_value=12345&recipients=user%40example.com&subject=Example&type=link", "language": "http" }, { "code": "curl -X POST -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/form/12345/notification.json", "language": "shell" } ] } [/block] [block:api-header] { "type": "basic", "title": "Field Logic" } [/block] See [Field Logic](doc:field-logic) for more information about the `logic` property.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}