Message

This document defines the Message resource.

Message resources represent a some type of mass communication – a mass email to an email list, an SMS sent to an SMS list, etc… – that is sent or otherwise communicated to to a list of people. Messages have fields to describe them such as names, subjects, bodies, statistics about delivery and engagement, and the like. Messages contain arrays that link to queries or lists representing people who are targeted to receive the message, and link to recipient lists for showing who received the message, and similar metadata. Messages can be one of two types, email or sms, indicating how the message was delivered.

Sections

Endpoints and URL structures

OSDI does not specify specific endpoints and link structures for compliant systems to use. Rather, because OSDI is a HAL+JSON API, endpoints and structures are defined in the links section of each returned resource, starting with the API Entry Point link.

HAL’s link structure lets an API consumer move through API levels, resources, and collections by parsing and following links. While most systems will not change the value of their links often and obey RESTful design principles, the value of each link when that resource is retrieved is the only canonical value, and it can change at any time.

The link relation label for an Message resource is osdi:message for a single Message resource or osdi:messages for a collection of Message resources.

Back to top…

Fields

The field names for this resource, with standard names, punctuation and capitalization, and values where appropriate.

Note: As with the entire OSDI specification, the specific fields a compliant system implements will vary between each system, as will the fields each system requires when creating or updating resources, which fields are writeable, and the operations you are allowed to perform on each resource.

Common Fields

A set of common fields that appear on all resources is included first, for reference.

Name Type Description
identifiers strings[] A unique string array of identifiers in the format [system name]:[id]. See the general concepts document for more information about identifiers.
created_date datetime A read-only property representing the date and time the resource was created on the local system.
modified_date datetime A read-only property representing the date and time the resource was last modified on the local system.

Back to top…

Message Fields

A list of fields specific to the Message resource.

Name Type Description
origin_system string A human readable identifier of the system where this message was created. (ex: “OSDI System”)
name string The name of the message. Intended for administrative display rather than a public title, though may be shown to a user.
subject string The subject of the message. (ex: email type messages will put the subject line of the email in this field)
body string The content of the message. May contain text and/or HTML. (ex: email type messages will put the HTML content of the email here)
from string The from line of the message. (ex: email messages can be from “John Doe” or “Progressives United”. SMS messages can be from “202-123-4567”)
reply_to string The reply to field for the message. (ex: emails may have a reply_to of “info@progressivesunited.org”)
administrative_url string A URL string pointing to the message’s administrative page on the web.
browser_url string A URL string pointing to the message’s public page on the web.
type enum The type of message. One of “email” or “sms”.
targets Targets[] Array of queries and/or lists representing the people targeted to receive this message.
sections Sections[] Array of keyword and auto replies configured for a message (typically an SMS message) and triggered when an incoming response is received.
total_targeted integer A read-only computed property representing the current count of the total number of people targeted to receive this message.
status enum Status of the message. Possible values are: “draft”, “calculating”, “scheduled”, “sending”, “stopped”, or “sent”.
scheduled_start_date datetime The date and time the message is scheduled to start sending to targets.
scheduled_end_date datetime The date and time the message is scheduled to stop sending to targets.
sent_start_date datetime The date and time the message started sending.
sent_end_date datetime The date and time the message finished sending.
daily_start_hour integer The hour of the day messages should start sending. (ex: SMS campaigns may only be sent during certain hours of the day)
daily_stop_hour integer The hour of the day messages should stop sending. (ex: SMS campaigns may only be sent during certain hours of the day)
statistics Statistics An object hash representing the engagement statistics for this message. (ex: open rate and unsubscribe rate)

Back to top…

These JSON hashes included in the table above are broken out into their own tables for readability, rather than independent resources with their own endpoints.

Target

Name Type Description
target.href string A link to a Query or List resource representing a group of people targeted to receive this message.

Section

Name Type Description
sections.keyword string The text in an incoming response that triggers this section’s auto_reply.
sections.auto_reply string The text that is sent back to the person who responded with this section’s keyword.

Statistics

Name Type Description
statistics.sent integer A read-only computed property representing the total number of messages sent.
statistics.delivered integer A read-only computed property representing the messages that were delivered to the recipients. You may have Email and SMS systems that confirm the delivery of message to recipient email or mobile numbers, ‘delivered’ is used in such scenarios.
statistics.opened integer A read-only computed property representing the total number of messages opened.
statistics.clicked integer A read-only computed property representing the total number of messages where a link was clicked.
statistics.actions integer A read-only computed property representing the total number of action taken by people after clicking links in this message.
statistics.forwards integer A read-only computed property representing the total number of times this message was forwarded.
statistics.unsubscribed integer A read-only computed property representing the total number of messages where the person receiving the message unsubscribed.
statistics.bounced integer A read-only computed property representing the total number of messages that bounced or were otherwise undelivered.
statistics.failed integer A read-only computed property representing the SMS messages that could not be delievered due to invalid mobile numbers or bad phone numbers. (Applicable to SMS messages)
statistics.no_route integer A read-only computed property representing the number of SMS messages where the number was temporarily out of network. (Applicable to SMS messages)
statistics.spam_reports integer A read-only computed property representing the total number of messages marked as spam by people receiving them.

Back to top…

The links associated with this resource, available in the links section of the resource. Links that are part of the OSDI spec are typically prefixed with the osdi: namespace to aid in curie matching and readability.

Note: As with the entire OSDI specification, the specific links a compliant system supplies will vary between each system. In addition, systems may choose to embed a linked resource directly in the response in addition to linking to it in the links section, using the standard _embedded syntax described in the general overview documentation.

Name Type Description
self Message* A self-referential link to the message.
creator Person* A link to a single Person resource representing the creator of the message.
modified_by Person* A link to a Person resource representing the last editor of this message.
taggings Taggings[]* A link to the collection of Tagging resources for this message.
recipients List* A link to the List resource that represents the list of People who received this message.
wrapper Wrapper* A link to the Wrapper resource that represent the wrapper that was used when sending this message.
send_helper Send Helper* A link to the Send Helper resource endpoint for this message.
schedule_helper Schedule Helper* A link to the Schedule Helper resource endpoint for this message.

Back to top…

Back to top…

Scenarios

The scenarios below show some common Create, Read, Update, Delete (CRUD) operations that can be performed on this resource, as well as any resource-specific behaviors worth highlighting. The following examples are for informational purposes. The authoritative resource definitions are above in the Fields tables and should be followed in the event of a conflict with the examples.

Scenario: Retrieving a collection of Message resources (GET)

Message resources are sometimes presented as collections of messages. For example, calling the messages endpoint will return a collection of all the messages stored in the system’s database associated with your api key.

Request

GET https://osdi-sample-system.org/api/v1/messages/

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "total_pages": 10,
    "per_page": 25,
    "page": 1,
    "total_records": 250,
    "_links": {
        "next": {
            "href": "https://osdi-sample-system.org/api/v1/messages?page=2"
        },
        "osdi:messages": [
            {
                "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
            },
            {
                "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e"
            },
            //(truncated for brevity)
        ],
        "curies": [
            {
                "name": "osdi",
                "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/messages"
        }
    },
    "_embedded": {
        "osdi:messages": [
            {
                "identifiers": [
                    "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
                    "foreign_system:1"
                ],
                "origin_system": "OSDI Sample System",
                "created_date": "2014-03-20T21:04:31Z",
                "modified_date": "2014-03-20T21:04:31Z",
                "name": "GOTV email version 1",
                "subject": "It's time to go vote!",
                "body": "<p>It's time to go vote!</p>",
                "from": "The Committee To Elect Jane Doe",
                "reply_to": "info@janedoe.com",
                "administrative_url": "http://osdi-sample-system.org/emails/gotv-v1/manage",
                "browser_url": "http://osdi-sample-system.org/emails/gotv-v1",
                "type": "email",
                "targets": [
                    {
                        "href": "https://osdi-sample-system.org/api/v1/queries/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
                    },
                    {
                        "href": "https://osdi-sample-system.org/api/v1/lists/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
                    }
                ],    
                "total_targeted": 14123,
                "status": "sent",
                "sent_start_date": "2015-03-14T12:00:00Z",
                "sent_end_date": "2015-03-14T13:00:00Z",
                "statistics": {
                    "sent": 14123,
                    "delivered": 12637,
                    "opened": 5637,
                    "clicked": 1753,
                    "actions": 253,
                    "forwards": 53,
                    "unsubscribed": 26,
                    "bounced": 58,
                    "spam_reports": 2
                },
                "_links": {
                    "self": {
                        "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
                    },
                    "osdi:creator": {
                        "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
                    },
                    "osdi:modified_by": {
                        "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
                    },
                    "osdi:recipients": {
                        "href": "https://osdi-sample-system.org/api/v1/lists/c945d6fe-929e-11e3-a2e9-12313d316c29"
                    },
                    "osdi:wrapper": {
                        "href": "https://osdi-sample-system.org/api/v1/wrappers/c945d6fe-929e-11e3-a2e9-12313d316c29"
                    },
                    "osdi:taggings": {
                        "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
                    },
                    "osdi:send_helper": {
                        "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/send"
                    },
                    "osdi:schedule_helper": {
                        "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/schedule"
                    }
                }
            },
            {
                "identifiers": [
                    "osdi_sample_system:1efc3644-af25-4253-90b8-a0baf12dbd1e"
                ],
                "origin_system": "OSDI Sample System",
                "created_date": "2014-03-20T20:44:13Z",
                "modified_date": "2014-03-20T20:44:13Z",
                "name": "GOTV SMS",
                "body": "Don't forget to vote on March 21! Let us know by responding YES or NO",
                "from": "202-123-4567",
                "administrative_url": "http://osdi-sample-system.org/sms/gotv/manage",
                "type": "sms",
                "targets": [
                    {
                        "href": "https://osdi-sample-system.org/api/v1/queries/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
                    }
                ],
                "total_targeted": 2536,
                "sections": [
                    {
                        "keyword": "YES",
                        "auto_reply":"Thanks for voting!"
                    },
                    {
                        "keyword": "NO",
                        "auto_reply":"Sorry, maybe next time!"
                    }
                ],
                "status": "scheduled",
                "scheduled_start_date": "2015-03-14T12:00:00Z",
                "scheduled_end_date": "2015-03-17T12:00:00Z",
                "daily_start_hour": 9,
                "daily_stop_hour": 17,
                "statistics": {
                    "sent": 14123,
                    "delivered": 12637,
                    "failed": 1753,
                    "no_route": 253
                },
                "_links": {
                    "self": {
                        "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e"
                    },
                    "osdi:creator": {
                        "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
                    },
                    "osdi:modified_by": {
                        "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
                    },
                    "osdi:recipients": {
                        "href": "https://osdi-sample-system.org/api/v1/lists/c945d6fe-929e-11e3-a2e9-12313d316c29"
                    },
                    "osdi:wrapper": {
                        "href": "https://osdi-sample-system.org/api/v1/wrappers/c945d6fe-929e-11e3-a2e9-12313d316c29"
                    },
                    "osdi:send_helper": {
                        "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/send"
                    },
                    "osdi:schedule_helper": {
                        "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/schedule"
                    }
                }
            },
            //(truncated for brevity)
        ]
    }
}

Back to top…

Scenario: Scenario: Retrieving an individual Message resource (GET)

Calling an individual Message resource will return the resource directly, along with all associated fields and appropriate links to additional information about the message.

Request

GET https://osdi-sample-system.org/api/v1/messages/d32fcdd6-7366-466d-a3b8-7e0d87c3cd8b

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
        "foreign_system:1"
    ],
    "origin_system": "OSDI Sample System",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "name": "GOTV email version 1",
    "subject": "It's time to go vote!",
    "body": "<p>It's time to go vote!</p>",
    "from": "The Committee To Elect Jane Doe",
    "reply_to": "info@janedoe.com",
    "administrative_url": "http://osdi-sample-system.org/emails/gotv-v1/manage",
    "browser_url": "http://osdi-sample-system.org/emails/gotv-v1",
    "type": "email",
    "targets": [
        {
            "href": "https://osdi-sample-system.org/api/v1/queries/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        {
             "href": "https://osdi-sample-system.org/api/v1/lists/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        }
    ],
    "total_targeted": 14123,
    "status": "sent",
    "sent_start_date": "2015-03-14T12:00:00Z",
    "sent_end_date": "2015-03-14T13:00:00Z",
    "statistics": {
        "sent": 14123,
        "delivered": 12637,
        "opened": 5637,
        "clicked": 1753,
        "actions": 253,
        "forwards": 53,
        "unsubscribed": "26",
        "bounced": 58,
        "spam_reports": 2
    },
    "_links": {
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e"
        },
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:modified_by": {
            "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:recipients": {
            "href": "https://osdi-sample-system.org/api/v1/lists/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:wrapper": {
            "href": "https://osdi-sample-system.org/api/v1/wrappers/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:taggings": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
        },
        "osdi:send_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/send"
        },
        "osdi:schedule_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/schedule"
        }
    }
}    

Back to top…

Scenario: Creating a new message (POST)

Posting to the messages collection endpoint will allow you to create a new SMS message. Optionally adding a link to a Person resource will set the creator. You can also add inline sections for setting keyword based responses for the SMS Message. The response is the new message that was created. While each implementing system will require different fields, any optional fields not included in a post operation should not be set at all by the receiving system, or should be set to default values.

Request

POST https://osdi-sample-system.org/api/v1/messages/

Header:
OSDI-API-Token:[your api key here]

{
    "identifiers": [
        "foreign_system:1"
    ],
    "origin_system": "OSDI Sample System",
    "name": "GOTV SMS",
    "body": "Don't forget to vote on March 21! Let us know by responding YES or NO",
    "from": "202-123-4567",
    "reply_to": "202-123-4567",
    "type": "sms",
    "sections": [
        {
            "keyword": "YES",
            "auto_reply":"Thanks for voting!"
        },
        {
            "keyword": "NO",
            "auto_reply":"Sorry, maybe next time!"
        }
    ],
    "_links": {
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:taggings": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
        },
        "osdi:wrapper": {
            "href": "https://osdi-sample-system.org/api/v1/wrappers/c945d6fe-929e-11e3-a2e9-12313d316c29"
        }
    }
}

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:1efc3644-af25-4253-90b8-a0baf12dbd1e",
        "foreign_system:1"
    ],
    "origin_system": "OSDI Sample System",
    "created_date": "2014-03-20T20:44:13Z",
    "modified_date": "2014-03-20T20:44:13Z",
    "name": "GOTV SMS",
    "body": "Don't forget to vote on March 21! Let us know by responding YES or NO",
    "from": "202-123-4567",
    "reply_to": "202-123-4567",
    "status": "draft",
    "administrative_url": "http://osdi-sample-system.org/sms/gotv/manage",
    "type": "sms",
    "targets": [],
    "total_targeted": 0,
    "sections": [
        {
            "keyword": "YES",
            "auto_reply":"Thanks for voting!"
        },
        {
            "keyword": "NO",
            "auto_reply":"Sorry, maybe next time!"
        }
    ],
    "_links": {
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e"
        },
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:modified_by": {
            "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:recipients": {
            "href": "https://osdi-sample-system.org/api/v1/lists/1efc3644-af25-4253-90b8-a0baf12dbd1e"
        },
        "osdi:wrapper": {
            "href": "https://osdi-sample-system.org/api/v1/wrappers/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:taggings": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
        },
        "osdi:send_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/send"
        },
        "osdi:schedule_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/schedule"
        }
    }
}

Back to top…

Scenario: Modifying a message (PUT)

You can update a message by calling a PUT operation on that message’s endpoint. Your PUT should contain fields that you want to update. Missing fields will be ignored by the receiving system. Systems may also ignore PUT values, depending on whether fields you are trying to modify are read-only or not. You may set an attribute to nil by including the attribute using nil for value.

Note: Modifying members of an array separately is not supported. To change the contents of an array, first GET the current contents and then PUT back only those you wish to keep.

Request

PUT https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse

Header:
OSDI-API-Token:[your api key here]

{
    "name": "GOTV email version 2"
}

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
        "foreign_system:1"
    ],
    "origin_system": "OpenSupporter",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "name": "GOTV email version 2",
    "subject": "It's time to go vote!",
    "body": "<p>It's time to go vote!</p>",
    "from": "The Committee To Elect Jane Doe",
    "reply_to": "info@janedoe.com",
    "type": "email",
    "status": "draft",
    "administrative_url": "http://osdi-sample-system.org/emails/gotv-v2/manage",
    "browser_url": "http://osdi-sample-system.org/emails/gotv-v2",
    "targets": [],
    "total_targeted": 0,
    "_links": {
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:modified_by": {
            "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:recipients": {
            "href": "https://osdi-sample-system.org/api/v1/lists/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:wrapper": {
            "href": "https://osdi-sample-system.org/api/v1/wrappers/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:taggings": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
        },
        "osdi:send_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/send"
        },
        "osdi:schedule_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/schedule"
        }
    }
}

Back to top…

Scenario: Adding targets to a message (POST/PUT)

You can add targeted people to receive a message in the form of links to queries or lists by POST/PUTing the targets array on a message. This action will typically cause the message’s targets to be recalculated by the system, based on the targeted parameters.

Note: Modifying members of an array separately is not supported. To change the contents of an array, first GET the current contents and then PUT back only those you wish to keep.

Request

PUT https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse

Header:
OSDI-API-Token:[your api key here]

{
    "targets": [
        {
            "href": "https://osdi-sample-system.org/api/v1/queries/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        {
            "href": "https://osdi-sample-system.org/api/v1/lists/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        }
    ]
}

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
        "foreign_system:1"
    ],
    "origin_system": "OpenSupporter",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "name": "GOTV email version 2",
    "subject": "It's time to go vote!",
    "body": "<p>It's time to go vote!</p>",
    "from": "The Committee To Elect Jane Doe",
    "reply_to": "info@janedoe.com",
    "type": "email",
    "status": "calculating",
    "administrative_url": "http://osdi-sample-system.org/emails/gotv-v2/manage",
    "browser_url": "http://osdi-sample-system.org/emails/gotv-v2",
    "targets": [
        {
            "href": "https://osdi-sample-system.org/api/v1/queries/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        {
            "href": "https://osdi-sample-system.org/api/v1/lists/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        }
    ],
    "total_targeted": 0,
    "_links": {
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:modified_by": {
            "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:recipients": {
            "href": "https://osdi-sample-system.org/api/v1/lists/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:wrapper": {
            "href": "https://osdi-sample-system.org/api/v1/wrappers/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:taggings": {
            "href": "https://osdi-sample-system.org/api/v1/messages/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
        },
        "osdi:send_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/send"
        },
        "osdi:schedule_helper": {
            "href": "https://osdi-sample-system.org/api/v1/messages/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/schedule"
        }
    }
}

Back to top…

Scenario: Deleting a message (DELETE)

You may delete a message by calling the DELETE command on the message’s endpoint.

Request

DELETE https://osdi-sample-system.org/api/v1/messages/d32fcdd6-7366-466d-a3b8-7e0d87c3cd8b

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "notice": "This message was successfully deleted."
}

Back to top…