Search for audience emails.
| Method | URI | Description |
|---|---|---|
| GET | /users/{user_id}/audience_emails |
Search user owned audience emails |
{
"data": [
{
"id": 1,
"audience_message_id": 1,
"audience": "Sphere",
"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 an audience email.
| Method | URI | Description |
|---|---|---|
| POST | /users/{user_id}/audience_emails |
Create a user owned audience email |
{
"audience_message_id": 1,
"audience": "Sphere",
"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": []
}{
"id": 1,
"audience_message_id": 1,
"audience": "Sphere",
"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
}Retrieve an audience email.
| Method | URI | Description |
|---|---|---|
| GET | /audience_emails/{audience_email_id} |
Retrieve an audience email by it's id |
{
"id": 1,
"audience_message_id": 1,
"audience": "Sphere",
"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 an audience email.
| Method | URI | Description |
|---|---|---|
| PUT | /audience_emails/{audience_email_id} |
Update an audience email |
{
"audience_message_id": 1,
"audience": "Sphere",
"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": []
}{
"id": 1,
"audience_message_id": 1,
"audience": "Sphere",
"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 an audience email.
| Method | URI | Description |
|---|---|---|
| DELETE | /audience_emails/{audience_email_id} |
Delete an audience email by it's id |
{
"success": true
}