{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/rest/alert","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST \"[host]/rest/alert\" -b cookies.txt -d '{\"subject\":\"new alert\",\"content\":\"Hey boys and girls here is an alert\",\"global\":1,\"from_address\":\"your boss\"}'"}]},"method":"post","params":[{"name":"user_id","type":"int","default":"","desc":"ID of the user receiving the alert, must be an active user","required":false,"in":"body","ref":"","_id":"56c7bcc55652c217008e0924"},{"name":"account_id","type":"int","default":"The account_id of the user sending the alert","desc":"When a super user sends a `global` alert the `account_id` can be specified or can be set to `all` to send the alert to all users in all accounts.","required":false,"in":"body","ref":"","_id":"56c7bed3606ee717003c4768"},{"name":"subject","type":"string","default":"","desc":"Subject of the alert, <100 chars","required":true,"in":"body","ref":"","_id":"56c7c003fb16d017002a7a16"},{"name":"content","type":"string","default":"","desc":"Content of the alert","required":true,"in":"body","ref":"","_id":"56c7c037af5bc40d00d6bba0"},{"name":"object_type","type":"string","default":"","desc":"If the alert refers to an object, such as a Creative, you can specify the type and ID (below) to allow for deep linking into an application. Must be a valid object_type. A list of object_types can be found using the `\"view_name\":\"object_type\"`","required":false,"in":"body","ref":"","_id":"56cf570144c5700b0095c1ac"},{"name":"object_id","type":"int","default":"","desc":"The object_id to link to if the object_type is specified.","required":false,"in":"body","ref":"","_id":"56cf570144c5700b0095c1ab"},{"name":"global","type":"boolean","default":"false","desc":"When set, sends the alert to all users within the account","required":false,"in":"body","ref":"","_id":"56cf6cd68629f91300fd97e7"},{"name":"icon","type":"string","default":"","desc":"A string representing an icon or emoji to associate with the alert. e.g. `:POOP:` will show :POOP:","required":false,"in":"body","ref":"","_id":"56cf6cd68629f91300fd97e6"},{"name":"from_address","type":"string","default":"","desc":"Sender of the alert. Can be a name or an email address.","required":true,"in":"body","ref":"","_id":"56cf6cd68629f91300fd97e5"},{"name":"active","type":"boolean","default":"true","desc":"Is the alert unread (1) or read (0)","required":false,"in":"body","ref":"","_id":"56cf6cd68629f91300fd97e4"}],"results":{"codes":[{"name":"","code":"{\n    \"success\": true,\n    \"message\": \"Global alerts sent successfully to 2 users with 0 errors\"\n}","language":"json","status":200},{"name":"","code":"{\n    \"success\": false,\n    \"message\": \"advertiser could not be created\",\n    \"errors\": [\n        \"ERROR: Advertiser name already in use\"\n    ]\n}","language":"json","status":406}]},"settings":""},"next":{"description":"","pages":[]},"title":"alert","type":"endpoint","slug":"alert","excerpt":"","body":"","updates":[],"order":21,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56cf6cd68629f91300fd97e3","version":{"version":"0.5","version_clean":"0.5.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"_id":"56c35c56c0c4630d004e864f","createdAt":"2016-02-16T17:28:54.864Z","project":"56c35c56c0c4630d004e864c","releaseDate":"2016-02-16T17:28:54.864Z","__v":8},"editedParams2":true,"githubsync":"","parentDoc":null,"user":"56c39c05bc41330d009f25d7","category":{"sync":{"isSync":false,"url":""},"pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"title":"Buzz API Reference","slug":"buzz-api-reference","order":1,"from_sync":false,"reference":true,"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","createdAt":"2016-02-25T17:53:10.154Z"},"editedParams":true,"project":"56c35c56c0c4630d004e864c","__v":0,"createdAt":"2016-02-25T21:06:30.234Z"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

user_id:
integer
ID of the user receiving the alert, must be an active user
account_id:
integerThe account_id of the user sending the alert
When a super user sends a `global` alert the `account_id` can be specified or can be set to `all` to send the alert to all users in all accounts.
subject:
required
string
Subject of the alert, <100 chars
content:
required
string
Content of the alert
object_type:
string
If the alert refers to an object, such as a Creative, you can specify the type and ID (below) to allow for deep linking into an application. Must be a valid object_type. A list of object_types can be found using the `"view_name":"object_type"`
object_id:
integer
The object_id to link to if the object_type is specified.
global:
booleanfalse
When set, sends the alert to all users within the account
icon:
string
A string representing an icon or emoji to associate with the alert. e.g. `:POOP:` will show :POOP:
from_address:
required
string
Sender of the alert. Can be a name or an email address.
active:
booleantrue
Is the alert unread (1) or read (0)

Examples


Result Format