Emails
Required feature: **emails/view**
Section:
Group Emails. Base URL:https://instance_name.meiro.io/api/.
Emails [/emails/{email_id}]
Retrieve Email [GET]
Required feature: emails/view
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"email": {
"id": "983d437d-eac6-423b-beb5-40a619be332f",
"name": "My email",
"subject": "subject",
"preheader": "preheader",
"from_email": {
"email_address": "we.are@meiro.io",
"name": "Mrs. Meiro"
},
"reply_to_email": "we.really.are@meiro.io",
"content_json": "json content",
"content_html": "html content",
"utm_parameters": {
"source": "source",
"medium": "medium",
"campaign": "campaign",
"term": "term",
"content": "content"
},
"frequency_cap": {
"ignore_channel_frequency_cap": false,
"max_count": 1,
"period": {
"type": "days",
"size": 1
}
},
"modified": "2018-11-07T10:19:48Z",
"modified_by": 1,
"last_activation": "2018-11-07T10:19:48Z",
"last_activation_by": 1,
"deleted": false,
"schedules": [{
"segment_ids": [1],
"schedule_type": "repetitive",
"schedules": [{
"minute": "*",
"hour": "*",
"day": "*",
"month": "*",
"day_of_week": "*"
}]
}],
"include_unsubscribe": true
}
}Modify Email [PATCH]
Required feature: emails/edit
-
Attributes (EmailUpdate)
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"email": {
"id": "983d437d-eac6-423b-beb5-40a619be332f",
"name": "My email",
"subject": "subject",
"preheader": "preheader",
"from_email": {
"email_address": "we.are@meiro.io",
"name": "Mrs. Meiro"
},
"reply_to_email": "we.really.are@meiro.io",
"content_json": "json content",
"content_html": "html content",
"utm_parameters": {
"source": "source",
"medium": "medium",
"campaign": "campaign",
"term": "term",
"content": "content"
},
"frequency_cap": {
"ignore_channel_frequency_cap": false,
"max_count": 1,
"period": {
"type": "days",
"size": 1
}
},
"modified": "2018-11-07T10:19:48Z",
"modified_by": 1,
"last_activation": "2018-11-07T10:19:48Z",
"last_activation_by": 1,
"deleted": false,
"schedules": [{
"segment_ids": [1],
"schedule_type": "repetitive",
"schedules": [{
"minute": "*",
"hour": "*",
"day": "*",
"month": "*",
"day_of_week": "*"
}]
}],
"include_unsubscribe": true
}
}Delete Email [DELETE]
Required feature: emails/edit
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"message": "OK"
}
Emails [/emails]
List All Emails [GET]
Required feature: emails/view
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"emails": [
{
"id": "983d437d-eac6-423b-beb5-40a619be332f",
"name": "My email",
"subject": "subject",
"preheader": "preheader",
"from_email": {
"email_address": "we.are@meiro.io",
"name": "Mrs. Meiro"
},
"reply_to_email": "we.really.are@meiro.io",
"content_json": "json content",
"content_html": "html content",
"utm_parameters": {
"source": "source",
"medium": "medium",
"campaign": "campaign",
"term": "term",
"content": "content"
},
"frequency_cap": {
"ignore_channel_frequency_cap": false,
"max_count": 1,
"period": {
"type": "days",
"size": 1
}
},
"modified": "2018-11-07T10:19:48Z",
"modified_by": 1,
"last_activation": "2018-11-07T10:19:48Z",
"last_activation_by": 1,
"deleted": false,
"schedules": [{
"segment_ids": [1],
"schedule_type": "repetitive",
"schedules": [{
"minute": "*",
"hour": "*",
"day": "*",
"month": "*",
"day_of_week": "*"
}]
}],
"include_unsubscribe": true
}
]
}Create Email [POST]
Required feature: emails/edit
-
Attributes (EmailCreate)
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 201 (application/json)
{
"email": {
"id": "983d437d-eac6-423b-beb5-40a619be332f",
"name": "My email",
"subject": "subject",
"preheader": "preheader",
"from_email": {
"email_address": "we.are@meiro.io",
"name": "Mrs. Meiro"
},
"reply_to_email": "we.really.are@meiro.io",
"content_json": "json content",
"content_html": "html content",
"utm_parameters": {
"source": "source",
"medium": "medium",
"campaign": "campaign",
"term": "term",
"content": "content"
},
"frequency_cap": {
"ignore_channel_frequency_cap": false,
"max_count": 1,
"period": {
"type": "days",
"size": 1
}
},
"modified": "2018-11-07T10:19:48Z",
"modified_by": 1,
"last_activation": null,
"last_activation_by": null,
"deleted": false,
"schedules": [{
"segment_ids": [1],
"schedule_type": "repetitive",
"schedules": [{
"minute": "*",
"hour": "*",
"day": "*",
"month": "*",
"day_of_week": "*"
}]
}],
"include_unsubscribe": true
}
}