Update Admin-Added User Signature

Purpose

This API enables administrators to update the admin-added signatures associated with a user account.

Note:

This API does not allow administrators to update organization-level signatures.

OAuth Scope

Use the scope

Use admin authentication:

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

to generate the Authtoken.

ALL - Full access to the accounts.

UPDATE - Update a user signature.

Request URL 

Method: PUT

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.

Request Body (JSON Object)

  • name* string
    • Specifies the name to be updated in the signature.
  • content* string
    • Specifies the content to be updated in the signature.
  • assignUsers JSON Array of string
    • Specifies the email addresses of the user to which this signature should be assigned.
    • The email addresses must be provided as a string array.
  • unassignUsers JSON Array of string
    • Specifies the email addresses of the user to which this signature should be unassigned.
    • The email addresses must be provided as a string array.
  • id* long
    • Specifies the unique key of the specific signature to be updated.
  • position* int
    • Specifies the preferred position of the updated signature.
    • The possible value can be
      • 0 - Place the signature below the quoted content.
      • 1 - Place the signature above the quoted content.

 

* - 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 PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *******************" \
-d '{
  "name": "Admin Added Signature",
  "content": "Regards, John.",
  "id": 20482000004714001,
  "position": 1
}'

Sample Success Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "name": "Admin Added Signature",
    "signatureType": "USER_SIGNATURE",
    "id": "20482000004714001",
    "position": 1,
    "content": "Regards, John."
  }
}

Sample Failure Response

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