get_company_bulletin
The get_company_bulletin method retrieves the text of a specified company- level bulletin.
Note:
To get a list of all current bulletins, use the get_company method.
Syntax
{
<credentials object>,
"company": <company_name>,
"bulletin": <bulletin_name>,
"type": auto | manual
}
Request fields for get_company_bulletin
The following fields can be used in the get_company_bulletin method:
| Field name | Obligation | Definition/Value |
|---|---|---|
| bulletin | Required | The name of the bulletin you want to view. |
| company | Required | The name of the company. |
| type | Required | Specify the bulletin type. Allowed values are: auto — The bulletin is automatically sent to new users when their accounts are created. manual — The bulletin is sent only when the post_company_bulletin ADD LINK method is run. |
Response fields for get_company_bulletin
The following fields may be returned in response to the get_company_bulletin method:
| Field name | Obligation | Description/Value |
|---|---|---|
| bulletin_text | Returned if success = true | The text of the bulletin. |
| error | Returned if success = true | A text string that explains the error. |
| error_number | Returned if success = true | A number that represents the error. |
| success | Always returned | Indicates whether the request was successful or not. Allowed values are true and false. |
Examples for get_company_bulletin
Request
{
"credentials": {
"user": "[email protected]",
"password": "sw0rdfish"
},
"company": "Example Corp",
"bulletin": "Fridge",
"type": "auto"
}
Response
{
"success": true,
"bulletin_text": "From: Mister Manager <[email protected]>
Subject: Please empty the fridge!
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Dear {'title'} {'name'},
Please empty *all* your items from the kitchen refrigerator *every* Friday. I cannot stress how much of a priority this is.
M. Manager " }
Updated less than a minute ago