Unlink Deal from Emails

Purpose

To manually unlink deals from emails.

Note

  • An email will only be linked to a single deal at a time.  When you call this API, the specified email(s) will be unlinked from them.
  • The user's profile requires "View" permission for Deals and Contacts modules to use this API.

Endpoints

  • DELETE /Contacts/{contacts_records_ID}/Emails/actions/link_record?owner_id={owner_ID}&message_ids={message_ID1},{message_ID2},..
  • DELETE /Contacts/{contacts_records_ID}/Emails/{message_id}/actions/link_record?owner_id={owner_ID}

Request Details

Request URL

To unlink a deal from multiple emails:

{api-domain}/crm/{version}/Contacts/{contacts_record_ID}/Emails/actions/link_record?owner_id={owner_ID}&message_ids={message_ID1},{message_ID2},..
To unlink a deal from a single email:
{api-domain}/crm/{version}/Contacts/{contacts_records_ID}/Emails/{message_id}/actions/link_record?owner_id={owner_ID}

Header

Authorization: Zoho-oauthtokend92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.modules.emails.ALL
(and)
ZohoCRM.modules.contacts.ALL

Parameters

  • owner_idstring, mandatory

    Specify the unique ID of a user whose email you want to unlink.

  • message_idsstring, mandatory when multiple emails are unlinked

    Specify the unique message IDs of the emails which you want to unlink. You can obtain message IDs of a record through Get Emails of a Record API.

    Possible values: Multiple message IDs in a comma separated format. 

Sample Request to unlink multiple emails

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/5843104000000425349/Emails/actions/link_record?owner_id=5843104000000424672&message_ids=8937fb892cc6f15b95bc22ecb91b6f85e9f60916ef9314d484543df546f09ad1,6622e532084a2c329b44f4d7c58a93bb2f616d21e1e73cc1e9cc71d24ef6b5f5"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE

Possible Errors

  • FEATURE_NOT_SUPPORTEDHTTP 400

    Your License does not support this feature.
    Resolution: This API is supported for Zoho CRM editions Standard and above. Upgrade your edition or contact support@zohocrm.com.

  • API_NOT_SUPPORTEDHTTP 400

    The API is not supported in this version.
    Resolution: This API is supported only from Version 8.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    The access token you have used to make this API call does not have the required scope.
    Resolution: The client does not have a valid scope to unlink deals. Create a new token with valid scope. Refer to the Scope section.

  • AUTHENTICATION_FAILUREHTTP 401

    Authentication failed.
    Resolution: Pass the access token in the request header of the API call.

  • NO_PERMISSIONHTTP 403

    Permission denied
    Resolution: Contact your administrator to update profile permissions for your profile through Update Profile Permissions API for Crm_Implied_View_Deals and Crm_Implied_View_Contacts permissions.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one.
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the Request URL section.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error.
    Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response when a contact is unlinked from multiple emails

Copied{
    "Emails": [
        {
            "code": "SUCCESS",
            "details": {
                "message_id": "8937fb892cc6f15b95bc22ecb91b6f85e9f60916ef9314d484543df546f09ad1"
            },
            "message": "email has been unlinked from the deal successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "message_id": "6622e532084a2c329b44f4d7c58a93bb2f616d21e1e73cc1e9cc71d24ef6b5f5"
            },
            "message": "email has been unlinked from the deal successfully",
            "status": "success"
        }
    ]
}

Sample Request when a contact is unlinked from a single email

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/5843104000000425349/Emails/8937fb892cc6f15b95bc22ecb91b6f85e9f60916ef9314d484543df546f09ad1/actions/link_record?owner_id=5843104000000424672"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE

Sample Response when a contact is unlinked from a single email

Copied{
    "Emails": [
        {
            "code": "SUCCESS",
            "details": {
                "message_id": "8937fb892cc6f15b95bc22ecb91b6f85e9f60916ef9314d484543df546f09ad1"
            },
            "message": "email has been unlinked from the deal successfully",
            "status": "success"
        }
    ]
}