Get Admin-Added User Signature

Purpose

This API is used to retrieve the signatures added by an administrator for a specific user account. It also fetches organization-level signatures available for that user account.

OAuth Scope

Use the scope

Use admin authentication:

ZohoMail.organization.accounts.ALL (or) ZohoMail.organization.accounts.READ

to generate the Authtoken.

ALL - Full access to the accounts.

READ - Read user signature.

Request URL 

Method: GET

https://mail.zoho.com/api/organization/{zoid}/accounts/{zuid}/signature

Path Parameters

  • zoid* long
    • This parameter denotes the unique identifier for the Zoho organization.
    • This value can be retrieved using the GET Organization Details API.
  • zuid* long
    • This parameter denotes the unique identifier for each user in an organization.
    • This value can be retrieved using the GET Org User Details API.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/accounts/2468013579/signature" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *******************"

Sample Success Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "name": "signature1",
      "signatureType": "USER_SIGNATURE",
      "id": "20482000004069019",
      "position": 1,
      "content": "Regards, Admin"
    },
    {
      "name": "signature2",
      "signatureType": "USER_SIGNATURE",
      "id": "20482000004069021",
      "position": 1,
      "content": "Regards, John"
    },
    {
      "name": "signature3",
      "signatureType": "USER_SIGNATURE",
      "id": "20482000004186001",
      "position": 0,
      "content": "Regards, UX team"
    },
    {
      "name": "signature4",
      "signatureType": "USER_SIGNATURE",
      "id": "20482000004542001",
      "position": 1,
      "content": "Master Signature"
    },
    {
      "name": "signature5",
      "signatureType": "ORG_SIGNATURE",
      "id": "53717594",
      "content": "Regards, Admin Team"
    }
  ]
}

Sample Failure Response

Copied{
  "status": {
    "code": 500,
    "description": "Oops! Something went wrong. Try again later"
  },
  "data": {
    "moreInfo": "INTERNAL_ERROR"
  }
}