Campaigns
Response Structure
{
"data": [
{
"facebookadvertmanager__facebook_Account": { //Represents the facebook account associated with the campaign
"name": "sample",
"id": "4150868000002789010"
},
"Owner": { //Represents the name, ID, and email of the owner of the campaign
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"Description": "This is a sample campaign", //Description about the Campaign
"$currency_symbol": "DA", //The currency in which the revenue is generated
"Campaign_Name": "First Meet", //Name of the Campaign
"$review_process": null, //Represents the review process details of the campaign
"facebookadvertmanager__Lead_Source": "Advertisement", //Represents the lead source
"End_Date": "2020-08-04", //The date on which the Campaign ends
"facebookadvertmanager__Buying_Type": null,
"facebookadvertmanager__Updated_Time": "13:07:02+05:30",
"Modified_By": { //Represents the name, ID, and email of the user who last modified the campaign details
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "sneha.ss@zohocorp.com"
},
"$review": null,
"Num_sent": "1000", //The number of leads/contacts to whom the campaign details have been sent
"$process_flow": false, //Represents if the record is a blueprint data
"Exchange_Rate": 3, //Represents the exchange rate of the currency of the campaign amount.
"Expected_Revenue": 2000, //Represents the expected revenue of the campaign.
"Currency": "DZD", //The currency in which the revenue is generated
"Actual_Cost": 500, //The actual cost spent on the campaign
"id": "4150868000002789021", //The unique ID of the campaign
"Expected_Response": null,
"Start_Date": "2020-08-02", //The date on which the Campaign starts
"$approved": true, //Represents whether the record is approved
"facebookadvertmanager__Stop_Time": "15:07:02+05:30",
"Status": "Planning", //Represents the status of the campaign
"facebookadvertmanager__Account_Id": null,
"$approval": { //Represents if the current user can approve, delegate, reject, or resubmit the operations performed on this record
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2020-08-02T12:25:47+05:30", //Date and time at which the record was last modified. This is a system-generated field. You cannot modify it.
"facebookadvertmanager__Objective": "To create brand awareness for a new product. To drive sales of a product or service.", //Represents the objective of the campaign
"facebookadvertmanager__Budget_Rebalance_Flag": "To create brand awareness for a new product. To drive sales of a product or service.",
"Created_Time": "2020-08-02T12:25:47+05:30", //Date and time at which the record was created. This is a system-generated field. You cannot modify it.
"facebookadvertmanager__Effective_Status": "Active",
"$editable": true, //Represents if the user can edit records in the module
"facebookadvertmanager__Start_Time": "12:07:02+05:30",
"$orchestration": false, //Represents if the record is a part of orchestration process
"Type": "Conference", //Represents the type of Campaign
"$in_merge": false,
"facebookadvertmanager__Use_Spend_Cap": null,
"Created_By": { //Represents the name, ID, and email of the user who created the campaign
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"Parent_Campaign": null, //Represents the details of the parent campaign, if any
"Tag": [], //List of tags associated with the record
"$approval_state": "approved", //Represents whether the record is approved
"Budgeted_Cost": 1000 //The planned amount to be spent on the campaign
}
]
}
Note:
- The fields beginning with "$" indicate that they do not appear on the Zoho CRM UI, but contain important data. They are read-only fields.
- For more information about sample attributes, refer Get List of Records.