Blast Emails


Search

Search for blast emails.

Endpoint

Method URI Description
GET /users/{user_id}/blast_emails Search user owned blast emails

Example Response

{
    "data": [
        {
            "id": 1,
            "subject": "Email subject...",
            "description": "Email description...",
            "greeting_with_first_name": "Hi Contact,",
            "greeting_without_first_name": "Hi,",
            "body": "Email body... (can contain valid email html)",
            "closing": "Email closing...",
            "ps_line": "Email ps_line",
            "text": "Email body text representation...",
            "signature_id": 1,
            "status": "Saved",
            "send_type": "Future",
            "send_at": "2016-08-24T18:07:38Z",
            "sending_at": "2016-08-24T18:07:38Z",
            "sent_at": "2016-08-24T18:07:38Z",
            "recipients": [],
            "exclusions": null,
            "source": "Email source...",
            "reporting": {
                "date": null,
                "sent": 1,
                "processed": 1,
                "delivered": 1,
                "open": 0,
                "click": 0,
                "reply": 0,
                "spamreport": 0,
                "unsubscribe": 0,
                "deferred": 0,
                "dropped": 0,
                "bounce": 0,
                "hard_bounce": 0,
                "soft_bounce": 0,
                "failed": 0
            },
            "created_at": "2016-08-24T18:07:38Z",
            "updated_at": "2016-08-24T18:07:38Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://api.happygrasshopper.com/v3/contacts/11882201/addresses?page=1",
        "last": "https://api.happygrasshopper.com/v3/contacts/11882201/addresses?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": null,
        "last_page": 1,
        "path": "https://api.happygrasshopper.com/v3/contacts/11882201/addresses",
        "per_page": 15,
        "to": null,
        "total": 1
    }
}

Create

Create an blast email.

Endpoint

Method URI Description
POST /users/{user_id}/blast_emails Create a user owned blast email

Body Params

{
    "subject": "Email subject...",
    "description": "Email description...",
    "greeting_with_first_name": "Hi Contact,",
    "greeting_without_first_name": "Hi,",
    "body": "Email body... (can contain valid email html)",
    "closing": "Email closing...",
    "ps_line": "Email ps_line",
    "signature_id": 1,
    "status": "Saved",
    "send_type": "Future",
    "send_at": "2016-08-24T18:07:38Z",
    "recipients": [],
    "exclusions": []
}

Example Response

{
    "id": 1,
    "subject": "Email subject...",
    "description": "Email description...",
    "greeting_with_first_name": "Hi Contact,",
    "greeting_without_first_name": "Hi,",
    "body": "Email body... (can contain valid email html)",
    "closing": "Email closing...",
    "ps_line": "Email ps_line",
    "text": "Email body text representation...",
    "signature_id": 1,
    "status": "Saved",
    "send_type": "Future",
    "send_at": "2016-08-24T18:07:38Z",
    "sending_at": "2016-08-24T18:07:38Z",
    "sent_at": "2016-08-24T18:07:38Z",
    "recipients": [],
    "exclusions": null,
    "source": "Email source...",
    "reporting": {
        "date": null,
        "sent": 1,
        "processed": 1,
        "delivered": 1,
        "open": 0,
        "click": 0,
        "reply": 0,
        "spamreport": 0,
        "unsubscribe": 0,
        "deferred": 0,
        "dropped": 0,
        "bounce": 0,
        "hard_bounce": 0,
        "soft_bounce": 0,
        "failed": 0
    },
    "created_at": "2016-08-24T18:07:38Z",
    "updated_at": "2016-08-24T18:07:38Z",
    "deleted_at": null
}

Read

Retrieve an blast email.

Endpoint

Method URI Description
GET /blast_emails/{blast_email_id} Retrieve an blast email by it's id

Example Response

{
    "id": 1,
    "subject": "Email subject...",
    "description": "Email description...",
    "greeting_with_first_name": "Hi Contact,",
    "greeting_without_first_name": "Hi,",
    "body": "Email body... (can contain valid email html)",
    "closing": "Email closing...",
    "ps_line": "Email ps_line",
    "text": "Email body text representation...",
    "signature_id": 1,
    "status": "Saved",
    "send_type": "Future",
    "send_at": "2016-08-24T18:07:38Z",
    "sending_at": "2016-08-24T18:07:38Z",
    "sent_at": "2016-08-24T18:07:38Z",
    "recipients": [],
    "exclusions": null,
    "source": "Email source...",
    "reporting": {
        "date": null,
        "sent": 1,
        "processed": 1,
        "delivered": 1,
        "open": 0,
        "click": 0,
        "reply": 0,
        "spamreport": 0,
        "unsubscribe": 0,
        "deferred": 0,
        "dropped": 0,
        "bounce": 0,
        "hard_bounce": 0,
        "soft_bounce": 0,
        "failed": 0
    },
    "created_at": "2016-08-24T18:07:38Z",
    "updated_at": "2016-08-24T18:07:38Z",
    "deleted_at": null
}

Update

Update an blast email.

Endpoint

Method URI Description
PUT /blast_emails/{blast_email_id} Update an blast email

Body Params

{
    "subject": "Email subject...",
    "description": "Email description...",
    "greeting_with_first_name": "Hi Contact,",
    "greeting_without_first_name": "Hi,",
    "body": "Email body... (can contain valid email html)",
    "closing": "Email closing...",
    "ps_line": "Email ps_line",
    "signature_id": 1,
    "status": "Saved",
    "send_type": "Future",
    "send_at": "2016-08-24T18:07:38Z",
    "recipients": [],
    "exclusions": []
}

Example Response

{
    "id": 1,
    "subject": "Email subject...",
    "description": "Email description...",
    "greeting_with_first_name": "Hi Contact,",
    "greeting_without_first_name": "Hi,",
    "body": "Email body... (can contain valid email html)",
    "closing": "Email closing...",
    "ps_line": "Email ps_line",
    "text": "Email body text representation...",
    "signature_id": 1,
    "status": "Saved",
    "send_type": "Future",
    "send_at": "2016-08-24T18:07:38Z",
    "sending_at": "2016-08-24T18:07:38Z",
    "sent_at": "2016-08-24T18:07:38Z",
    "recipients": [],
    "exclusions": null,
    "source": "Email source...",
    "reporting": {
        "date": null,
        "sent": 1,
        "processed": 1,
        "delivered": 1,
        "open": 0,
        "click": 0,
        "reply": 0,
        "spamreport": 0,
        "unsubscribe": 0,
        "deferred": 0,
        "dropped": 0,
        "bounce": 0,
        "hard_bounce": 0,
        "soft_bounce": 0,
        "failed": 0
    },
    "created_at": "2016-08-24T18:07:38Z",
    "updated_at": "2016-08-24T18:07:38Z",
    "deleted_at": null
}

Delete

Delete an blast email.

Endpoint

Method URI Description
DELETE /blast_emails/{blast_email_id} Delete an blast email by it's id

Example Response

{
    "success": true
}