get_domain_bulletin

Syntax

{
  <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 name	Obligation	Definition/Value
bulletin	Required	The name of the bulletin you want to view.
domain	Required	The name of the domain the bulletin is in.
type	Required	The 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.

Field name

Obligation

Definition/Value

bulletin

Required

The name of the bulletin you want to view.

domain

Required

The name of the domain the bulletin is in.

type

Required

The 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 name	Obligation	Description/Value
bulletin_text	Returned if success = true	The text of the bulletin, including headers.
error	Returned if success = false	A text string that explains the error.
error_number	Returned if success = false	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_domain_bulletin

Request

{
    "credentials":{
        "user": "[email protected]",
        "password": "seekrit"
    }
    "domain": "example.com",
    "bulletin": "Welcome Message",
    "type": "auto"
}

Response

{
  "success": true,
  "bulletin_text":
"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"
}