Zoho Email Failure Alert API

The EmailFailureAlert API from Zoho — 1 operation(s) for emailfailurealert.

Operations 2

GET /api/v1/emailFailureAlerts List email delivery failure alerts #
PATCH /api/v1/emailFailureAlerts Clear email delivery failure alerts #

Documentation

Specifications

Code Examples

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zoho-emailfailurealert-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoho-emailfailurealert-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Helpcenter Email Failure Alert API
  version: 1.0.0
tags:
- name: EmailFailureAlert
paths:
  /api/v1/emailFailureAlerts:
    get:
      tags:
      - EmailFailureAlert
      summary: List email delivery failure alerts
      description: This API lists the email delivery failure alerts configured in a particular department.
      operationId: getEmailFailureAlerts
      parameters:
      - name: limit
        in: query
        description: Number of alerts to list
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int32
          description: Number of alerts to list
          pattern: ([0-9]+)
      - name: from
        in: query
        description: Index number, starting from which the alerts must be listed
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int32
          description: Index number, starting from which the alerts must be listed
          pattern: ([0-9]+)
      - $ref: '#/components/parameters/department'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '200':
          $ref: '#/components/responses/getEmailFailureResponse'
      security:
      - iam-oauth2-schema:
        - Desk.tickets.READ
      x-audience:
      - external-public
    patch:
      tags:
      - EmailFailureAlert
      summary: Clear email delivery failure alerts
      description: This API deletes all email delivery failure alerts configured in a particular department.
      operationId: clearEmailFailureAlerts
      parameters:
      - $ref: '#/components/parameters/department'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '204':
          $ref: ./Common.json#/components/responses/emptyResponse
      security:
      - iam-oauth2-schema:
        - Desk.tickets.UPDATE
      x-audience:
      - external-public
components:
  responses:
    getEmailFailureResponse:
      description: getEmailFailureResponse template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              data:
                $ref: ./EmailFailureAlert.json#/components/schemas/emailFailureAlertsArray
            required:
            - data
          examples:
            Valid responses Definitions:
              value:
                data:
                - departmentName: Sales
                  threadId: '4000002350527'
                  ticketNumber: '102'
                  reason: 452 4.3.1 Temporary System Error
                  subject: zPhone not working
                  departmentId: '4000000019077'
                  channel: EMAIL
                  errorMessage: Error while processing the request! Unable to send message;
                  assignee:
                    firstName: John
                    lastName: Carol
                    photoURL: https://desk.zoho.com/api/v1/agents/1892000000056007/photo
                    id: '1892000000056007'
                    email: carol@zylker.com
                  ticketId: '4000000014345'
                - departmentName: Marketing
                  threadId: '4000002353427'
                  ticketNumber: '102'
                  reason: Email reply failed from being sent! Momentary issues with the mail server, Try resending this email again.
                  subject: zPhone not working
                  departmentId: '4000000019067'
                  channel: TWITTER
                  errorMessage: 'null'
                  assignee:
                    firstName: John
                    lastName: Carol
                    photoURL: https://desk.zoho.com/api/v1/agents/1892000000056007/photo
                    id: '1892000000056007'
                    email: carol@zylker.com
                  ticketId: '4000000014335'
  parameters:
    department:
      name: department
      in: query
      description: ID of the department from which the email delivery failure alerts must be fetched. You can pass a specific department ID or @allDepartment@ in the API request.
      required: true
      style: form
      explode: true
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        description: ID of the department from which the email delivery failure alerts must be fetched. You can pass a specific department ID or @allDepartment@ in the API request.
        pattern: ([0-9]+)
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter