/EmailAddresses POST
Overview
Create a new email address.
Summary
In the event that the email address already exists, that record will be returned without making any changes.
Request Arguments
| Name |
Type |
Description |
Required |
|---|
|
email_address
|
String
|
The email address.
|
True
|
|
invalid_email
|
Boolean
|
true if the email address is invalid. false is the default.
|
False
|
|
opt_out
|
Boolean
|
true if the email address is opted out. false is the default.
|
False
|
Request
{
"email_address": "eharmon@example.com",
"invalid_email": false,
"opt_out": false
}
Response Arguments
| Name |
Type |
Description |
|---|
|
<record field>
|
<record field type>
|
Returns the fields for the newly created record.
|
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"date_created": "2016-02-25T11:53:07-08:00",
"date_modified": "2016-02-25T11:53:07-08:00",
"deleted": false,
"email_address": "eharmon@example.com",
"email_address_caps": "EHARMON@EXAMPLE.COM",
"invalid_email": false,
"opt_out": false,
"_acl": {
"fields": {}
},
"_module": "EmailAddresses"
}
Change Log
| Version |
Change |
|---|
|
v10
|
Added /EmailAddresses POST endpoint.
|