Zoho CRM From Addresses

To get the list of email addresses that you can send emails from. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 1 operation(s).

OpenAPI Specification

zoho-crm-from-addresses-openapi.json Raw ↑
{
  "openapi": "3.1.0",
  "info": {
    "title": "From Addresses",
    "description": "To get the list of email addresses that you can send emails from",
    "version": "8"
  },
  "servers": [
    {
      "url": "https://zohoapis.{dc}/crm/{version}",
      "description": "API Server URL",
      "variables": {
        "dc": {
          "description": "API Server URL TLD",
          "default": "com",
          "enum": [
            "eu",
            "com",
            "au",
            "in",
            "jp",
            "cn",
            "ca"
          ]
        },
        "version": {
          "description": "API Version",
          "default": "v8"
        }
      }
    }
  ],
  "security": [
    {
      "iam-oauth2-schema": [
        "ZohoCRM.settings.emails.READ"
      ]
    }
  ],
  "paths": {
    "/settings/emails/actions/from_addresses": {
      "get": {
        "summary": "Get From Addresses",
        "description": "Get the list of email addresses that you can send emails from.",
        "operationId": "getAddresses",
        "responses": {
          "200": {
            "description": "Successfully retrieved the list of from addresses.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Response object for getting from addresses",
                  "additionalProperties": false,
                  "properties": {
                    "from_addresses": {
                      "type": "array",
                      "description": "List of from addresses",
                      "maxItems": 200,
                      "items": {
                        "type": "object",
                        "description": "From Address details",
                        "additionalProperties": false,
                        "properties": {
                          "email": {
                            "type": "string",
                            "maxLength": 254,
                            "pattern": "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}",
                            "description": "Email address"
                          },
                          "type": {
                            "type": "string",
                            "maxLength": 32,
                            "description": "Type of from address"
                          },
                          "user_name": {
                            "type": "string",
                            "maxLength": 256,
                            "description": "User name associated with the from address"
                          },
                          "id": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "pattern": "[0-9]+",
                            "description": "Unique identifier for the from address"
                          },
                          "default": {
                            "type": "boolean",
                            "description": "Indicates if this is the default from address"
                          }
                        },
                        "required": [
                          "email",
                          "type",
                          "user_name",
                          "default"
                        ]
                      }
                    }
                  },
                  "required": [
                    "from_addresses"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid parameters",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Error response object",
                  "additionalProperties": false,
                  "properties": {
                    "code": {
                      "type": "string",
                      "description": "Error code",
                      "enum": [
                        "INVALID_DATA"
                      ]
                    },
                    "details": {
                      "type": "object",
                      "description": "Details about the error",
                      "additionalProperties": true,
                      "properties": {
                        "param_name": {
                          "type": "string",
                          "enum": [
                            "user_id"
                          ],
                          "description": "Name of the parameter that caused the error"
                        }
                      }
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "maxLength": 256
                    },
                    "status": {
                      "type": "string",
                      "description": "Status of the response",
                      "enum": [
                        "error"
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "iam-oauth2-schema": [
              "ZohoCRM.settings.emails.READ"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "iam-oauth2-schema": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
            "tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
            "refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
            "scopes": {
              "ZohoCRM.settings.emails.READ": "to fetch the list of from addresses allowed to send mail from"
            }
          }
        }
      }
    }
  }
}