Get configured from-addresses

Overview

The Email API allows you to programmatically manage the email sending task within Bigin. By configuring email settings in your account, you can send emails directly from Bigin to the email addresses associated with your records. These APIs enable you to obtain a list of configured from addresses and send emails to communicate with your deals, contacts, or other entities directly from your Bigin account.

When sending emails, the available sender addresses depend on your email configuration:

Use primary email or organization's email addresses if you have not configured email settings.
Use configured email addresses, email aliases and organization's email address if you have set up IMAP, Gmail, Microsoft 365, Outlook Mail or other mail integrations.

GET /settings/emails/actions/from_addresses

Get configured from-addresses

Retrieve from_addresses that you have configured for sending emails. This allows you to select the appropriate sender address when sending emails through the send email API.

Request URL

{api-domain}/bigin/v2/settings/emails/actions/from_addresses

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with the following scope:

ZohoBigin.settings.emails.READ

Request parameters

The request parameters aren't available for this endpoint.

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/emails/actions/from_addresses" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response object

The response object contains the following details:

display_value string

Indicates the display value of the allowed sender's email address.

type string

Indicates the type of the email address. For example, primary or org_email or imap.

email string

Indicates the actual value of the allowed sender's email address.

Possible error codes

The response of this resource includes HTTP status and error codes.

Sample response

Copied{
    "from_address": [
        {
            "display_value": "patricia.boyle@zylker.com",
            "type": "My Email",
            "email": "patricia.boyle@zylker.com"
        }
    ]
}