> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Unsubscribe Links Get Unsubscribe Links

> List the email unsubscribe links set up in your Zoho CRM account. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the email unsubscribe links set up in your Zoho CRM account.

> [!NOTE]
>
> Tool ID: `zoho_crm_unsubscribe_links_get_unsubscribe_links`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_unsubscribe_links_get_unsubscribe_links',
  {},
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_unsubscribe_links_get_unsubscribe_links --input '{}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "unsubscribe_links": [
      {
        "created_time": "example",
        "submission_message": "example",
        "modified_time": "example",
        "submission_redirect_url": "https://example.com",
        "page_type": "example",
        "custom_location_url": "https://example.com",
        "modified_by": {
          "name": "Example",
          "id": "id_123"
        },
        "name": "Example",
        "id": "id_123",
        "created_by": {
          "name": "Example",
          "id": "id_123"
        },
        "standard_page_message": null,
        "submission_action_type": "example"
      }
    ]
  }
}
```

Use `deepline describe zoho_crm_unsubscribe_links_get_unsubscribe_links --json` for the latest machine-readable contract.

## Input reference

To get all unsubscribe links

This action requires no input fields.

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To get all unsubscribe links",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Envelope containing a collection of unsubscribe link records returned by the settings listing endpoint. |
| `result.data.unsubscribe_links` | `array` | Yes | — | Field: unsubscribe\_links Maximum items: 1. |
| `result.data.unsubscribe_links[].created_time` | `string` | Yes | — | Field: created\_time Maximum length: 255. |
| `result.data.unsubscribe_links[].submission_message` | `string` | Yes | — | Field: submission\_message Maximum length: 255. |
| `result.data.unsubscribe_links[].modified_time` | `string` | Yes | — | Field: modified\_time Maximum length: 255. |
| `result.data.unsubscribe_links[].submission_redirect_url` | `string` | Yes | — | Field: submission\_redirect\_url Maximum length: 255. |
| `result.data.unsubscribe_links[].page_type` | `string` | Yes | — | Field: page\_type Maximum length: 255. |
| `result.data.unsubscribe_links[].custom_location_url` | `string` | Yes | — | Field: custom\_location\_url Maximum length: 255. |
| `result.data.unsubscribe_links[].modified_by` | `object` | Yes | — | User who last modified the unsubscribe link, including name and id. |
| `result.data.unsubscribe_links[].modified_by.name` | `string` | Yes | — | Field: name Maximum length: 255. |
| `result.data.unsubscribe_links[].modified_by.id` | `string` | Yes | — | Field: id Maximum length: 255. |
| `result.data.unsubscribe_links[].name` | `string` | Yes | — | Field: name Maximum length: 255. |
| `result.data.unsubscribe_links[].id` | `string` | Yes | — | Field: id Maximum length: 255. |
| `result.data.unsubscribe_links[].created_by` | `object` | Yes | — | User who created the unsubscribe link, including name and id. |
| `result.data.unsubscribe_links[].created_by.name` | `string` | Yes | — | Field: name Maximum length: 255. |
| `result.data.unsubscribe_links[].created_by.id` | `string` | Yes | — | Field: id Maximum length: 255. |
| `result.data.unsubscribe_links[].standard_page_message` | `null` | Yes | — | Field: standard\_page\_message |
| `result.data.unsubscribe_links[].submission_action_type` | `string` | Yes | — | Field: submission\_action\_type Maximum length: 255. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Envelope containing a collection of unsubscribe link records returned by the settings listing endpoint.",
        "properties": {
          "unsubscribe_links": {
            "type": "array",
            "description": "Field: unsubscribe_links",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Summarized unsubscribe link configuration with timestamps, page settings, submission behavior, and creator/modifier references as returned by the listing endpoint.",
              "properties": {
                "created_time": {
                  "type": "string",
                  "description": "Field: created_time",
                  "maxLength": 255
                },
                "submission_message": {
                  "type": "string",
                  "description": "Field: submission_message",
                  "maxLength": 255
                },
                "modified_time": {
                  "type": "string",
                  "description": "Field: modified_time",
                  "maxLength": 255
                },
                "submission_redirect_url": {
                  "type": "string",
                  "description": "Field: submission_redirect_url",
                  "maxLength": 255
                },
                "page_type": {
                  "type": "string",
                  "description": "Field: page_type",
                  "maxLength": 255
                },
                "custom_location_url": {
                  "type": "string",
                  "description": "Field: custom_location_url",
                  "maxLength": 255
                },
                "modified_by": {
                  "type": "object",
                  "description": "User who last modified the unsubscribe link, including name and id.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "name": {
                  "type": "string",
                  "description": "Field: name",
                  "maxLength": 255
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 255
                },
                "created_by": {
                  "type": "object",
                  "description": "User who created the unsubscribe link, including name and id.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "standard_page_message": {
                  "type": "null",
                  "description": "Field: standard_page_message"
                },
                "submission_action_type": {
                  "type": "string",
                  "description": "Field: submission_action_type",
                  "maxLength": 255
                }
              },
              "required": [
                "created_by",
                "created_time",
                "custom_location_url",
                "id",
                "modified_by",
                "modified_time",
                "name",
                "page_type",
                "standard_page_message",
                "submission_action_type",
                "submission_message",
                "submission_redirect_url"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "unsubscribe_links"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.