Zoho: Unsubscribe links schemas
25 Zoho schemas with complete fields and constraints.
← Unsubscribe links operations · All schemas
Create Unsubscribe Link — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request payload to create one or more unsubscribe links. Additional keys: not allowed |
unsubscribe_links | array | Required within parent | Array containing the unsubscribe link configuration to create (required) Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Create Unsubscribe Link — request body — body unsubscribe links item |
Referenced models: Create Unsubscribe Link — request body — body unsubscribe links item
Create Unsubscribe Link — request body — body unsubscribe links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the fields required to create an unsubscribe link. The **name**, **page_type**, and **submission_action_type** fields are mandatory. |
$ (allOf 1) | Model | All variants apply | Expand Create Unsubscribe Link — request body — body unsubscribe links item custom location url, id, name, page type, standard page message, submission action type, submission message, submission redirect url |
$ (allOf 2) | object | All variants apply | Required fields for creating an unsubscribe link Additional keys: allowed |
Create Unsubscribe Link — request body — body unsubscribe links item custom location url, id, name, page type, standard page message, submission action type, submission message, submission redirect url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the base fields for unsubscribe link configuration Additional keys: allowed |
custom_location_url | string | Optional | Represents the custom webpage URL for hosting the unsubscribe link. Required when page_type is custom. Required when page_type is custom. Required when page_type is custom. Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the unsubscribe link Maximum length: 19 |
name | string | Optional | Represents the unique name for the unsubscribe link Maximum length: 255 |
page_type | string | Optional | Specifies where the unsubscribe page is hosted: standard (Zoho CRM page) or custom (your own webpage) Maximum length: 255 |
standard_page_message | string | Optional | The message displayed on the standard unsubscribe page. Can be rich text (HTML) or plain text. Maximum length: 2000 |
submission_action_type | string | Optional | The action after unsubscribe: display_message (show a message) or redirect (redirect to a URL) Maximum length: 255 |
submission_message | string | Optional | Represents the message displayed when the user clicks the unsubscribe button. Required when submission_action_type is display_message. unsubscribe button. Required when submission_action_type is display_message. Maximum length: 2000 |
submission_redirect_url | string | Optional | Represents the URL to redirect users to after unsubscribing. Required when submission_action_type is redirect. Required when submission_action_type is redirect. Maximum length: 255 |
Create Unsubscribe Link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Success response for a POST request that returns the action status of each newly created unsubscribe link. Additional keys: not allowed |
unsubscribe_links | array | Optional | Array containing the status of the creation operation for each link Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Create Unsubscribe Link — response body — unsubscribe links item |
Referenced models: Create Unsubscribe Link — response body — unsubscribe links item
Create Unsubscribe Link — response body — unsubscribe links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Status of an unsubscribe link operation, including the outcome code, message, status, and the affected entity reference. Additional keys: not allowed |
code | string | Optional | The result code (SUCCESS or error code) Maximum length: 255 |
details | Model | Optional | Expand Create Unsubscribe Link — response body — unsubscribe links item details |
message | string | Optional | Represents the message describing the operation result. Maximum length: 255 |
status | string | Optional | The status of the operation (success or error) Maximum length: 255 |
Referenced models: Create Unsubscribe Link — response body — unsubscribe links item details
Create Unsubscribe Link — response body — unsubscribe links item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to the entity affected by an operation, containing its unique identifier. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier for an unsubscribe link. The unique identifier of the affected unsubscribe link Maximum length: 19 |
Delete Unsubscribe Link by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Collection of action status objects produced after deleting unsubscribe links via DELETE requests. Additional keys: not allowed |
unsubscribe_links | array | Optional | Array containing the status of the delete operation for each link Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Create Unsubscribe Link — response body — unsubscribe links item |
Referenced models: Create Unsubscribe Link — response body — unsubscribe links item
Get Unsubscribe Link Associations — response body — associations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing the list of places where unsubscribe links are currently associated in the Zoho CRM organization. Additional keys: not allowed |
associations | array | Required within parent | Array of association records showing where unsubscribe links are being used Maximum items: 1 |
associations[] | Model | Each item | Expand Get Unsubscribe Link Associations — response body — associations associations item |
Referenced models: Get Unsubscribe Link Associations — response body — associations associations item
Get Unsubscribe Link Associations — response body — associations associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Association record that groups the associated places under a specific unsubscribe link ID. Additional keys: not allowed |
associated_places | array | Required within parent | List of places where this unsubscribe link is being used Maximum items: 1 |
associated_places[] | Model | Each item | Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item |
id | string | Required within parent | Represents the unique identifier for an unsubscribe link. The unique identifier of the unsubscribe link Maximum length: 19 |
Referenced models: Get Unsubscribe Link Associations — response body — associations associations item associated places item
Get Unsubscribe Link Associations — response body — associations associations item associated places item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A place where the unsubscribe link is associated, including the linked resource, module details, and association type. Additional keys: not allowed |
details | Model | Required within parent | Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item details |
resource | Model | Required within parent | Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item resource |
type | string | Required within parent | The type of associated place (e.g., email_templates) Maximum length: 255 |
Referenced models: Get Unsubscribe Link Associations — response body — associations associations item associated places item details, Get Unsubscribe Link Associations — response body — associations associations item associated places item resource
Get Unsubscribe Link Associations — response body — associations associations item associated places item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details for an unsubscribe link association, including the associated module context. Additional keys: not allowed |
module | Model | Required within parent | Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item details module |
Referenced models: Get Unsubscribe Link Associations — response body — associations associations item associated places item details module
Get Unsubscribe Link Associations — response body — associations associations item associated places item details module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the module information associated with an unsubscribe link, including the module API name and ID. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the CRM module associated with the unsubscribe link. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the CRM module associated with the unsubscribe link. Maximum length: 19 |
Get Unsubscribe Link Associations — response body — associations associations item associated places item resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the resource associated with an unsubscribe link, including its name and unique identifier. Additional keys: not allowed |
id | string | Required within parent | The unique identifier of the associated resource Maximum length: 19 |
name | string | Required within parent | The name of the associated resource Maximum length: 255 |
Get Unsubscribe Link by ID — response body — unsubscribe links
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response payload containing the unsubscribe link records returned by the GET by ID endpoint. Additional keys: not allowed |
unsubscribe_links | array | Required within parent | Array containing the requested unsubscribe link details Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Get Unsubscribe Link by ID — response body — unsubscribe links unsubscribe links item |
Referenced models: Get Unsubscribe Link by ID — response body — unsubscribe links unsubscribe links item
Get Unsubscribe Link by ID — response body — unsubscribe links unsubscribe links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Full unsubscribe link configuration including display messages, submission behavior, audit information, and creator or modifier details. Additional keys: not allowed |
created_by | Model | Required within parent | Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by |
created_time | string | Required within parent | The date and time when the unsubscribe link was created Maximum length: 255 |
custom_location_url | null | Required within parent | The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard. |
id | string | Required within parent | Represents the unique identifier for an unsubscribe link. The unique identifier of the unsubscribe link Maximum length: 19 |
modified_by | Model | Required within parent | Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by |
modified_time | string | Required within parent | The date and time when the unsubscribe link was last modified Maximum length: 255 |
name | string | Required within parent | The unique name of the unsubscribe link Maximum length: 255 |
page_type | string | Required within parent | Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom) Maximum length: 255 |
standard_page_message | string | Required within parent | The message displayed on the standard unsubscribe page Maximum length: 2000 |
submission_action_type | string | Required within parent | The action performed after unsubscribe: display_message (show a message) or redirect (redirect to a URL) Maximum length: 255 |
submission_message | string | Required within parent | The message displayed when the user clicks the unsubscribe button (for display_message action type) Maximum length: 2000 |
submission_redirect_url | null | Required within parent | The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured. |
Referenced models: Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by, Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by
Get Unsubscribe Links — response body — unsubscribe links
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response envelope containing a collection of unsubscribe link records returned by the settings listing endpoint. Additional keys: not allowed |
unsubscribe_links | array | Required within parent | Array of unsubscribe link summary records Maximum items: 10 |
unsubscribe_links[] | Model | Each item | Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item |
Referenced models: Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item
Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Summarized unsubscribe link configuration with timestamps, page settings, submission behavior, and creator or modifier references as returned by the listing endpoint. Additional keys: not allowed |
created_by | Model | Required within parent | Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by |
created_time | string | Required within parent | The date and time when the unsubscribe link was created Maximum length: 255 |
custom_location_url | JSON | Required within parent | |
custom_location_url (anyOf 1) | string | Alternative | The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard. Maximum length: 255 |
custom_location_url (anyOf 2) | null | Alternative | The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier for an unsubscribe link. The unique identifier of the unsubscribe link Maximum length: 19 |
modified_by | Model | Required within parent | Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by |
modified_time | string | Required within parent | The date and time when the unsubscribe link was last modified Maximum length: 255 |
name | string | Required within parent | Represents the unique name of the unsubscribe link Maximum length: 255 |
page_type | JSON | Required within parent | |
page_type (anyOf 1) | string | Alternative | Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom) Maximum length: 255 |
page_type (anyOf 2) | null | Alternative | Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom) Maximum length: 255 |
standard_page_message | JSON | Required within parent | |
standard_page_message (anyOf 1) | string | Alternative | Represents the message displayed on the standard unsubscribe page. Null if page_type is custom. Null if page_type is custom. Maximum length: 2000 |
standard_page_message (anyOf 2) | null | Alternative | Represents the message displayed on the standard unsubscribe page. Null if page_type is custom. Null if page_type is custom. Maximum length: 2000 |
submission_action_type | string | Required within parent | Represents the action performed after unsubscribe display_message (show a message) or redirect (redirect to a URL) a message) or redirect (redirect to a URL) a message) or redirect (redirect to a URL)" Maximum length: 255 |
submission_message | JSON | Required within parent | |
submission_message (anyOf 1) | string | Alternative | The message displayed when the user clicks the unsubscribe button (for display_message action type). Null if not configured. Maximum length: 2000 |
submission_message (anyOf 2) | null | Alternative | The message displayed when the user clicks the unsubscribe button (for display_message action type). Null if not configured. Maximum length: 2000 |
submission_redirect_url | JSON | Required within parent | |
submission_redirect_url (anyOf 1) | string | Alternative | The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured. Maximum length: 255 |
submission_redirect_url (anyOf 2) | null | Alternative | The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured. Maximum length: 255 |
Referenced models: Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by, Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by
Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | User who created the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed |
$ (anyOf 1).id | string | Required within parent | Represents the unique identifier of the user who created the unsubscribe link unsubscribe link Maximum length: 19 |
$ (anyOf 1).name | string | Required within parent | Represents the name of the user who created the unsubscribe link Maximum length: 255 |
$ (anyOf 2) | null | Alternative | User who created the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed |
$ (anyOf 2).id | string | Required within parent | Represents the unique identifier of the user who created the unsubscribe link unsubscribe link Maximum length: 19 |
$ (anyOf 2).name | string | Required within parent | Represents the name of the user who created the unsubscribe link Maximum length: 255 |
Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | User who last modified the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed |
$ (anyOf 1).id | string | Required within parent | Represents the unique identifier of the user who last modified the unsubscribe link unsubscribe link Maximum length: 19 |
$ (anyOf 1).name | string | Required within parent | Represents the name of the user who last modified the unsubscribe link link Maximum length: 255 |
$ (anyOf 2) | null | Alternative | User who last modified the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed |
$ (anyOf 2).id | string | Required within parent | Represents the unique identifier of the user who last modified the unsubscribe link unsubscribe link Maximum length: 19 |
$ (anyOf 2).name | string | Required within parent | Represents the name of the user who last modified the unsubscribe link link Maximum length: 255 |
Update Unsubscribe Link by ID — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request payload to update an unsubscribe link identified by its ID. Additional keys: not allowed |
unsubscribe_links | array | Required within parent | Array containing the unsubscribe link configuration to update (required) Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Update Unsubscribe Link by ID — request body — body unsubscribe links item |
Referenced models: Update Unsubscribe Link by ID — request body — body unsubscribe links item
Update Unsubscribe Link by ID — request body — body unsubscribe links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the fields required to update a single unsubscribe link. The **id** field in the request body must match the ID in the path. |
$ (allOf 1) | Model | All variants apply | Expand Create Unsubscribe Link — request body — body unsubscribe links item custom location url, id, name, page type, standard page message, submission action type, submission message, submission redirect url |
$ (allOf 2) | object | All variants apply | Required fields for updating a single unsubscribe link. The id field is mandatory to identify which link to update. Additional keys: allowed |
Update Unsubscribe Link by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Success response for a PUT request that returns the action status of each updated unsubscribe link. Additional keys: not allowed |
unsubscribe_links | array | Optional | Array containing the status of the update operation for each link Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Create Unsubscribe Link — response body — unsubscribe links item |
Referenced models: Create Unsubscribe Link — response body — unsubscribe links item
Update Unsubscribe Links — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request payload for bulk PUT requests to update unsubscribe link configurations. Additional keys: not allowed |
unsubscribe_links | array | Required within parent | Root key containing the unsubscribe links to update (required) Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Update Unsubscribe Links — request body — body unsubscribe links item |
Referenced models: Update Unsubscribe Links — request body — body unsubscribe links item
Update Unsubscribe Links — request body — body unsubscribe links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the fields required for a bulk update of unsubscribe links. The **id** field is mandatory for each update entry. |
$ (allOf 1) | Model | All variants apply | Expand Create Unsubscribe Link — request body — body unsubscribe links item custom location url, id, name, page type, standard page message, submission action type, submission message, submission redirect url |
$ (allOf 2) | object | All variants apply | Required fields for bulk update operation. The id field is mandatory to identify which link to update. Additional keys: allowed |
Update Unsubscribe Links — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Collection of action status objects produced after modifying unsubscribe links via PUT requests. Additional keys: not allowed |
unsubscribe_links | array | Optional | Array containing the status of the modification operation for each link Maximum items: 1 |
unsubscribe_links[] | Model | Each item | Expand Create Unsubscribe Link — response body — unsubscribe links item |
Referenced models: Create Unsubscribe Link — response body — unsubscribe links item