Page Properties |
---|
label | api_docs_client_actions |
---|
|
Name | Clients / Email Addresses / Create |
---|
Description | Create one or more email addresses for an existing client |
---|
Type | POST |
---|
URL | /v9/clients/:client_id/email_addresses |
---|
Credential Type | API |
---|
|
Long Description
Create one or more email addresses for an existing client. Note that this takes an array of email addresses even if only creating one.
Parameters
| | | | Location | Limitations |
---|
client_id | The ID of the specific Client | Integer | Required | URI | |
address | The email address | String | Required | Body | |
label | A label to associate with this address | String | Optional | Body | 20 characters max |
Examples
Request | Response |
---|
POST /v9/clients/:client_id/email_ |
addressaddresses | |
Code Block |
---|
language | ruby |
---|
theme | Confluence |
---|
|
|
language | ruby |
---|
{
"email_addresses":[
{
"label":"Work",
"address":"moe@moestavern.com"
}
]
} |
| Code Block |
---|
language | ruby |
---|
theme | Confluence |
---|
|
|
language | ruby | {
"email_addresses":[
{
"address":"moe@moestavern.com",
"label":"Work",
"updated_at":"2014-02-05T16:00:48Z",
"url":"/clients/109402/email_addresses/145996",
"id":"145996"
}
]
} |
|