The get_domain_bulletin method returns the text of a specified bulletin.


  <credentials object>, 
  "domain": <domain name>, 
  "bulletin": <bulletin name>, 
  "type": auto | manual

Request fields for get_domain_bulletin

The following fields can be used in the get_domain_bulletin method:

Field nameObligationDefinition/Value
bulletinRequiredThe name of the bulletin you want to view.
domainRequiredThe name of the domain the bulletin is in.
typeRequiredThe type of bulletin.

Allowed values are:

auto — Bulletin is automatically sent to newly created users

manual — Bulletins are only sent via the post_domain_bulletin method.

Response fields for get_domain_bulletin

The following fields may be returned in response to the get_domain_bulletin method:

Field nameObligationDescription/Value
bulletin_textReturned if success = trueThe text of the bulletin, including headers.
errorReturned if success = falseA text string that explains the error.
error_numberReturned if success = falseA number that represents the error.
successAlways returnedIndicates whether the request was successful or not. Allowed values are true and false.

Examples for get_domain_bulletin


        "user": "[email protected]",
        "password": "seekrit"
    "domain": "",
    "bulletin": "Welcome Message",
    "type": "auto"


  "success": true,
"From: Mister Manager <[email protected]> Subject: Welcome!
Content-Type: text/plain; charset=us-ascii 
Content-Disposition: inline
Hello {'title'} {'name'},
Welcome to Example Corporation source of the worlds best demo examples. 
FYI, your email address is {'account'}
Please contact Janice if you have any questions.
M. Manager"