{"__v":1,"_id":"5434b3560ef9c00800165427","category":{"__v":30,"_id":"5434918d0ef9c008001651ff","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"],"project":"543469460ef9c00800164f0e","version":"54346a2a0ef9c00800164f28","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-08T01:21:17.804Z","from_sync":false,"order":1,"slug":"rest-api","title":"REST API"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"543469460ef9c00800164f0e","user":"543469060ef9c00800164f01","version":{"__v":7,"_id":"54346a2a0ef9c00800164f28","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","createdAt":"2014-10-07T22:33:14.982Z","releaseDate":"2014-10-07T22:33:14.982Z","categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-08T03:45:26.192Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"examples":{"codes":[]},"results":{"codes":[{"name":"Success","code":"{\n  \"success\": \"1\",\n  \"id\": \"1\"\n}","language":"json","status":200},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A notification email id was not supplied\"\n}","language":"json","status":400,"name":"Notification email ID not specified"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid notification email id was not supplied\"\n}","language":"json","status":404,"name":"Notification email not found"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid form could not be found\"\n}","language":"json","status":500,"name":"Form not found"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"Could not update the notification email: Error specific message\"\n}","language":"json","status":500,"name":"Error updating notification email"}]},"settings":"","try":false,"auth":"required","params":[{"_id":"5434b3560ef9c00800165433","ref":"","in":"path","required":true,"desc":"Notification ID","default":"","type":"int","name":"id"},{"_id":"5434b3560ef9c00800165432","ref":"","in":"body","required":false,"desc":"Name of the notification email","default":"","type":"string","name":"name"},{"_id":"5434b3560ef9c00800165431","ref":"","in":"body","required":true,"desc":"The type of from address (noreply, custom, field)","default":"","type":"string","name":"from_type"},{"_id":"5434b3560ef9c00800165430","ref":"","in":"body","required":true,"desc":"Custom email address or field id","default":"","type":"string","name":"from_value"},{"_id":"5434b3560ef9c0080016542f","ref":"","in":"body","required":true,"desc":"Email address to send notification to (split with return character \"\\n\")","default":"","type":"string","name":"recipients"},{"_id":"5434b3560ef9c0080016542e","ref":"","in":"body","required":true,"desc":"The subject of the email","default":"","type":"string","name":"subject"},{"_id":"5434b3560ef9c0080016542d","ref":"","in":"body","required":true,"desc":"What is included in the message (data, link, or fields)","default":"","type":"string","name":"type"},{"_id":"5434b3560ef9c0080016542c","ref":"","in":"body","required":false,"desc":"Flag to not include empty fields in the email","default":"0","type":"boolean","name":"hide_empty"},{"_id":"5434b3560ef9c0080016542b","ref":"","in":"body","required":false,"desc":"Flag to show section headings in email","default":"0","type":"boolean","name":"show_section"},{"_id":"5434b3560ef9c0080016542a","ref":"","in":"body","required":false,"desc":"The email message (if type = fields)","default":"","type":"string","name":"message"},{"_id":"5434b3560ef9c00800165429","ref":"","in":"body","required":false,"desc":"Only attach files if under this limit (in KBytes)","default":"","type":"int","name":"attach_limit"},{"_id":"5434b3560ef9c00800165428","ref":"","in":"body","required":false,"desc":"Whether the Notification Email should be Rich HTML or Plain Text (html, plain)","default":"","type":"string","name":"format"},{"_id":"582df56f48d4b10f00e7a7fa","ref":"","in":"body","required":false,"desc":"Field logic. See Field Logic section below.","default":"","type":"object","name":"logic"}],"url":"/v2/notification/:id.json"},"isReference":false,"order":45,"body":"Update the specified notification email\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT /api/v2/notification/12345.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 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\",\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.","excerpt":"Update the specified notification email","slug":"notification-id-put","type":"put","title":"/notification/:id"}

put/notification/:id

Update the specified notification email

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Notification 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, plain)
logic:
object
Field logic. See Field Logic section below.

Result Format


Documentation

Update the specified notification email [block:code] { "codes": [ { "code": "PUT /api/v2/notification/12345.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 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", "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

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