Get User Signature

Purpose

This API is used to list all available signatures when no specific signature ID is provided. It will retrieve specific signature details when provided with a signature ID.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to the accounts

READ - Get user signatures.

Request URL

Method: GET

https://mail.zoho.com/api/accounts/signature

Query Parameters

id long
- This is a unique key used to identify the specific signature.

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request When Signature ID is Passed

Copiedcurl "https://mail.zoho.com/api/accounts/signature?id=2442552000000167007" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***"

Sample Success Response When Signature ID is Passed

Copied{
   "status": {
      "code": 200,
      "description": "success"
   },
   "data": {
      "contactId": "70847000000002131",
      "name": " By Rebecca",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000167007",
      "position": 1,
      "content": "Signature Content"
   }
}

Sample Success Response When Signature ID is Not Passed

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "contactId": "70847000000002131",
      "name": " By Rebecca",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000167007",
      "position": 1,
      "content": "<img src=\"/zm/ImageSignature?fileName=TestImg.jpg&amp;accountId=2442552000000005002&amp;storeName=74584464&amp;frm=s&amp;fileId=5eab18ba60021fc9d1654\" style=\"\" width=\"207\" height=\"137\" /><br /><br /><br />Check now<br /><div><br /></div><div>dsfsf1212121<br /></div>"
    },
    {
      "contactId": "70847000000113001",
      "name": "mail case testing",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000168003",
      "position": 1,
      "content": "<div><img src=\"/zm/ImageSignature?fileName=vinaystwist.png&amp;accountId=2442552000000005002&amp;storeName=74584464&amp;frm=s&amp;fileId=bc1d32960021f5d0a3a0\" width=\"143\" height=\"178\" style=\"\" />Solve<br /><br /></div>"
    },
    {
      "name": "emoji addn 2xb",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000170001",
      "position": 1,
      "content": "    <meta />     <body>   <h1>Unicode Example</h1>      <p>This paragraph contains some Unicode characters:</p>      <p>"
    },
    {
      "name": "tester",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000231001",
      "position": 1,
      "content": "Content"
    },
    {
      "contactId": "70847000000002279",
      "name": "vcard signature 2",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000259002",
      "position": 1,
      "content": "<div>tester content vcard sjnbdsvsdgdd<br /></div>"
    },
    {
      "contactId": "176000000196021",
      "name": "test contacts",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000276001",
      "position": 1,
      "content": "<div>contacts test</div>"
    },
    {
      "contactId": "70847000000258011",
      "name": "vcard signature 23",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000324002",
      "position": 1,
      "content": "tester content for vcf"
    },
    {
      "name": "testet",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000337001",
      "position": 1,
      "content": "<div>testing<br /></div>"
    },
    {
      "name": "Paula - Rest API Testing",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000396001",
      "position": 0,
      "content": "<div>Content Testing Further</div>"
    },
    {
      "contactId": "70847000000329007",
      "name": "Paula - Rest API",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000397001",
      "position": 1,
      "content": "<div>Content Testing Further</div>"
    },
    {
      "name": "Paula - Rest API New",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000433001",
      "position": 0,
      "content": "<div>Content Testing</div>"
    },
    {
      "name": "New Signature",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000433003",
      "position": 0,
      "content": "Regards, John."
    },
    {
      "name": "New Signature 2",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000433007",
      "position": 0,
      "content": "Regards, John."
    },
    {
      "name": "Paula - Rest API",
      "signatureType": "USER_SIGNATURE",
      "id": "2442552000000433009",
      "position": 1,
      "content": "<div>Content Testing Further</div>"
    }
  ]
}

Sample Failure Response

Copied{
  "status": {
    "code": 500,
    "description": "Internal Error"
  },
  "data": {
    "moreInfo": "The input passed is invalid"
  }
}