Campaign and Lead Management API

https://www.zoho.com/marketingautomation/help/developers/v1
Admin
The project provides API documentation for managing marketing campaigns, leads, mailing lists, and...
Tokens:81,155
Snippets:1,211
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get All Lead Fields Request

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-all-leads-fields.html

This is a sample GET request to retrieve all lead fields. Ensure you include the 'type=json' parameter for a JSON response.

```http
https://marketingautomation.zoho.com/api/v1/lead/allfields?type=json
```

--------------------------------

### Sample Response for Total Leads

Source: https://www.zoho.com/marketingautomation/help/developers/v1/view-total-leads.html

This is an example of a successful response from the leadscount API, showing the number of leads in a list.

```json
{
"status": "success",
"code": "0",
"uri": "/api/v1/leadscount",
"no_of_leads": 2,
"version": "1"
}
```

--------------------------------

### Sample Request URL for Get Mailing Lists

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-mailing-lists.html

This is a sample URL to fetch mailing lists. It includes parameters for response format, sorting, and pagination.

```url
https://marketingautomation.zoho.com/api/v1/getmailinglists?resfmt=JSON&sort=[asc/desc]&fromindex=[number]&range=[number]
```

--------------------------------

### Sample Request URL for Add List and Leads

Source: https://www.zoho.com/marketingautomation/help/developers/v1/add-new-leads-list.html

This is a sample URL to add a new list and leads. Ensure you replace placeholder values like '[give ur list name]' with your actual data.

```http
https://marketingautomation.zoho.com/api/v1/addlistandleads?resfmt=JSON&listname=[give ur list name]&signupform=[public/private]&mode=newlist&listdescription=[give your list description]&emailids=[email addresses]
```

--------------------------------

### Sample Request URL for Get List Leads

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-list-leads.html

This is a sample URL to retrieve leads from a list. Ensure you replace placeholders like [listkey] with actual values. The parameters allow filtering and sorting of the lead data.

```http
https://marketingautomation.zoho.com/api/v1/getleads?resfmt=JSON&listkey=[listkey]&sort=[asc/desc]&fromindex=[number]&range=[number]&status=[active/recent/mostrecent/unsub/bounce]
```

--------------------------------

### Get Segment Leads API Request

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-segment-leads.html

This is a sample GET request URL to retrieve leads from a segment. Ensure you replace '[cvid]' with the actual mailing list ID.

```http
https://marketingautomation.zoho.com/api/v1/getsegmentleads?resfmt=JSON&cvid=[cvid]
```

--------------------------------

### Sample Success Response for Add List and Leads

Source: https://www.zoho.com/marketingautomation/help/developers/v1/add-new-leads-list.html

This is a sample JSON response indicating a successful addition of a list and leads. It includes a list key and other relevant details.

```json
{
"status": "success",
"listkey": "f70c4878c4a471691e3931dd52bedc79",
"code": "0",
"url": "/api/v1/addlistandleads",
"listname": "1issst1oo1deed88",
"version": "1"
}
```

--------------------------------

### Sample GET Request for Changing Coupon Status

Source: https://www.zoho.com/marketingautomation/help/developers/v1/change-coupon-status.html

This is a sample GET request URL to change the status of a coupon. Ensure you replace '[CouponCode]' with the actual coupon code.

```http
https://marketingautomation.zoho.com/api/v1/coupon/changestatus?type=json&changeStatus=used&couponCode=[CouponCode]
```

--------------------------------

### Sample Campaign Cloning Request

Source: https://www.zoho.com/marketingautomation/help/developers/v1/clone-campaign.html

This is a sample GET request to clone a campaign. Ensure you replace '[campaignkey]' with the actual campaign key and '[JSON]' with the desired response format.

```http
https://marketingautomation.zoho.com/api/json/clonecampaign?version=1&campaigninfo={"campaignname":"Sample1","subject":"Sample","oldcampaignkey":[campaignkey],"from_name":"John","from_add":"john.doe@xyz.com","reply_to":"john.doe@xyz.com","encode_type":"UTF-8"}&resfmt=[JSON]
```

--------------------------------

### getallLeadtags

Source: https://www.zoho.com/marketingautomation/help/developers/v1/list-management.html

To get the list of lead tags.

```APIDOC
## getallLeadtags

### Description
To get the list of lead tags.

### Method
GET

### Endpoint
/api/v1/tags

### Parameters
#### Query Parameters
- **authtoken** (string) - Required - Authentication Token.

### Response
#### Success Response (200)
- **tags** (array) - List of lead tags.
```

--------------------------------

### Sample Response for Get All Lead Tags

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-lead-tags.html

This sample response shows the structure of the data returned when successfully fetching lead tags. It includes tag details like owner, creation time, name, color, description, and count.

```json
{
    "uri": "/api/v1/tag/getalltags",
    "version": "1",
    "requestdetails": "{}",
    "tags": [
        {
            "16492000023685218": {
                "tagowner": "patricia",
                "tag_created_time": "07 Feb 2019, 12:33 PM",
                "tag_name": "interested",
                "tag_color": "#48b9d1",
                "tag_desc": "list of interested leads",
                "tagged_contact_count": "64",
                "is_crm_tag": "false",
                "zuid": "xxxxxx"
            }
        },
        {
            "16492000023685001": {
                "tagowner": "patricia",
                "tag_created_time": "07 Feb 2019, 11:25 AM",
                "tag_name": "event",
                "tag_color": "#ff458a",
                "tag_desc": "prospects gathered in event",
                "tagged_contact_count": "171",
                "is_crm_tag": "false",
                "zuid": "xxxxxxx"
            }
        },
        {
            "16492000005417003": {
                "tagowner": "joel",
                "tag_created_time": "06 Dec 2018, 07:41 PM",
                "tag_name": "online",
                "tag_color": "#ff458a",
                "tag_desc": "leads signup online",
                "tagged_contact_count": "29",
                "is_crm_tag": "false",
                "zuid": "55216673"
            }
        }
        
                     ]
}
```

--------------------------------

### getlistleads

Source: https://www.zoho.com/marketingautomation/help/developers/v1/list-management.html

To get the leads based on status.

```APIDOC
## getlistleads

### Description
To get the leads based on status.

### Method
GET

### Endpoint
/api/v1/lists/{listId}/leads

### Parameters
#### Path Parameters
- **listId** (string) - Required - The ID of the mailing list.
#### Query Parameters
- **authtoken** (string) - Required - Authentication Token.
- **status** (string) - Optional - Filter leads by status (e.g., 'active', 'unsubscribed').

### Response
#### Success Response (200)
- **leads** (array) - List of leads with their details.
```

--------------------------------

### Sample Response for Get List Leads

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-list-leads.html

This is a sample JSON response when successfully retrieving leads. It includes request details and a list of lead objects, each containing basic contact information.

```json
{
"requestdetails": {
"sort": "Ascending Order",
"range": 5,
"status": "active",
"fromindex": 1
},
"status": "success",
"list_of_details": [
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4800@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4449@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4448@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4447@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4445@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
}
],
"code": "0",
"uri": "/api/v1/getleads",
"version": "1"
}
```

--------------------------------

### getallleadfields

Source: https://www.zoho.com/marketingautomation/help/developers/v1/list-management.html

To fetch lead fields to get profile information of leads.

```APIDOC
## getallleadfields

### Description
To fetch lead fields to get profile information of leads.

### Method
GET

### Endpoint
/api/v1/leadfields

### Parameters
#### Query Parameters
- **authtoken** (string) - Required - Authentication Token.

### Response
#### Success Response (200)
- **fields** (array) - List of available lead fields.
```

--------------------------------

### Get Mailing Lists

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-mailing-lists.html

Retrieves a list of mailing lists. Supports sorting and pagination.

```APIDOC
## GET /getmailinglists

### Description
Fetches mailing lists with optional sorting and pagination.

### Method
POST

### Endpoint
https://marketingautomation.zoho.com/api/v1/getmailinglists

### Parameters
#### Query Parameters
- **resfmt** (String) - Optional - Format of the response. Supported values: JSON.
- **sort** (String) - Optional - Sort order for the lists. Supported values: asc, desc.
- **fromindex** (Number) - Optional - The starting index for fetching lists.
- **range** (Number) - Optional - The number of lists to fetch per page.

### Request Example
```
https://marketingautomation.zoho.com/api/v1/getmailinglists?resfmt=JSON&sort=asc&fromindex=1&range=2
```

### Response
#### Success Response (200)
- **requestdetails** (Object) - Details about the request parameters.
- **status** (String) - Indicates the status of the request (e.g., "success").
- **list_of_details** (Array) - An array of mailing list objects.
  - **created_date** (String) - The timestamp when the list was created.
  - **segments** (String) - Information about segments associated with the list.
  - **lockstatus** (String) - The lock status of the list.
  - **listunino** (String) - Unique identifier for the mailing list.
  - **date** (String) - The formatted date of creation.
  - **noofleads** (String) - The number of leads in the list.
  - **listname** (String) - The name of the mailing list.
  - **zuid** (String) - Zoho Unique ID.
  - **noofunsubcnt** (String) - Number of unsubscribed leads.
  - **is_public** (String) - Indicates if the list is public.
  - **noofbouncecnt** (String) - Number of bounced leads.
  - **owner** (String) - The owner of the mailing list.
  - **listkey** (String) - The unique key for the mailing list.
- **code** (String) - Error code, '0' for success.
- **uri** (String) - The API endpoint URI.
- **version** (String) - The API version.

#### Response Example
```json
{
  "requestdetails": {
    "sort": "Ascending Order",
    "range": 2,
    "fromindex": 1
  },
  "status": "success",
  "list_of_details": [
    {
      "created_date": "1316108278000",
      "segments": "{}",
      "lockstatus": "unlocked",
      "listunino": "6361736964559881",
      "date": "15 Sep 2011, 03:07 PM",
      "noofleads": "57",
      "listname": "1",
      "zuid": "229788",
      "noofunsubcnt": "0",
      "is_public": "false",
      "noofbouncecnt": "0",
      "owner": "Naveen",
      "listkey": "3c20ad524dfa4af86216a5be13e238ed"
    },
    {
      "created_date": "1358908439000",
      "segments": "{}",
      "lockstatus": "unlocked",
      "listunino": "6361736976335832",
      "date": "23 Jan 2013, 12:03 AM",
      "noofleads": "1393",
      "listname": "111",
      "zuid": "8846468",
      "noofunsubcnt": "2",
      "is_public": "true",
      "noofbouncecnt": "0",
      "owner": "john.doe.b",
      "listkey": "3c20ad524dfa4af85c20ad3564a05789"
    }
  ],
  "code": "0",
  "uri": "/api/v1/getmailinglists",
  "version": "1"
}
```
```

--------------------------------

### Sample Request URL for Coupon Details

Source: https://www.zoho.com/marketingautomation/help/developers/v1/view-coupon-details.html

This is a sample GET request URL to retrieve coupon details. Ensure you replace '[Couponcode]' with an actual coupon code.

```http
https://marketingautomation.zoho.com/api/coupon/coupondetails?type=json&version=1&couponCode=[Couponcode]
```

--------------------------------

### Sample Request URL

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-segment-details.html

This is a sample URL to retrieve segment details. Replace [cvid] and [listkey] with your actual values.

```http
https://marketingautomation.zoho.com/api/v1/getsegmentdetails?resfmt=JSON&cvid=[cvid]&listkey=[listkey]
```

--------------------------------

### Get Recent Campaigns

Source: https://www.zoho.com/marketingautomation/help/developers/v1/recent-campaign.html

Fetches the most recent campaigns. You can filter and sort the results using query parameters.

```APIDOC
## GET /recentcampaigns

### Description
Retrieves the details of the five most recent campaigns created in your organization.

### Method
GET

### Endpoint
https://marketingautomation.zoho.com/api/v1/recentcampaigns

### Parameters
#### Query Parameters
- **resfmt** (String) - Optional - Response format. Example: JSON
- **sort** (String) - Optional - Sort order. Values: asc/desc
- **fromindex** (number) - Optional - Starting index for results. Default value: 1
- **range** (number) - Optional - Number of records to retrieve.
- **status** (String) - Optional - Filter by campaign status. Values can be separated by '|' symbol: all, all campaigns, drafts, scheduled, inprogress, sent, stopped, canceled, tobereviewed, reviewed, paused, intesting.

### Request Example
```
https://marketingautomation.zoho.com/api/v1/recentcampaigns?sort=asc&fromindex=1&range=5&status=sent|scheduled
```

### Response
#### Success Response (200)
- **requestdetails** (Object) - Details about the request parameters.
- **status** (String) - Indicates the status of the request (e.g., "success").
- **recent_campaigns** (Array) - A list of recent campaign objects.
  - **campaign_key** (String) - Unique identifier for the campaign.
  - **campaign_name** (String) - Name of the campaign.
  - **created_date_string** (String) - Creation date of the campaign in a human-readable format.
  - **campaign_status** (String) - Current status of the campaign.
  - **created_time** (String) - Creation timestamp of the campaign.
  - **campaign_preview** (String) - URL to preview the campaign.
- **code** (String) - Response code.
- **uri** (String) - API endpoint URI.
- **version** (String) - API version.

#### Response Example
```json
{
  "requestdetails": "{range=5, status=All, fromindex=1}",
  "status": "success",
  "recent_campaigns": [
    {
      "campaign_key": "f70c4878c4a47169407e63917ad24497",
      "campaign_name": "1222",
      "created_date_string": "19 Aug 2013, 11:26 AM",
      "campaign_status": "Draft",
      "created_time": "1376920587000",
      "campaign_preview": "marketingautomation.zoho.com/EmailDisplayAction.do?&campaignId=303000023454038"
    }
  ],
  "code": "0",
  "uri": "/api/v1/recentcampaigns",
  "version": "1"
}
```

### Possible error cases
- **2206**: Campaign has been deleted.
- **6101**: No campaign was sent.
```

--------------------------------

### Get All Lead Tags

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-lead-tags.html

Retrieves a list of all lead tags created under your organization. This endpoint requires the ZohoMarketingAutomation.lead.READ scope.

```APIDOC
## GET /api/v1/tag/getalltags

### Description
Retrieves a list of all lead tags created under your organization.

### Method
GET

### Endpoint
https://marketingautomation.zoho.com/api/v1/tag/getalltags

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Zoho-oauthtoken <access_token>

### Response
#### Success Response (200)
- **uri** (string) - The URI of the request.
- **version** (string) - The API version.
- **requestdetails** (object) - Details about the request.
- **tags** (array) - A list of lead tags. Each tag is an object where the key is a unique tag ID and the value contains tag details:
  - **tagowner** (string) - The owner of the tag.
  - **tag_created_time** (string) - The date and time the tag was created.
  - **tag_name** (string) - The name of the tag.
  - **tag_color** (string) - The color associated with the tag.
  - **tag_desc** (string) - A description of the tag.
  - **tagged_contact_count** (string) - The number of contacts tagged.
  - **is_crm_tag** (string) - Indicates if it's a CRM tag.
  - **zuid** (string) - The Zoho Unique ID.

#### Response Example
{
    "uri": "/api/v1/tag/getalltags",
    "version": "1",
    "requestdetails": "{}",
    "tags": [
        {
            "16492000023685218": {
                "tagowner": "patricia",
                "tag_created_time": "07 Feb 2019, 12:33 PM",
                "tag_name": "interested",
                "tag_color": "#48b9d1",
                "tag_desc": "list of interested leads",
                "tagged_contact_count": "64",
                "is_crm_tag": "false",
                "zuid": "xxxxxx"
            }
        },
        {
            "16492000023685001": {
                "tagowner": "patricia",
                "tag_created_time": "07 Feb 2019, 11:25 AM",
                "tag_name": "event",
                "tag_color": "#ff458a",
                "tag_desc": "prospects gathered in event",
                "tagged_contact_count": "171",
                "is_crm_tag": "false",
                "zuid": "xxxxxxx"
            }
        },
        {
            "16492000005417003": {
                "tagowner": "joel",
                "tag_created_time": "06 Dec 2018, 07:41 PM",
                "tag_name": "online",
                "tag_color": "#ff458a",
                "tag_desc": "leads signup online",
                "tagged_contact_count": "29",
                "is_crm_tag": "false",
                "zuid": "55216673"
            }
        }
                     ]
}

### Error Handling
- **992**: No tags found to display.
```

--------------------------------

### Get All Lead Tags Request URL

Source: https://www.zoho.com/marketingautomation/help/developers/v1/get-lead-tags.html

This is the endpoint URL to retrieve all lead tags. Ensure you have the necessary authorization.

```http
https://marketingautomation.zoho.com/api/v1/tag/getalltags
```

--------------------------------

### Sample Response for Get List Advanced Details

Source: https://www.zoho.com/marketingautomation/help/developers/v1/list-advanced-details.html

This is a sample JSON response containing various details about a mailing list, including lead statistics, campaign data, and client/device breakdowns.

```json
{
"lead_stats": "{no_of_bounce=0, no_of_active=1, sent_count=30, no_of_unsub=0, schedule_count=0}",
"localleads": "{country_count={INDIA=1}, city_count={CHENNAI=1}, region_count={TAMIL NADU=1}}",
"email_client": "{outlook=0, lotus notes=0, thunderbird=0, apple mail=0, others=0}",
"status": "success",
"tablet_devices": "{ipad=0, blackberry=0, android=0, others=0}",
"campaign_details": "{303000023352204={campaignname=Zoho Survey 7, fulldate=02 August 2013, sent_time=1375472361000, cmp_type=normal, scheduledate=02 Aug 2013, 12:38 PM, isvisible=false, campaign_key=f70c4878c4a47169f092e4da56334c09, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 7, scheduled_time=1375472298000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:36 PM, campaignid=303000023352204, created_time=1375455983000, cmp_status=Sent}, 303000023352173={campaignname=Zoho Survey 6, fulldate=02 August 2013, sent_time=1375472238000, cmp_type=normal, scheduledate=02 Aug 2013, 12:36 PM, isvisible=false, campaign_key=f70c4878c4a471691d975c8e054dc416, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 6, scheduled_time=1375472176000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:34 PM, campaignid=303000023352173, created_time=1375455896000, cmp_status=Sent}, 303000023352144={campaignname=Zoho Survey 5, fulldate=02 August 2013, sent_time=1375472153000, cmp_type=normal, scheduledate=02 Aug 2013, 12:34 PM, isvisible=false, campaign_key=f70c4878c4a471698e5cd28a58c3686a, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 5, scheduled_time=1375472091000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:32 PM, campaignid=303000023352144, created_time=1375455779000, cmp_status=Sent}, 303000023352117={campaignname=Zoho Survey 4, fulldate=02 August 2013, sent_time=1375472024000, cmp_type=normal, scheduledate=02 Aug 2013, 12:32 PM, isvisible=false, campaign_key=f70c4878c4a471698e07dc27834b8e46, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 4, scheduled_time=1375471961000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:31 PM, campaignid=303000023352117, created_time=1375455706000, cmp_status=Sent}, 303000023352088={campaignname=Zoho Survey 3, fulldate=02 August 2013, sent_time=1375471750000, cmp_type=normal, scheduledate=02 Aug 2013, 12:28 PM, isvisible=false, campaign_key=f70c4878c4a4716914f7045ff4e1c8ca, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 3, scheduled_time=1375471688000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:25 PM, campaignid=303000023352088, created_time=1375455305000, cmp_status=Sent}}",
"code": "0",
"uri": "/api/v1/getlistadvanceddetails",
"version": "1",
"requestdetails": "{range=5, filtertype=sentcampaigns, fromindex=1}",
"web_client": "{na=1, gmail=0, hotmail=0, zoho mail=0, aol_webmail=0, yahoo_mail=0, others=0}",
"brower_type": "{chrome=1, firefox=0, internet explorer=0, safari=0, opera=0, others=0}",
"mobile_devices": "{iphone=0, blackberry=0, android=0, others=0}",
"operating_system": "{mac os x=1, windows=0, linux=0, others=0}"
}
```

--------------------------------

### Get Lead Count

Source: https://www.zoho.com/marketingautomation/help/developers/v1/view-total-leads.html

Fetches the total number of leads for a specified list. Requires appropriate authorization and can filter leads by status.

```APIDOC
## GET /leadscount

### Description
Retrieves the total number of leads within a specified list. This endpoint requires a valid `listkey` and supports filtering by lead status.

### Method
GET

### Endpoint
https://marketingautomation.zoho.com/api/v1/leadscount

### Parameters
#### Query Parameters
- **listkey** (String) - Required - The unique key of the list for which to retrieve the lead count.
- **resfmt** (String) - Optional - The format for the response. Defaults to JSON.
- **status** (String) - Optional - Filters leads by their status. Accepted values are 'active', 'unsub', 'bounce', 'spam'. Multiple statuses can be separated by '|'.

### Request Example
```
https://marketingautomation.zoho.com/api/v1/leadscount?resfmt=JSON&listkey=YOUR_LIST_KEY&status=active|unsub
```

### Response
#### Success Response (200)
- **no_of_leads** (Integer) - The total number of leads matching the criteria.
- **status** (String) - Indicates the success status of the API call.
- **code** (String) - A status code, typically '0' for success.
- **uri** (String) - The endpoint URI that was called.
- **version** (String) - The API version used.

#### Response Example
```json
{
  "status": "success",
  "code": "0",
  "uri": "/api/v1/leadscount",
  "no_of_leads": 250,
  "version": "1"
}
```

### Possible Error Cases
- **2202**: Listkey is empty or invalid.
- **2707**: Mailing list is deleted from your account.
- **2704**: Insufficient privilege to access other users' mailing list.
- **2701**: Insufficient privilege to access your mailing list.
- **2001**: Please enter correct JSON format.
```

--------------------------------

### Sample Request to Assign Lead Tag

Source: https://www.zoho.com/marketingautomation/help/developers/v1/assign-lead-tags.html

This is a sample GET request URL to associate a tag with a lead. Ensure the lead is active and provide the correct email and tag name.

```HTTP
https://marketingautomation.zoho.com/api/v1/tag/associate?lead_email=patricia@zylker.com&tagName=interested
```

--------------------------------

### Get Last Campaign Report

Source: https://www.zoho.com/marketingautomation/help/developers/v1/last-campaign-report.html

Retrieves the report for the last sent campaign. Requires appropriate scope for reading campaign data.

```APIDOC
## POST /api/v1/getlastcampaignreport

### Description
Retrieves the report for the last sent campaign. This endpoint requires the `ZohoMarketingAutomation.campaign.READ` scope or `ZohoMarketingAutomation.campaign.ALL`.

### Method
POST

### Endpoint
https://marketingautomation.zoho.com/api/v1/getlastcampaignreport

### Parameters
#### Query Parameters
- **resfmt** (String) - Optional - Specifies the response format. Use "JSON" for JSON output.

### Request Example
```
https://marketingautomation.zoho.com/api/v1/getlastcampaignreport?resfmt=JSON
```

### Response
#### Success Response (200)
- **message** (String) - Indicates the status of the request, e.g., "success".
- **campaign-by-loaction** (String) - Campaign statistics by location.
- **status** (String) - Overall status of the report retrieval.
- **campaign-reports** (Array) - An array of campaign report objects, each containing metrics like open rates, click rates, bounce counts, etc.
- **code** (String) - API response code, '0' indicates success.
- **uri** (String) - The API endpoint URI.
- **campaign-details** (Array) - An array of campaign detail objects, including campaign name, sent time, subject, etc.
- **campaign-reach** (Array) - An array detailing the campaign's reach across different platforms.
- **version** (String) - API version.

#### Response Example
```json
{
"message": "success",
"campaign-by-loaction": "{in=2}",
"status": "success",
"campaign-reports": [
{
"forward_percent": "0.0",
"hardbounce_count": "0",
"unsent_count": "0",
"bounce_percent": "0.0",
"unique_clicked_percent": "0.0",
"unopened": "0",
"unsubscribe_percent": "0.0",
"spams_count": "0",
"spam_percent": "0.0",
"delivered_percent": "100.0",
"delivered_count": "1",
"complaints_count": "0",
"unopened_percent": "0.0",
"autoreply_count": "0",
"softbounce_count": "0",
"opens_count": "1",
"campaign_name": "Zoho Survey 7",
"unique_clicks_count": "0",
"unsub_count": "0",
"complaints_percent": "0.0",
"unsent_percent": "0.0",
"bounces_count": "0",
"open_percent": "100.0",
"clicksperopenrate": "0.0",
"forwards_count": "0",
"emails_sent_count": "1"
}
],
"code": "0",
"uri": "/api/v1/getlastcampaignreport",
"campaign-details": [
{
"email_type": "html_template_editor",
"campaign_key": "f70c4878c4a47169f092e4da56334c09",
"reply_to": "john.doe@xyz.com",
"campaign_name": "Zoho Survey 7",
"sent_time": "02 Aug 2013, 12:39 PM",
"email_subject": "Zoho Survey 7",
"email_options": "Both",
"created_time": "02 Aug 2013, 12:36 PM",
"email_from": "john.doe@xyz.com"
}
],
"campaign-reach": [
{
"total": "1",
"twitter": "0",
"other": "0",
"linkedin": "0",
"facebook": "0",
"emails": "1"
}
],
"version": "1"
}
```

### Error Handling
- **6001**: Error in displaying reports. Please retry after sometime.
- **6302**: There are no details in this campaign.
- **6002**: This campaign is not sent (or) Invalid campaign key.
```

--------------------------------

### Sample Campaign Details Response

Source: https://www.zoho.com/marketingautomation/help/developers/v1/campaign-details.html

This is an example of the JSON response when successfully retrieving campaign details. It includes information about associated lists, reports, status, and more.

```JSON
{
  "associated_mailing_lists": [
    {
      "listkey": "34715a953809d0b01f02e6548dcf32a2",
      "liststatus": "active",
      "leadscount": "1",
      "listname": "meganzoho"
    }
  ],
  "segments_info": {},
  "total_leads_count": 1,
  "campaign-by-loaction": "{in=2}",
  "status": "success",
  "campaign-reports": [
    {
      "forward_percent": "0.0",
      "hardbounce_count": "0",
      "unsent_count": "0",
      "bounce_percent": "0.0",
      "unique_clicked_percent": "0.0",
      "unopened": "0",
      "unsubscribe_percent": "0.0",
      "spams_count": "0",
      "spam_percent": "0.0",
      "delivered_percent": "100.0",
      "delivered_count": "1",
      "complaints_count": "0",
      "unopened_percent": "0.0",
      "autoreply_count": "0",
      "softbounce_count": "0",
      "opens_count": "1",
      "unique_clicks_count": "0",
      "unsub_count": "0",
      "complaints_percent": "0.0",
      "bounces_count": "0",
      "unsent_percent": "0.0",
      "open_percent": "100.0",
      "clicksperopenrate": "0.0",
      "forwards_count": "0",
      "emails_sent_count": "1"
    }
  ],
  "campaign_status": "Sent",
  "code": "0",
  "url": "/api/v1/getcampaigndetails",
  "campaign-details": [
    {
      "email_type": "html_template_editor",
      "reply_to": "john.doe@xyz.com",
      "campaign_name": "Zoho Survey 7",
      "sent_time": "1375456161000",
      "email_subject": "Zoho Survey 7",
      "email_options": "Both",
      "email_from": "john.doe@xyz.com"
    }
  ],
  "campaign-reach": [
    {
      "total": "1",
      "twitter": "0",
      "other": "0",
      "linkedin": "0",
      "facebook": "0",
      "emails": "1"
    }
  ],
  "version": "1"
}
```
Tokens:
Raw