A Bulletin resource represents a communication drafted and/or sent out using Communications Cloud from your account. Bulletin resources can represent standard bulletins or bulletins created with the advanced bulletin editor. You can also use the Bulletins resource to manage attachments to bulletins.
Method | Description |
Required Permissions |
---|---|---|
Create and Send Bulletin |
You want to create and send a bulletin in one action using the API. This can only be done for one bulletin at a time. You can specify content for the bulletin using a multipart form if you need to include file attachments for the bulletin. If no attachments are required, you can also use XML for the input. |
|
Create a Draft Bulletin |
When you POST to the bulletin resource, a bulletin is created in draft status. Using this method, you specify bulletin content, including a header, footer, and body as well as sending options, like pushing to RSS and tracking recipient interactions with the bulletin. This draft bulletin can be viewed and sent via the administrative interface. |
|
Update a Bulletin |
You can update a bulletin in draft form by sending a PUT operation for a particular bulletin ID. In order to do this, you need the ID of the bulletin. This is returned by the Create Draft Bulletin method. You can also use the List Draft Bulletins method to see what bulletins currently exist in draft form and get a draft bulletin's ID. |
|
Send a Bulletin |
You can send existing bulletins in draft form by sending a POST operation for a particular bulletin ID using the send_now link. In order to do this, you need the ID of the bulletin. This is returned by the Create Draft Bulletin method. You can also use the List Draft Bulletins method to see what bulletins currently exist in draft form and get a draft bulletin's ID. If you are using the API to create and send bulletins, without holding them in draft form for review or any other reason, consider using the Create and Send Bulletin method. |
|
Test a Bulletin |
Before sending a bulletin to your subscribers, it's a good idea to test it. You can do so by sending a test of the bulletin to a list of internal recipients for review. |
|
Schedule a Bulletin |
You can schedule a bulletin still in draft form to be sent at a later time and date. This method activates the schedule. The date and time are set when you initially create the bulletin or can be set using the Update Bulletin method. |
|
Unschedule a Bulletin |
You can unschedule a scheduled bulletin that has not yet been sent. After unscheduling, the bulletin will be in draft form and can be found using the List Draft Bulletins method. |
|
Delete a Bulletin |
You can delete a bulletin still while it's in draft form. You can find all bulletins in draft form for your account using the List Draft Bulletins method. |
|
List Draft Bulletins |
You can look up all bulletins currently in draft form for your account using a GET operation. This call returns information about the bulletin like the subject, metadata (who created it, when it was sent, etc.), and the URI for that specific bulletin. You can use the returned URI for additional operations, like sending a bulletin, updating a bulletin attachment, or scheduling a bulletin. |
|
List Sent Bulletins | You can look up all bulletins that have been sent for your account using a GET operation. This call returns information about the bulletin like the subject, metadata (who created it, when it was sent, etc.), and the URI for that specific bulletin. You can use the returned URI for additional operations, like updating the bulletin or updating its attachment. |
|
Add a Bulletin Attachment |
You can add attachments to any bulletin still in draft form. In order to make this call, you will need the bulletin's ID. You can find all bulletins that are currently in draft form for your account (and get their ID) using the List Draft Bulletins method. For this call, the input is multipart and we recommend using a library to construct the MIME content. |
|
Remove a Bulletin Attachment |
You can remove an attachment from any bulletin that has not been delivered. If you remove an attachment from a bulletin that has already been sent, the attachment will only be removed for those recipients whose bulletin messages are still queued for sending. |
|
Update a Bulletin Attachment |
You can update an attachment for a bulletin that has not been delivered. If you update an attachment for a bulletin that has already been sent, the attachment will only be updated for those recipients whose bulletin messages are still queued for sending. Note that you can't change a bulletin using this call; you can only update the same bulletin (replacing the old version with the new version). If you want to change a bulletin attachment, use the Remove a Bulletin method, followed by Add a Bulletin. |
|
Read a Bulletin | You can see details about a particular bulletin, such as the administrator who created it, recipient list, creation time, etc. by posting a GET to that particular bulletin. Bulletins in both draft and sent form can be read by this method. |
|
<header> | This is text or a linked image displayed at the top of the email bulletin that is created. Note: If you are using an image (via href link) please ensure that the image is no wider than 700px. If the header value is left blank or the node is omitted from the XML payload then the system will use the header specified in the bulletin template that has been set via the administrative interface. |
<from_address_id> | This is an optional field that is utilized only when there are multiple from addresses specified for the client account. If you do not know your from address id, you can contact the GovDelivery help desk at support@granicus.com or call 800-314-0147 (UK residents: 0800-032-7764) to get it. The account used for authentication must have the Modify Bulletin From Address permission or otherwise this element will be ignored. |
<subject> | This is the subject of the email bulletin. Note: When creating a subject line please refrain from entering special characters such as "!" or "quotes" as this may increase chances of the email being flagged as spam. The <subject> has a 400 character limit and is a required node but can be left blank. |
<body> | This is the body of the email bulletin. You can use CDATA blocks to specify HTML formatting or use plain text. If this node is omitted from the XML payload, then this element will come from whatever bulletin template has been set up in the administrative interface. |
<footer> | This is text or a linked image that is displayed on the bottom of the email bulletin. The account used for authentication must have the Modify Bulletin Footer permission or otherwise this element will be ignored. |
<sms_body> | This field allows you to specify a SMS message via this API operation. This field will only have effect if SMS messaging is turned on for the client's account. There is a 140-character limit on this field. If you do not want to include an SMS body, include the nil="true" attribute. |
<publish_rss> | This field requires the type='boolean' attribute. Set it to true to publish the bulletin to the account send-activity RSS feed, if the feature is turned on for the account. |
<open_tracking> | This field requires the type='boolean' attribute. Set it to true to track whether the recipients open this email bulletin. The report created when this field is used is available via the administrative interface. |
<click_tracking> | This field requires the type='boolean' attribute. Set it to true to track if each recipient clicks any links within this email bulletin. The report created when this field is used is available via the administrative interface. |
<send_time> | Include this element if you plan to schedule the bulletin for sending. |
<urgent> | This optional field requires the type='boolean' attribute. Set it to true to override a subscriber's digest (email frequency) settings and send the bulletin immediately. If this field is used in tandem with <send_time>, the bulletin will be sent when scheduled, ignoring the subscriber's digest settings. |
<share_content_enabled> | If social sharing is enabled for the account, then this field allows you to share the bulletin to Facebook or Twitter. |
<topics> |
Topics are used to organize your bulletins. The public can subscribe to updates about a topic. When they do so, they are added to the topic's mailing list. When a bulletin is tagged with a topic, all recipients for the topic receive the bulletin. If you enter multiple topics in this element and a recipient has signed up for more than one topic listed here, they will receive only one copy of the email bulletin. This field must include the type="array" attribute. This field contains nested <topic> elements. |
<topic> | Include this element for every topic you want to assign the bulletin. This element contains a nested <code> element. |
<code> | This is the code for the topic or topics that the email bulletin will be sent to. |
<categories> | Categories are used to organize your topics and bulletins. You can configure a category to allow the public to subscribe to updates for the category. When a bulletin is tagged with a category, all subscribers for that category receive the bulletin. Enter an array of categories (or simply choose one) that you will send this bulletin for. If you enter multiple categories in this element and a recipient has signed up for more than one category listed here, they will receive only one copy of the email bulletin. Enter their category codes here in the same format as topic codes (see input example above). |
Was this page helpful? Can't find what you need? Let us know