/EmailAddresses/:record PUT
Overview
Update an existing email address.
Summary
The email_address parameter is not supported as email addresses are immutable.
Request Arguments
| Name |
Type |
Description |
Required |
|---|
|
invalid_email
|
Boolean
|
true if the email address is invalid.
|
False
|
|
opt_out
|
Boolean
|
true if the email address is opted out.
|
False
|
Request
{
"opt_out": true
}
Response Arguments
| Name |
Type |
Description |
|---|
|
<record field>
|
<record field type>
|
Returns the fields for the updated 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": true,
"_acl": {
"fields": {}
},
"_module": "EmailAddresses"
}
Change Log
| Version |
Change |
|---|
|
v10
|
Added /EmailAddresses/:record PUT endpoint.
|