Add Admin-Added User Signature

Purpose

This API enables administrators to add a signature to a user account.

Note:

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

OAuth Scope

Use the scope

Use admin authentication:

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

to generate the Authtoken.

ALL - Full access to the accounts.

CREATE - Create a user signature.

Request URL 

Method: POST

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 of the signature to be added.
  • content* string
    • Specifies the content of the signature.
  • assignUsers JSON Array of string
    • Specifies the email addresses of the user to which this signature should be added.
    • The email addresses must be provided as a string array.
  • position* int
    • Specifies the preferred position of the added 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 POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken **********************" \
-d '{
  "name": "Admin Added signature",
  "content": "Regards, John.",
  "position": 1
}'

Sample Success Response

Copied{
  "status": {
    "code": 201,
    "description": "Created"
  },
  "data": {
    "name": "Admin Added signature",
    "signatureType": "USER_SIGNATURE",
    "id": "20482000004713002",
    "position": 1,
    "content": "Regards, John."
  }
}

Sample Failure Response

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