diff --git a/source/includes/rest/_accounts.md b/source/includes/rest/_accounts.md index f003402a401..ede4a4ad767 100644 --- a/source/includes/rest/_accounts.md +++ b/source/includes/rest/_accounts.md @@ -84,6 +84,14 @@ href The url designated for retrieving the account record via the REST API. + + default_email_address_id + A read-only id of the account's default From address in sending_addresses. Returns null if the account has no default From address or its default address has been deleted. Only returned when fetching an account. + + + sending_addresses + A read-only list of the account's email addresses, including unverified ones. Only returned when fetching an account. Refer to Sending addresses for an overview of the properties returned here. + links An object containing URLs for campaign and conversion resources. Note, conversions are represented as "Goals". @@ -191,13 +199,84 @@ client.fetchAccount(accountId) > The response looks like this: ```json -# The accounts property is an array of one account object. +# The accounts property is an array of one account object, +# which also includes the account's sending addresses. { "links": { ... }, - "accounts": [{ ... }] + "accounts": [{ + "id": "9999999", + "name": "Acme, Inc.", + ... + "default_email_address_id": "1234567", + "sending_addresses": [ + { + "id": "1234569", + "email": "support@acme.com", + "is_default": false, + "verified": true, + "auto_generated": false + }, + { + "id": "1234568", + "email": "news@acme.com", + "is_default": false, + "verified": true, + "auto_generated": false + }, + { + "id": "1234567", + "email": "john@acme.com", + "is_default": true, + "verified": true, + "auto_generated": false + } + ] + }] } ``` +### Sending addresses + +Fetching a single account also returns the account's email addresses, newest first. Only those +with `verified: true` can be used as a From address. Deleted addresses are not included. Listing +accounts does not return them. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
idA read-only Drip generated id used to identify the address.
emailThe email address.
is_defaultReturns true for the account's default From address, which emails without their own From address are sent from.
verifiedReturns true if Drip can send from this address: it is on a sending domain you have authenticated in Drip, or it is an address Drip generated for the account. Unverified addresses are listed, but cannot be used as a From address until their domain is authenticated.
auto_generatedReturns true for the no-reply address Drip creates for new accounts.
+ +`default_email_address_id` is `null` when the account has no default From address, or when +its default address has been deleted. A `null` value does not mean emails have no From +address: `default_from_email` still shows the address emails without their own From address +are sent from. + ### HTTP Endpoint `GET /v2/accounts/:account_id` diff --git a/source/includes/rest/_campaigns.md b/source/includes/rest/_campaigns.md index d1d82202491..b5d2695fa02 100644 --- a/source/includes/rest/_campaigns.md +++ b/source/includes/rest/_campaigns.md @@ -9,6 +9,7 @@ "name": "SEO Email Course", "from_name": "John Doe", "from_email": "john@example.com", + "reply_to": "support@example.com", "postal_address": "123 Anywhere St\nFresno, CA 99999", "minutes_from_midnight": 440, "localize_sending_time": true, @@ -75,6 +76,10 @@ from_email A "from email" that appears in your sent emails. This setting overrides the account's default from email. + + reply_to + The Reply-To address set on the Email Series Campaign, or null if none is set. When it is null, replies go to the From address. + postal_address As required by the CAN-SPAM Act, this is a postal address used for all sent emails.