Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Agent API

The Agent API from Zoho — 15 operation(s) for agent.

Zoho Agent API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agent. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 18 operations across 15 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

18 operations 15 paths 12 schemas 7 GET2 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho Agent API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 18

Across 15 paths, the API surfaces 18 operations — 7 GET, 2 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Agent 18
GET
/api/v1/myPreferences
Get My Preferences
getMyPreference 1 param → 200
PATCH
/api/v1/myPreferences
Update My Preferences
updateMyPreferences 1 param body → 422204
POST
/api/v1/uploadMyPhoto
Upload my photo
uploadMyPhoto 1 param body → 422200
POST
/api/v1/agents/{agentId}/reassignment
Schedule reassignment for deactivated or deleted agents
scheduleAgentReassignment 2 params body → 422204
GET
/api/v1/agentsByIds
Get agent details by agentId
getAgentsByIds 2 params → 422200
GET
/api/v1/agents/{agentId}/photo
Get agent photo
getAgentProfilePhoto 3 params → 200
POST
/api/v1/agents/activate
Activate agents
activateAgents 1 param body → 422204403
POST
/api/v1/deletedAgents/{agentId}/anonymize
Anonymize deleted agent
anonymizeDeletedAgent 2 params body → 204
GET
/api/v1/agents
List agents
getAgents 11 params → 204200
POST
/api/v1/agents
Add agent
addAgent 1 param body → 422200
GET
/api/v1/myinfo
Get My Information
getMyInfo 2 params → 200
GET
/api/v1/agents/{agentId}
Get agent
getAgent 3 params → 200
PATCH
/api/v1/agents/{agentId}
Update agent
updateAgent 2 params body → 200422403
POST
/api/v1/agents/{agentId}/deactivate
Deactivate agent
deactivateAgents 2 params → 204
POST
/api/v1/deleteMyPhoto
Delete My Photo
deleteMyPhoto 1 param → 204
POST
/api/v1/agents/deleteUnconfirmed
Delete unconfirmed agents
deleteUnconfirmedAgent 1 param body → 422204
GET
/api/v1/agents/count
Get agents count
getAgentsCount 4 params → 200
POST
/api/v1/agents/reinvite
Reinvite unconfirmed agents
reInviteAgents 1 param body → 422204

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are agentIdsResponse (18 properties), addAgentInputStream (15 properties), newReassignOwner (3 properties), myPreferenceInputStrm (2 properties). Each schema is shown below with its type and property counts.

myPreferenceInputStrm
nullobject
2 properties 2 required
agentIdsResponseArray
nullarray
agentIdsCFResponse
agentCFResponse
agentResponse
agentResponseArray
nullarray
newReassignOwner
nullobject
3 properties 3 required
agentIdsResponse
nullobject
18 properties 17 required
addAgentInputStream
nullobject
15 properties 15 required
scheduleReassignmentArray
nullarray
agentCFInputStream
agentInputStream

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-agent-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ