Each integration that uses our API will need to go through an application and review process. The steps for this process are:
Request a Key
You will need to apply for API access with our partner program in order to get an Application API Key and access our APIs. You can apply here: https://www2.activedemand.com/api-developer-program
View full details of the program here: https://www2.activedemand.com/api-program-overview
After applying, our integrations team will be in touch with you to get more information about:
The purpose of your integration
\nThe scope of your integration
\nIf your proposed integration is inline with our acceptable use policies you will receive an API Key as well as access to a test account. In order to make request to our API, you will need to pass this key through in the request header:
\nX-Application-Api-Key: APPLICATION_API_KEY
You can now build out your integration using the test account you were provided with. If you run into problems or have questions about our API you can contact our integrations team for assistance.
\nOnce you have completed the development of your integration, you can contact our integrations team to start the review process. Our team will review:
\nThe security of your integration
\nThe functionality of your integration
\nPerform acceptance testing
\nIf any problems are found that need to be addressed you will be notified and your integration will be moved back to the development step.
\nOnce your integration passes our review process it will be moved into production use. You will now be able to have your users access and use your application in their production accounts.
\nActiveDEMAND implements the following endpoints for integrating with external services. All endpoints require an API key.
\nAPI Base URL:
\nhttps://api.activedemand.com
The ActiveDEMAND account API key can be passed in the X-Api-Key request header field:
\nX-Api-Key: APIKEY
Or as a parameter named api-key:
\nhttps://api.activedemand.com/?api-key=APIKEY
If you are working on setting up an integration with our API, send an email to support@activedemand.com and we will give you access to our #activedemand-api slack channel where you can chat with our developers and have your questions answered.
\nCustom fields can be entered in either of two formats.
\nThis requires you to know the `id` for the custom field that you are trying to populate. This can be found by looking up the fields configured on your account.For example if your account is configured with a custom field named \"Department\" with an ID of 1234 on your contact object, you can populate using the following:
\n{\n \"contact\": {\n \"custom_1234\": \"Human Resources\"\n }\n}\n\nThis way of entering the custom fields requires that you know the name of the custom field(s) that you want to populate. For example if your account is configured with the custom fields \"Department\" and \"Total YTD Sales\" on your contact object, you can populate using the following:
\n{\n \"contact\": {\n \"custom_fields\": [\n { \"name\": \"Department\", \"value\": \"Human Resources\" },\n { \"name\": \"Total Sales YTD\", \"value\": 5000.00 }\n ]\n }\n}\n\nThe table below list the objects that currently support the submission of custom fields and the endpoint to lookup the fields available for this object.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13809894","collectionId":"3ddb8fd7-4e26-4350-a8de-daf94f72b923","publishedId":"2sB3dHUsc7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-11-21T18:15:05.000Z"},"item":[{"name":"Contacts","item":[{"name":"List Contacts","id":"e45731dc-9003-4095-866a-23767e796733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/contacts?page=0&limit=100&search_term=John Doe&search_list_id=123&search_tag=lead,customer&history_type=SiteVisit,EmailOpen&employer_id=456&contact_ids=1,2,3&tracked_phone_id=789&include_deals=true&crm_ids=[\"crm_id_1\",\"crm_id_2\"]&crm_type=salesforce&crm_object_type=Lead&order=desc&order_by=updated&created_by=YYYY-MM-DDTHH:MM:SSZ&updated_by=YYYY-MM-DDTHH:MM:SSZ&include_timeline=1","description":"Retrieves a paginated list of contacts based on various filter criteria. Requires X-Api-Key header for authentication.
Page number for pagination (default: 0)
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Number of contacts per page (default: 100, max: 500)
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Search term for full-text search across contact details.
\n","type":"text/plain"},"key":"search_term","value":"John Doe"},{"description":{"content":"ID of a contact list to search within.
\n","type":"text/plain"},"key":"search_list_id","value":"123"},{"description":{"content":"Comma-separated tags to filter contacts by.
\n","type":"text/plain"},"key":"search_tag","value":"lead,customer"},{"description":{"content":"Comma-separated history types to filter contacts by (e.g., SiteVisit, EmailOpen, TextMessage).
\n","type":"text/plain"},"key":"history_type","value":"SiteVisit,EmailOpen"},{"description":{"content":"ID of an employer (Account) to filter contacts by.
\n","type":"text/plain"},"key":"employer_id","value":"456"},{"description":{"content":"Comma-separated contact IDs to fetch specific contacts.
\n","type":"text/plain"},"key":"contact_ids","value":"1,2,3"},{"description":{"content":"ID of a tracked phone, used with history_type='TextMessage' to filter messages to/from this number.
\n","type":"text/plain"},"key":"tracked_phone_id","value":"789"},{"description":{"content":"Set to 'true' to include deal information with contacts.
\n","type":"text/plain"},"key":"include_deals","value":"true"},{"description":{"content":"JSON array or comma-separated string of CRM UIDs.
\n","type":"text/plain"},"key":"crm_ids","value":"[\"crm_id_1\",\"crm_id_2\"]"},{"description":{"content":"Type of CRM (e.g., salesforce, pipedrive).
\n","type":"text/plain"},"key":"crm_type","value":"salesforce"},{"description":{"content":"CRM object type (e.g., Lead, Contact).
\n","type":"text/plain"},"key":"crm_object_type","value":"Lead"},{"description":{"content":"Order of results ('asc' or 'desc', default: 'desc').
\n","type":"text/plain"},"key":"order","value":"desc"},{"description":{"content":"Field to order by ('updated', 'company', 'lead_score', 'visible_at' (default)).
\n","type":"text/plain"},"key":"order_by","value":"updated"},{"description":{"content":"Filter contacts created on or after this date.
\n","type":"text/plain"},"key":"created_by","value":"YYYY-MM-DDTHH:MM:SSZ"},{"description":{"content":"Filter contacts updated on or after this date.
\n","type":"text/plain"},"key":"updated_by","value":"YYYY-MM-DDTHH:MM:SSZ"},{"description":{"content":"Set to '1' to include the contact's timeline (last 30 history items).
\n","type":"text/plain"},"key":"include_timeline","value":"1"}],"variable":[]}},"response":[{"id":"f365a3db-aa82-4faa-8809-a4f54e616873","name":"Success - List of Contacts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/contacts?limit=1","protocol":"https","host":["api","activedemand","com"],"path":["v1","contacts"],"query":[{"key":"limit","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[{\n \"id\": 123,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"full_name\": \"John Doe\",\n \"email_address\": \"john.doe@example.com\",\n \"phone_number\": \"+15551234567\",\n \"title\": \"Software Engineer\",\n \"company_name\": \"Example Corp\",\n \"lead_score\": 75,\n \"tags\": [\"lead\", \"interested_in_product_x\"],\n \"custom_fields\": [\n {\n \"api_key\": \"custom_1\",\n \"api_name\": \"Lead Source\",\n \"api_value\": \"Website\"\n }\n ],\n \"deals\": [\n {\n \"id\": 789,\n \"name\": \"Deal for Product X\",\n \"value\": 5000,\n \"deal_status_name\": \"Negotiation\",\n \"deal_stage_name\": \"Proposal Sent\",\n \"deal_funnel_name\": \"Sales Pipeline\"\n }\n ],\n \"histories\": [\n {\n \"id\": 1001,\n \"history_type\": \"SiteVisit\",\n \"summary_html\": \"Visited page /pricing\",\n \"created_at\": \"2023-10-26T10:00:00Z\"\n }\n ]\n}]"},{"id":"01831979-1b26-4a0c-9474-7b41ce811fef","name":"Error - Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid API Key\"\n}"}],"_postman_id":"e45731dc-9003-4095-866a-23767e796733"},{"name":"Get Contact Count","id":"1cbe5d50-d11b-4d9a-b70a-43686b774042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/contacts/count?search_term=John Doe&search_list_id=123&search_tag=lead&history_type=SiteVisit&employer_id=456&created_by=YYYY-MM-DDTHH:MM:SSZ&updated_by=YYYY-MM-DDTHH:MM:SSZ","description":"Retrieves the total count of contacts matching the filter criteria. Requires X-Api-Key header.
Search term for full-text search.
\n","type":"text/plain"},"key":"search_term","value":"John Doe"},{"description":{"content":"ID of a contact list.
\n","type":"text/plain"},"key":"search_list_id","value":"123"},{"description":{"content":"Tag to filter by.
\n","type":"text/plain"},"key":"search_tag","value":"lead"},{"description":{"content":"History type to filter by.
\n","type":"text/plain"},"key":"history_type","value":"SiteVisit"},{"description":{"content":"Employer (Account) ID.
\n","type":"text/plain"},"key":"employer_id","value":"456"},{"description":{"content":"Filter contacts created on or after this date.
\n","type":"text/plain"},"key":"created_by","value":"YYYY-MM-DDTHH:MM:SSZ"},{"description":{"content":"Filter contacts updated on or after this date.
\n","type":"text/plain"},"key":"updated_by","value":"YYYY-MM-DDTHH:MM:SSZ"}],"variable":[]}},"response":[{"id":"9efc23c0-fc2d-4741-acad-25c376b0abf8","name":"Success - Contact Count","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 150\n}"}],"_postman_id":"1cbe5d50-d11b-4d9a-b70a-43686b774042"},{"name":"Get Contact Field Definition","id":"5b2bf3c8-12d3-47c5-9361-bb221640f03e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/field?field_key=emails.email_address","description":"Retrieves the definition for a specific contact field. No API key required for this endpoint.
\n","urlObject":{"protocol":"https","path":["v1","contacts","field"],"host":["api","activedemand","com"],"query":[{"description":{"content":"The API key of the field (e.g., 'emails.email_address' or 'custom_123').
\n","type":"text/plain"},"key":"field_key","value":"emails.email_address"}],"variable":[]}},"response":[{"id":"1ae52231-856b-46ee-8da5-cdfa527d94be","name":"Success - Field Definition","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/contacts/field?field_key=emails.email_address","protocol":"https","host":["api","activedemand","com"],"path":["v1","contacts","field"],"query":[{"key":"field_key","value":"emails.email_address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"unicode\",\n \"key\": \"contact[emails.email_address]\",\n \"required\": true,\n \"label\": \"Email\",\n \"list\": false,\n \"object\": \"Contact\",\n \"group\": null\n}"},{"id":"4acdce76-eaae-4a57-91f3-2c01e36d8da6","name":"Error - Field Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/contacts/field?field_key=nonexistent_field","protocol":"https","host":["api","activedemand","com"],"path":["v1","contacts","field"],"query":[{"key":"field_key","value":"nonexistent_field"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b2bf3c8-12d3-47c5-9361-bb221640f03e"},{"name":"List Contact Fields","id":"6ed981e4-8a6f-426d-b88f-5a774b56cea6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/fields?data_import_id=123&powerdialer_only=1","description":"Retrieves a list of available contact fields, including standard and custom fields. No API key required for this endpoint.
\n","urlObject":{"protocol":"https","path":["v1","contacts","fields"],"host":["api","activedemand","com"],"query":[{"description":{"content":"(Optional) ID of a data import to get mapped fields.
\n","type":"text/plain"},"key":"data_import_id","value":"123"},{"description":{"content":"(Optional) Set to '1' to restrict fields to those visible in the powerdialer.
\n","type":"text/plain"},"key":"powerdialer_only","value":"1"}],"variable":[]}},"response":[{"id":"564fe800-73ac-4baf-b15b-ccde6649b7a1","name":"Success - List of Fields","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"type\": \"unicode\",\n \"key\": \"contact[contact.edit_link]\",\n \"required\": false,\n \"label\": \"Contact Edit Link\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[contact.call_link]\",\n \"required\": false,\n \"label\": \"Contact Click To Call Link\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[lead_score.lead_score]\",\n \"required\": false,\n \"label\": \"Contact Lead Score\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[first_name]\",\n \"required\": false,\n \"label\": \"First Name\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[last_name]\",\n \"required\": false,\n \"label\": \"Last Name\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[full_name]\",\n \"required\": false,\n \"label\": \"Full Name\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[title]\",\n \"required\": false,\n \"label\": \"Title\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[dob]\",\n \"required\": false,\n \"label\": \"DOB\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[contact_source_name]\",\n \"required\": false,\n \"label\": \"Contact Source\",\n \"list\": true,\n \"choices\": [\n \"Call-to-Action Web Form\",\n \"Contact Web Form\",\n \"eNewsletter Sign-up\",\n \"Event Registration\",\n \"Event Attendance\",\n \"3rd Party List\",\n \"3rd Party Website\",\n \"Offline Marketing Initiative\",\n \"Online Directory\",\n \"Other\",\n \"Webinar Registration\",\n \"Account Introduction\",\n \"Live Chat\",\n \"Organic Search\",\n \"Search Engine Marketing\",\n \"Phone Call\",\n \"Email Campaign\",\n \"Twitter Follow\",\n \"Email\",\n \"Text Message\",\n \"CRM Import\"\n ]\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[contact_source_description]\",\n \"required\": false,\n \"label\": \"Contact Source Description\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[industry_list]\",\n \"required\": false,\n \"label\": \"Industries\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[tag_list]\",\n \"required\": false,\n \"label\": \"Tags\"\n },\n {\n \"type\": \"bool\",\n \"key\": \"contact[opted_in]\",\n \"required\": false,\n \"label\": \"Opted In\"\n },\n {\n \"type\": \"bool\",\n \"key\": \"contact[cookie_accept]\",\n \"required\": false,\n \"label\": \"Cookie Accepted\"\n },\n {\n \"type\": \"bool\",\n \"key\": \"contact[unsubscribed]\",\n \"required\": false,\n \"label\": \"Unsubscribed\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[claimed_by_id]\",\n \"required\": false,\n \"label\": \"Contact Manager Email\"\n },\n {\n \"type\": \"bool\",\n \"key\": \"contact[dni_list]\",\n \"required\": false,\n \"label\": \"DNI Replace For Contact\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[gender]\",\n \"required\": false,\n \"label\": \"Gender\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[seniority]\",\n \"required\": false,\n \"label\": \"Seniority\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[bio]\",\n \"required\": false,\n \"label\": \"Bio\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[contact_details.introduction_url]\",\n \"required\": false,\n \"label\": \"Contact Introduction URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[avatar]\",\n \"required\": false,\n \"label\": \"Avatar (url)\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.suite_no]\",\n \"required\": false,\n \"label\": \"Suite No\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.address]\",\n \"required\": false,\n \"label\": \"Street Address\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.city]\",\n \"required\": false,\n \"label\": \"City\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.province]\",\n \"required\": false,\n \"label\": \"Province/State\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.postal_code]\",\n \"required\": false,\n \"label\": \"Postal/Zip Code\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.country]\",\n \"required\": false,\n \"label\": \"Country\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.latitude]\",\n \"required\": false,\n \"label\": \"Latitude\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[addresses.longitude]\",\n \"required\": false,\n \"label\": \"Longitude\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[phones.phone_number]\",\n \"required\": false,\n \"label\": \"Phone Number\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[emails.email_address]\",\n \"required\": true,\n \"label\": \"Email Address\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[websites.url]\",\n \"required\": false,\n \"label\": \"Website\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[twitter.username]\",\n \"required\": false,\n \"label\": \"Twitter Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[twitter.url]\",\n \"required\": false,\n \"label\": \"Twitter URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[linkedin.username]\",\n \"required\": false,\n \"label\": \"LinkedIn Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[linkedin.url]\",\n \"required\": false,\n \"label\": \"LinkedIn URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[facebook.username]\",\n \"required\": false,\n \"label\": \"Facebook Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[facebook.url]\",\n \"required\": false,\n \"label\": \"Facebook URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[crunchbase.username]\",\n \"required\": false,\n \"label\": \"Crunchbase Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[crunchbase.url]\",\n \"required\": false,\n \"label\": \"Crunchbase URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[github.username]\",\n \"required\": false,\n \"label\": \"Github Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[github.url]\",\n \"required\": false,\n \"label\": \"Github URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[google_plus.username]\",\n \"required\": false,\n \"label\": \"Google+ Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[google_plus.url]\",\n \"required\": false,\n \"label\": \"Google+ URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[aboutme.username]\",\n \"required\": false,\n \"label\": \"AboutMe Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[aboutme.url]\",\n \"required\": false,\n \"label\": \"AboutMe URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.business_name]\",\n \"required\": false,\n \"label\": \"Employer Organization\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.blocked]\",\n \"required\": false,\n \"label\": \"Organization Blocked\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.is_referrer]\",\n \"required\": false,\n \"label\": \"Organization Is Referrer\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.suite_no]\",\n \"required\": false,\n \"label\": \"Organization Suite No\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.address]\",\n \"required\": false,\n \"label\": \"Organization Street Address\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.city]\",\n \"required\": false,\n \"label\": \"Organization City\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.province]\",\n \"required\": false,\n \"label\": \"Organization Province/State\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.postal_code]\",\n \"required\": false,\n \"label\": \"Organization Postal/Zip Code\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.country]\",\n \"required\": false,\n \"label\": \"Organization Country\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.latitude]\",\n \"required\": false,\n \"label\": \"Organization Latitude\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.addresses.longitude]\",\n \"required\": false,\n \"label\": \"Organization Longitude\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.phones.phone_number]\",\n \"required\": false,\n \"label\": \"Organization Phone Number\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.emails.email_address]\",\n \"required\": false,\n \"label\": \"Organization Email Address\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.websites.url]\",\n \"required\": false,\n \"label\": \"Organization Website\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.logo]\",\n \"required\": false,\n \"label\": \"Organization Logo (url)\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.lead_score]\",\n \"required\": false,\n \"label\": \"Organization Lead Score\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.claimed_by_id]\",\n \"required\": false,\n \"label\": \"Organization Contact Manager Email\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.employee_count]\",\n \"required\": false,\n \"label\": \"Organization Employee Count\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.employee_range]\",\n \"required\": false,\n \"label\": \"Organization Employee Range\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.annual_revenue]\",\n \"required\": false,\n \"label\": \"Organization Annual Revenue\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.long_about_company]\",\n \"required\": false,\n \"label\": \"Organization Description\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.industry_list]\",\n \"required\": false,\n \"label\": \"Organization Industries\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.tag_list]\",\n \"required\": false,\n \"label\": \"Organization Tags\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.technology_list]\",\n \"required\": false,\n \"label\": \"Organization Technologies\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.twitter.username]\",\n \"required\": false,\n \"label\": \"Organization Twitter Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.twitter.url]\",\n \"required\": false,\n \"label\": \"Organization Twitter URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.linkedin.username]\",\n \"required\": false,\n \"label\": \"Organization LinkedIn Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.linkedin.url]\",\n \"required\": false,\n \"label\": \"Organization LinkedIn URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.facebook.username]\",\n \"required\": false,\n \"label\": \"Organization Facebook Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.facebook.url]\",\n \"required\": false,\n \"label\": \"Organization Facebook URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.crunchbase.username]\",\n \"required\": false,\n \"label\": \"Organization Crunchbase Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.crunchbase.url]\",\n \"required\": false,\n \"label\": \"Organization Crunchbase URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.github.username]\",\n \"required\": false,\n \"label\": \"Organization Github Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.github.url]\",\n \"required\": false,\n \"label\": \"Organization Github URL\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.google_plus.username]\",\n \"required\": false,\n \"label\": \"Organization Google+ Handle\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"contact[accounts.google_plus.url]\",\n \"required\": false,\n \"label\": \"Organization Google+ URL\"\n },\n {\n \"type\": \"select\",\n \"key\": \"contact[custom_123]\",\n \"required\": false,\n \"label\": \"Lead Source Type\",\n \"list\": false,\n \"object\": \"Contact\",\n \"group\": \"Lead Information\",\n \"choices\": [\n {\n \"id\": \"Website\",\n \"label\": \"Website\"\n },\n {\n \"id\": \"Referral\",\n \"label\": \"Referral\"\n }\n ]\n }\n]"}],"_postman_id":"6ed981e4-8a6f-426d-b88f-5a774b56cea6"},{"name":"Get Contact Details","id":"89b55097-6fae-4102-bf12-ce6e0ee6189c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/contacts/12345?include_deals=true","description":"Retrieves details for a specific contact. Requires X-Api-Key header.
(Optional) Set to 'true' to include deal information.
\n","type":"text/plain"},"key":"include_deals","value":"true"}],"variable":[{"id":"3d422290-5586-4272-82ce-0f817a5accd8","type":"any","value":"123","key":"id"}]}},"response":[{"id":"bbe738e4-a962-485d-84e2-1778359a6f76","name":"Success - Contact Details","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[{\n \"id\": 123,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"full_name\": \"John Doe\",\n \"email_address\": \"john.doe@example.com\",\n \"phone_number\": \"+15551234567\",\n \"title\": \"Software Engineer\",\n \"company_name\": \"Example Corp\",\n \"lead_score\": 75,\n \"tags\": [\"lead\", \"interested_in_product_x\"],\n \"custom_fields\": [\n {\n \"api_key\": \"custom_1\",\n \"api_name\": \"Lead Source\",\n \"api_value\": \"Website\"\n }\n ],\n \"deals\": [\n {\n \"id\": 789,\n \"name\": \"Deal for Product X\",\n \"value\": 5000,\n \"deal_status_name\": \"Negotiation\",\n \"deal_stage_name\": \"Proposal Sent\",\n \"deal_funnel_name\": \"Sales Pipeline\"\n }\n ]\n}]"}],"_postman_id":"89b55097-6fae-4102-bf12-ce6e0ee6189c"},{"name":"Get Tasks for a Contact","id":"ec73eb30-4afb-4081-9fbe-e233863fb2d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/contacts/12345/task.json?include_completed=0&user_only=0","description":"Retrieves a list of tasks associated with a specific contact.
\n","urlObject":{"protocol":"https","path":["v1","contacts","12345","task.json"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Default 0. Set to 1 to include completed tasks.
\n","type":"text/plain"},"key":"include_completed","value":"0"},{"description":{"content":"Default 0. Set to 1 to restrict tasks to the authenticated user (employee).
\n","type":"text/plain"},"key":"user_only","value":"0"}],"variable":[]}},"response":[{"id":"149a28eb-977b-42b2-ae23-a944d5fd79e3","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/505/task.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 101,\n \"title\": \"Follow up call with Jane Doe\",\n \"details_display\": \"Discuss Q4 budget and new product line.
\",\n \"due_date\": \"2024-08-15T14:00:00.000Z\",\n \"completed_at\": null,\n \"type_id\": 1,\n \"status_id\": 2,\n \"outcome_id\": null,\n \"contact_id\": 505,\n \"subject_location\": \"Q4 Budget Discussion\",\n \"created_at\": \"2024-08-01T10:00:00.000Z\",\n \"updated_at\": \"2024-08-01T10:30:00.000Z\",\n \"custom_fields\": [\n { \"name\": \"Priority\", \"value\": \"High\" }\n ]\n }\n]"}],"_postman_id":"ec73eb30-4afb-4081-9fbe-e233863fb2d2"},{"name":"Create Contact","id":"5b9511c9-5498-4a2e-b2ad-a24da515d01f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"emails.email_address\": \"test@example.com\",\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"custom_fields\": [\n {\n \"name\": \"Your Custom Field Name\",\n \"value\": \"Custom Value\"\n }\n ]\n },\n \"source\": \"cp\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/contacts","description":"Creates a new contact. Use contact[field_key] for standard fields (e.g., contact[emails.email_address]) or contact[custom_field_api_key] for custom fields. Alternatively, provide custom fields as an array under contact[custom_fields] with name and value. source=cp can be used if the creation is from a control panel. Requires X-Api-Key header.
Updates an existing contact. Use contact[field_key] for standard fields or contact[custom_field_api_key] for custom fields. Alternatively, provide custom fields as an array under contact[custom_fields] with name and value. source=cp can be used if the update is from a control panel. Requires X-Api-Key header.
Adds a relationship between two contacts. Requires X-Api-Key header.
Retrieves the call script for a contact, optionally associated with a specific list. Requires X-Api-Key header.
ID of the contact list to get the call script from.
\n","type":"text/plain"},"key":"list_id","value":"456"}],"variable":[{"id":"0fa0b23b-b716-48c5-93f7-54607e09a164","type":"any","value":"123","key":"id"}]}},"response":[{"id":"c2d2020a-61e2-4620-9bc8-caa3a987f57b","name":"Success - Call Script","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/123/call_script"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"Hello %CONTACT.FIRST_NAME%,\nThis is a call script regarding %DEAL.NAME%..."}],"_postman_id":"02242914-bc86-4c00-9953-e3e3fbe02a82"},{"name":"Lookup Contact","id":"f6e846bb-b570-4717-aaab-fe51c74c4177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/contacts/lookup?email_address=test@example.com&phone_number=1234567890&contact_id=123&no_error=true&history_types=SiteVisit,EmailOpen&tracked_phone_id=789","description":"Looks up a contact by email, phone, or ID. Can include visit history and other details. Requires X-Api-Key header.
Email address to lookup.
\n","type":"text/plain"},"key":"email_address","value":"test@example.com"},{"description":{"content":"Phone number to lookup.
\n","type":"text/plain"},"key":"phone_number","value":"1234567890"},{"description":{"content":"Contact ID to lookup.
\n","type":"text/plain"},"key":"contact_id","value":"123"},{"description":{"content":"If true, returns 200 OK even if contact not found.
\n","type":"text/plain"},"key":"no_error","value":"true"},{"description":{"content":"Comma-separated history types to include in the response.
\n","type":"text/plain"},"key":"history_types","value":"SiteVisit,EmailOpen"},{"description":{"content":"Used with history_types='TextMessage' to filter messages.
\n","type":"text/plain"},"key":"tracked_phone_id","value":"789"}],"variable":[]}},"response":[{"id":"af3835b6-432e-4715-9c33-c4c18f38fb0d","name":"Success - Contact Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/contacts/lookup?email_address=john.doe@example.com","protocol":"https","host":["api","activedemand","com"],"path":["v1","contacts","lookup"],"query":[{"key":"email_address","value":"john.doe@example.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"john.doe@example.com\",\n \"currently_online\": true,\n \"last_seen\": \"2023-10-26T14:30:00Z\",\n \"visits\": [\n [\"https://example.com/pricing\", 120, true, \"2023-10-26T14:30:00Z\"],\n [\"https://example.com/features\", 180, false, \"2023-10-25T10:15:00Z\"]\n ],\n \"total_visits\": 5,\n \"first_visit_days\": 30,\n \"histories\": [\n {\n \"url\": \"https://example.com/pricing\",\n \"time_on_page\": 120,\n \"currently_on_page\": true,\n \"timestamp\": \"2023-10-26T14:30:00Z\",\n \"history_type\": \"SiteVisit\",\n \"id\": 1001,\n \"created_at\": \"2023-10-26T14:28:00Z\"\n }\n ]\n}"},{"id":"711691d2-ef11-4ad6-bc03-90fc91dfb7f1","name":"Error - Contact Not Found (no_error=false)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/contacts/lookup?email_address=notfound@example.com","protocol":"https","host":["api","activedemand","com"],"path":["v1","contacts","lookup"],"query":[{"key":"email_address","value":"notfound@example.com"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f6e846bb-b570-4717-aaab-fe51c74c4177"},{"name":"Forget Contact (GDPR)","id":"a2a2ca0a-5b68-4a42-9067-9a9d4b88ee4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email_address\": \"forgetme@example.com\"\n}\n\n// OR\n// {\n// \"phone_number\": \"1234567890\"\n// }","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/contacts/forget","description":"Initiates a GDPR 'forget me' request for a contact identified by email or phone number. Requires X-Api-Key header.
List all tasks for this contact in your account.
\n","urlObject":{"protocol":"https","path":["v1","contacts","12345","tasks.json"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Passing 1 will include completed tasks, defaults to 0
\n","type":"text/plain"},"key":"include_completed","value":"0"},{"description":{"content":"Restrict to only show user tasks, this is forced true if the user only has permissions to see their own
\n","type":"text/plain"},"key":"user_only","value":"1"}],"variable":[]}},"response":[],"_postman_id":"cf886f60-2fda-491a-a91b-71dd116487d3"},{"name":"Replace Text with Dynamic Fields","id":"1e82b43a-6557-46d8-81d2-fef9d1551ec8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"text\": \"Hello %CONTACT.FIRST_NAME%, welcome to %ACCOUNT.BUSINESS_NAME%!\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/contacts/12345/replace_text","description":"Replaces dynamic field placeholders in the provided text with actual contact and account data. Requires X-Api-Key header.
Initiates a GDPR data request for a contact identified by email or phone number. An email with the data export will be sent to the account's technical contact. Requires X-Api-Key header.
Checks the login status based on an encrypted cookie and custom field type ID. No API key required.
\n","urlObject":{"protocol":"https","path":["v1","contacts","login_status"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Encrypted cookie value.
\n","type":"text/plain"},"key":"cookie","value":"{{encrypted_cookie_value}}"},{"description":{"content":"Custom field type ID associated with the login.
\n","type":"text/plain"},"key":"custom_field_type_id","value":"{{custom-field-type-id}}"}],"variable":[]}},"response":[{"id":"c8a81c88-333b-4ff2-9cae-f361b1604cb0","name":"Success - Authenticated","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/login_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contact_id\": 123,\n \"custom_field_type_id\": 456,\n \"login_at\": \"2023-10-26T12:00:00Z\"\n}"},{"id":"65ae61b8-fa35-4f22-b09c-8c2af5f47de2","name":"Error - Not Authenticated","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/contacts/login_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Not Authenticated\"\n}"}],"_postman_id":"924b74a5-5faa-454c-94a3-d4cfa630fcd1"},{"name":"Initiate Call or Send Text","id":"f429128d-a419-4047-a610-7805772cad8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"call_number\": \"1\", \n \"my_number\": \"2\",\n \"tracked_number\": \"3\"\n}\n\n// OR for text message:\n// {\n// \"text_number\": \"1\",\n// \"tracked_number\": \"3\",\n// \"message\": \"Hello from API!\"\n// }","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/contacts/12345/call","description":"Initiates a phone call to a contact or sends a text message.
\nFor Calls: Provide call_number (contact's phone ID), my_number (sales person's phone number or ID), and optionally tracked_number (tracked phone ID).
For Texts: Provide text_number (contact's phone ID), message, and optionally tracked_number (tracked phone ID).
Requires X-Api-Key header.
Contacts endpoints can be used to manage your account contacts (list contacts, get contact details, update/create contacts).
\n {\n \"id\": 12345678,\n \"contact.edit_link\": \"https://login.sample.com/contacts/12345678/edit\",\n \"contact.call_link\": \"https://login.sample.com/contacts/12345678/edit?call=true\",\n \"lead_score.lead_score\": 0,\n \"first_name\": null,\n \"last_name\": null,\n \"full_name\": null,\n \"title\": null,\n \"dob\": null,\n \"contact_source_name\": null,\n \"contact_source_description\": \"\",\n \"industry_list\": null,\n \"tag_list\": null,\n \"opted_in\": \"No\",\n \"cookie_accept\": \"No\",\n \"unsubscribed\": \"No\",\n \"claimed_by_id\": null,\n \"dni_list\": \"No\",\n \"gender\": null,\n \"seniority\": null,\n \"bio\": null,\n \"avatar\": null,\n \"addresses.suite_no\": null,\n \"addresses.address\": null,\n \"addresses.city\": \"Calgary\",\n \"addresses.province\": \"AB\",\n \"addresses.postal_code\": null,\n \"addresses.country\": \"CA\",\n \"addresses.latitude\": null,\n \"addresses.longitude\": null,\n \"phones.phone_number\": \"1231234123\",\n \"emails.email_address\": \"person@sample.com\",\n \"websites.url\": null,\n \"twitter.username\": null,\n \"twitter.url\": null,\n \"linkedin.username\": null,\n \"linkedin.url\": null,\n \"facebook.username\": null,\n \"facebook.url\": null,\n \"crunchbase.username\": null,\n \"crunchbase.url\": null,\n \"github.username\": null,\n \"github.url\": null,\n \"google_plus.username\": null,\n \"google_plus.url\": null,\n \"aboutme.username\": null,\n \"aboutme.url\": null,\n \"accounts.business_name\": \"Sample Company\",\n \"accounts.blocked\": null,\n \"accounts.addresses.suite_no\": null,\n \"accounts.addresses.address\": null,\n \"accounts.addresses.city\": null,\n \"accounts.addresses.province\": null,\n \"accounts.addresses.postal_code\": null,\n \"accounts.addresses.country\": null,\n \"accounts.addresses.latitude\": null,\n \"accounts.addresses.longitude\": null,\n \"accounts.phones.phone_number\": null,\n \"accounts.emails.email_address\": null,\n \"accounts.websites.url\": null,\n \"accounts.logo\": null,\n \"accounts.claimed_by_id\": null,\n \"accounts.employee_count\": null,\n \"accounts.employee_range\": null,\n \"accounts.annual_revenue\": null,\n \"accounts.long_about_company\": null,\n \"accounts.industry_list\": null,\n \"accounts.tag_list\": null,\n \"accounts.technology_list\": null,\n \"accounts.twitter.username\": null,\n \"accounts.twitter.url\": null,\n \"accounts.linkedin.username\": null,\n \"accounts.linkedin.url\": null,\n \"accounts.facebook.username\": null,\n \"accounts.facebook.url\": null,\n \"accounts.crunchbase.username\": null,\n \"accounts.crunchbase.url\": null,\n \"accounts.github.username\": null,\n \"accounts.github.url\": null,\n \"accounts.google_plus.username\": null,\n \"accounts.google_plus.url\": null,\n \"custom_154888\": \"Non Customer\",\n \"custom_241681\": null,\n \"custom_275272\": null,\n \"custom_288332\": \"0\",\n \"custom_280848\": false,\n \"custom_278458\": false,\n \"custom_120533\": false,\n \"custom_288995\": null,\n \"custom_288673\": \"one\",\n \"custom_154891\": null,\n \"custom_291837\": false,\n \"custom_286545\": null,\n \"custom_288599\": \"0\",\n \"custom_276633\": null,\n \"custom_276229\": false,\n \"custom_192802\": \"0\",\n \"custom_297000\": null,\n \"custom_193357\": \"test3\",\n \"custom_302024\": null,\n \"emails\": [\"person@sample.com\"],\n \"phones\": [\"1231234123\"],\n \"crm_ids\": {},\n \"created_at\": \"2022-11-22T04:08:58.000-07:00\",\n \"is_anonymous\": false,\n \"updated_at\": \"2022-11-22T04:08:58.000-07:00\",\n \"alias_ids\": []\n }\n\nRetrieves a paginated list of deals. Deals are filtered based on the authenticated account. Various query parameters can be used for filtering and sorting.
\n","urlObject":{"protocol":"https","path":["v1","deals"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Page number for pagination (default: 0).
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Number of deals per page (default: 100, max: 500).
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Field to order by. Options: 'updated', 'value', 'estimated_close_date', 'created_at' (default).
\n","type":"text/plain"},"key":"order_by","value":"created_at"},{"description":{"content":"Order direction. Options: 'asc', 'desc' (default).
\n","type":"text/plain"},"key":"order","value":"desc"},{"disabled":true,"description":{"content":"Search term to filter deals by name, description, funnel, stage, or status.
\n","type":"text/plain"},"key":"search_term","value":"MyDeal"},{"disabled":true,"description":{"content":"Filter deals by employer account ID.
\n","type":"text/plain"},"key":"employer_id","value":"123"},{"disabled":true,"description":{"content":"Filter deals associated with a specific contact ID.
\n","type":"text/plain"},"key":"contact_id","value":"456"},{"disabled":true,"description":{"content":"Filter deals created on or after this date.
\n","type":"text/plain"},"key":"created_by","value":"2023-01-01T00:00:00Z"},{"disabled":true,"description":{"content":"Filter deals updated on or after this date.
\n","type":"text/plain"},"key":"updated_by","value":"2023-01-15T00:00:00Z"}],"variable":[]}},"response":[{"id":"94c33acf-2dc6-4db7-8b9e-fc9f49e980d4","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Big Deal Q1\",\n \"description\": \"Important deal for the first quarter\",\n \"value\": 10000.0,\n \"probability\": 75.0,\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\",\n \"deal_stage_id\": 2,\n \"deal_stage_name\": \"Proposal Made\",\n \"deal_status_id\": 3,\n \"deal_status_name\": \"Open\",\n \"sales_contact_id\": 101,\n \"sales_contact_name\": \"John Doe\",\n \"sales_contact_email\": \"john.doe@example.com\",\n \"created_at\": \"2023-10-26T10:00:00.000Z\",\n \"updated_at\": \"2023-10-27T10:00:00.000Z\",\n \"account_id\": 201,\n \"account_name\": \"Client Corp\",\n \"closed_on_date\": null,\n \"estimated_close_date\": \"2024-03-31\",\n \"currency\": \"USD\",\n \"contacts\": [\n {\n \"contact_id\": 301,\n \"is_primary\": true,\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@clientcorp.com\",\n \"crm_ids\": {},\n \"related_contacts\": []\n }\n ],\n \"custom_fields\": [\n {\n \"key\": \"custom_field_api_key_1\",\n \"name\": \"Region\",\n \"value\": \"North America\"\n }\n ],\n \"products\": [\n {\n \"uid\": \"PROD001\",\n \"quantity\": 2\n }\n ],\n \"attachment_files\": []\n }\n]"}],"_postman_id":"9b6decec-8d6f-4d5f-b281-27cc80978e0f"},{"name":"Create Deal","id":"6da212c1-8a25-49f5-8f27-8cb526d35aeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deal\": {\n \"name\": \"New API Deal\",\n \"description\": \"Deal created via API\",\n \"value\": 5000,\n \"probability\": 50,\n \"deal_funnel_id\": 1,\n \"deal_stage_id\": 1,\n \"deal_status_id\": 1,\n \"sales_contact_id\": 102,\n \"estimated_close_date\": \"2024-06-30\",\n \"currency\": \"USD\",\n \"contacts\": [\n {\n \"id\": 305,\n \"is_primary\": true\n }\n ],\n \"products\": [\n {\n \"uid\": \"PROD002\",\n \"quantity\": 1\n }\n ],\n \"custom_fields\": [\n {\n \"name\": \"Lead Source\",\n \"value\": \"API\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/deals","description":"Creates a new deal. The prospect_account_id is automatically set to the authenticated account. If sales_contact_id is blank and an employee is associated with the API key, it will be set to the employee's ID.
Retrieves a specific deal by its ID. The deal must belong to the authenticated account.
\n","urlObject":{"protocol":"https","path":["v1","deals","1"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"dcf1c7c7-592e-4a4c-b7a4-b76f1c0880c0","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Big Deal Q1\",\n \"description\": \"Important deal for the first quarter\",\n \"value\": 10000.0,\n \"probability\": 75.0,\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\",\n \"deal_stage_id\": 2,\n \"deal_stage_name\": \"Proposal Made\",\n \"deal_status_id\": 3,\n \"deal_status_name\": \"Open\",\n \"sales_contact_id\": 101,\n \"sales_contact_name\": \"John Doe\",\n \"sales_contact_email\": \"john.doe@example.com\",\n \"created_at\": \"2023-10-26T10:00:00.000Z\",\n \"updated_at\": \"2023-10-27T10:00:00.000Z\",\n \"account_id\": 201,\n \"account_name\": \"Client Corp\",\n \"closed_on_date\": null,\n \"estimated_close_date\": \"2024-03-31\",\n \"currency\": \"USD\",\n \"contacts\": [\n {\n \"contact_id\": 301,\n \"is_primary\": true,\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@clientcorp.com\",\n \"crm_ids\": {},\n \"related_contacts\": []\n }\n ],\n \"custom_fields\": [\n {\n \"key\": \"custom_field_api_key_1\",\n \"name\": \"Region\",\n \"value\": \"North America\"\n }\n ],\n \"products\": [\n {\n \"uid\": \"PROD001\",\n \"quantity\": 2\n }\n ],\n \"attachment_files\": []\n }\n]"},{"id":"9f7b8f79-54a2-4a0a-bc1b-397c675c24e3","name":"Deal Not Found","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals/9999"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b6af28a7-0877-4003-8a44-30f2a77e5414"},{"name":"Update Deal","id":"d878a220-9b98-4e1e-a3bf-b9c61d2e207e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deal\": {\n \"name\": \"Updated API Deal Name\",\n \"value\": 7500,\n \"custom_fields\": [\n {\n \"name\": \"Lead Source\",\n \"value\": \"Referral\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/deals/1","description":"Updates an existing deal by its ID. Only the fields provided in the request body will be updated. The deal must belong to the authenticated account.
\n","urlObject":{"protocol":"https","path":["v1","deals","1"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"58325ad2-7367-4800-8afe-8e50106477e4","name":"Successful Update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"deal\": {\n \"name\": \"Updated API Deal Name\",\n \"value\": 7500\n }\n}"},"url":"https://api.activedemand.com/v1/deals/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Updated API Deal Name\",\n \"description\": \"Important deal for the first quarter\",\n \"value\": 7500.0,\n \"probability\": 75.0,\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\",\n \"deal_stage_id\": 2,\n \"deal_stage_name\": \"Proposal Made\",\n \"deal_status_id\": 3,\n \"deal_status_name\": \"Open\",\n \"sales_contact_id\": 101,\n \"sales_contact_name\": \"John Doe\",\n \"sales_contact_email\": \"john.doe@example.com\",\n \"created_at\": \"2023-10-26T10:00:00.000Z\",\n \"updated_at\": \"2023-10-28T11:00:00.000Z\",\n \"account_id\": 201,\n \"account_name\": \"Client Corp\",\n \"closed_on_date\": null,\n \"estimated_close_date\": \"2024-03-31\",\n \"currency\": \"USD\",\n \"contacts\": [\n {\n \"contact_id\": 301,\n \"is_primary\": true,\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@clientcorp.com\",\n \"crm_ids\": {},\n \"related_contacts\": []\n }\n ],\n \"custom_fields\": [\n {\n \"key\": \"custom_field_api_key_1\",\n \"name\": \"Region\",\n \"value\": \"North America\"\n },\n {\n \"key\": \"custom_field_api_key_2\",\n \"name\": \"Lead Source\",\n \"value\": \"Referral\"\n }\n ],\n \"products\": [\n {\n \"uid\": \"PROD001\",\n \"quantity\": 2\n }\n ],\n \"attachment_files\": []\n }\n]"},{"id":"3550c948-5d48-461f-820d-4adf160d384c","name":"Deal Not Found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"deal\": {\n \"name\": \"Updated API Deal Name\",\n \"value\": 7500\n }\n}"},"url":"https://api.activedemand.com/v1/deals/9999"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d878a220-9b98-4e1e-a3bf-b9c61d2e207e"},{"name":"Delete Deal","id":"948b8d6f-5df6-4b4a-a18c-4b554238bb69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"}],"url":"https://api.activedemand.com/v1/deals/1","description":"Soft-deletes a deal by its ID. The deal must belong to the authenticated account.
\n","urlObject":{"protocol":"https","path":["v1","deals","1"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"83384a0a-1424-4478-83dc-793b03fdb334","name":"Successful Deletion","originalRequest":{"method":"DELETE","header":[],"url":"https://api.activedemand.com/v1/deals/1"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5dd409c5-8b17-4988-a259-d24f3b4721d0","name":"Deal Not Found","originalRequest":{"method":"DELETE","header":[],"url":"https://api.activedemand.com/v1/deals/9999"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"948b8d6f-5df6-4b4a-a18c-4b554238bb69"},{"name":"Get Deals Count","id":"82af5d57-b000-4904-be19-fd84be5e6b74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"}],"url":"https://api.activedemand.com/v1/deals/count","description":"Retrieves the total count of deals matching the provided filters.
\n","urlObject":{"protocol":"https","path":["v1","deals","count"],"host":["api","activedemand","com"],"query":[{"disabled":true,"description":{"content":"Search term to filter deals.
\n","type":"text/plain"},"key":"search_term","value":"MyDeal"},{"disabled":true,"description":{"content":"Filter deals by employer account ID.
\n","type":"text/plain"},"key":"employer_id","value":"123"},{"disabled":true,"description":{"content":"Filter deals associated with a specific contact ID.
\n","type":"text/plain"},"key":"contact_id","value":"456"}],"variable":[]}},"response":[{"id":"76fb5443-5c01-4a16-8e32-2b60fdb853c8","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 5\n}"}],"_postman_id":"82af5d57-b000-4904-be19-fd84be5e6b74"},{"name":"Get Deal Fields","id":"0d23a6f3-a625-477c-93d3-546fb4a0f774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"}],"url":"https://api.activedemand.com/v1/deals/fields","description":"Retrieves a list of available standard and custom fields for deals.
\n","urlObject":{"protocol":"https","path":["v1","deals","fields"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"72cad475-9bd7-43a2-80f7-3193725b77cf","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"type\": \"unicode\",\n \"key\": \"deal[deals.name]\",\n \"required\": \"true\",\n \"label\": \"Deal Name\"\n },\n {\n \"type\": \"unicode\",\n \"key\": \"deal[deals.description]\",\n \"required\": \"false\",\n \"label\": \"Deal Description\"\n },\n {\n \"type\": \"datetime\",\n \"key\": \"deal[custom_field_api_key_3]\",\n \"required\": false,\n \"label\": \"Follow-up Date\",\n \"list\": false,\n \"object\": \"Deal\"\n }\n]"}],"_postman_id":"0d23a6f3-a625-477c-93d3-546fb4a0f774"},{"name":"Get Deal Funnels","id":"d6fdf176-e034-4e04-828f-c29fce88c8f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"}],"url":"https://api.activedemand.com/v1/deals/funnels","description":"Retrieves a list of deal funnels (pipelines) for the authenticated account, including their stages and statuses.
\n","urlObject":{"protocol":"https","path":["v1","deals","funnels"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"00eb1a04-cbb2-48e3-a21a-9deabb4adef6","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals/funnels"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Sales Pipeline\",\n \"stages\": [\n {\n \"id\": 1,\n \"name\": \"Qualification\"\n },\n {\n \"id\": 2,\n \"name\": \"Proposal Made\"\n }\n ],\n \"statuses\": [\n {\n \"id\": 1,\n \"name\": \"Open\"\n },\n {\n \"id\": 2,\n \"name\": \"Won\"\n },\n {\n \"id\": 3,\n \"name\": \"Lost\"\n }\n ]\n }\n]"}],"_postman_id":"d6fdf176-e034-4e04-828f-c29fce88c8f2"},{"name":"Get Deal Stages","id":"010e3a33-eb0d-4691-bfca-bfc1916994f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"}],"url":"https://api.activedemand.com/v1/deals/stages","description":"Retrieves a list of all deal stages across all funnels for the authenticated account.
\n","urlObject":{"protocol":"https","path":["v1","deals","stages"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"f75df440-fc59-48ac-8f86-b73e6a9c3583","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals/stages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Qualification\",\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\"\n },\n {\n \"id\": 2,\n \"name\": \"Proposal Made\",\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\"\n }\n]"}],"_postman_id":"010e3a33-eb0d-4691-bfca-bfc1916994f3"},{"name":"Get Deal Statuses","id":"fae5281e-72e1-4bca-b100-f2731ff324b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","type":"text"}],"url":"https://api.activedemand.com/v1/deals/statuses","description":"Retrieves a list of all deal statuses across all funnels for the authenticated account.
\n","urlObject":{"protocol":"https","path":["v1","deals","statuses"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"ec6dec4a-a920-4b88-a00b-157298c800c6","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/deals/statuses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Open\",\n \"status\": \"open\",\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\"\n },\n {\n \"id\": 2,\n \"name\": \"Won\",\n \"status\": \"won\",\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\"\n }\n]"}],"_postman_id":"fae5281e-72e1-4bca-b100-f2731ff324b0"}],"id":"41db1f9c-075e-476b-b674-1b1728113e88","description":"Deals endpoints can be used to manage your account deals (list deals, get deal details, update/create deal).
\n[\n {\n \"id\": 1,\n \"name\": \"Big Deal Q1\",\n \"description\": \"Important deal for the first quarter\",\n \"value\": 10000.0,\n \"probability\": 75.0,\n \"deal_funnel_id\": 1,\n \"deal_funnel_name\": \"Sales Pipeline\",\n \"deal_stage_id\": 2,\n \"deal_stage_name\": \"Proposal Made\",\n \"deal_status_id\": 3,\n \"deal_status_name\": \"Open\",\n \"sales_contact_id\": 101,\n \"sales_contact_name\": \"John Doe\",\n \"sales_contact_email\": \"john.doe@example.com\",\n \"created_at\": \"2023-10-26T10:00:00.000Z\",\n \"updated_at\": \"2023-10-27T10:00:00.000Z\",\n \"account_id\": 201,\n \"account_name\": \"Client Corp\",\n \"closed_on_date\": null,\n \"estimated_close_date\": \"2024-03-31\",\n \"currency\": \"USD\",\n \"contacts\": [\n {\n \"contact_id\": 301,\n \"is_primary\": true,\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@clientcorp.com\",\n \"crm_ids\": {},\n \"related_contacts\": []\n }\n ],\n \"custom_fields\": [\n {\n \"key\": \"custom_field_api_key_1\",\n \"name\": \"Region\",\n \"value\": \"North America\"\n }\n ],\n \"products\": [\n {\n \"uid\": \"PROD001\",\n \"quantity\": 2\n }\n ],\n \"attachment_files\": []\n }\n]\n\n(Optional) Your approved Application API Key if you are an API partner.
\n","type":"text"}],"url":"https://api.activedemand.com/v1/organizations?page=0&limit=100&order=desc&order_by=created_at","description":"Retrieves a list of organizations associated with the authenticated account.
\n","urlObject":{"protocol":"https","path":["v1","organizations"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Page number for pagination. Default: 0.
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Number of organizations per page. Default: 100, Max: 500.
\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"Comma-separated list of tag IDs to filter organizations.
\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"A single tag name to filter organizations.
\n","type":"text/plain"},"key":"tag","value":""},{"disabled":true,"description":{"content":"Term to search across organization fields.
\n","type":"text/plain"},"key":"search_term","value":""},{"description":{"content":"Order of results. Values: 'asc' or 'desc'. Default: 'desc'.
\n","type":"text/plain"},"key":"order","value":"desc"},{"description":{"content":"Field to order by. Values: 'last_activity', 'updated_at', 'created_at'. Default: 'created_at'.
\n","type":"text/plain"},"key":"order_by","value":"created_at"}],"variable":[]}},"response":[{"id":"9f7e205c-339d-4bea-b9ef-e72deb1f7b8c","name":"Successful Retrieval of Organizations","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/organizations?page=0&limit=2","protocol":"https","host":["api","activedemand","com"],"path":["v1","organizations"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[{\n \"accounts.id\": 101,\n \"accounts.business_name\": \"Org Alpha\",\n \"accounts.websites.url\": \"http://alpha.example.com\",\n \"accounts.emails.email_address\": \"contact@alpha.example.com\",\n \"accounts.phones.phone_number\": \"555-0101\",\n \"custom_api_key_1\": \"Alpha Custom Data\",\n \"accounts.created_at\": \"2023-01-15T10:00:00Z\",\n \"accounts.updated_at\": \"2023-10-01T12:00:00Z\",\n \"accounts.last_activity_at\": \"2023-09-25T14:30:00Z\"\n },\n {\n \"accounts.id\": 102,\n \"accounts.business_name\": \"Org Beta\",\n \"accounts.websites.url\": \"http://beta.example.com\",\n \"accounts.emails.email_address\": \"info@beta.example.com\",\n \"accounts.phones.phone_number\": \"555-0102\",\n \"custom_api_key_2\": \"Beta Specific Info\",\n \"accounts.created_at\": \"2023-02-20T11:00:00Z\",\n \"accounts.updated_at\": \"2023-09-28T16:00:00Z\",\n \"accounts.last_activity_at\": \"2023-09-28T16:00:00Z\"\n }\n]"}],"_postman_id":"7c8c17ec-bb84-4c0e-b712-b1bddaf24388"},{"name":"Lookup Organization","id":"88ff2a5b-ff73-42d5-a846-044417209aa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","description":"(Optional) Your approved Application API Key if you are an API partner.
\n","type":"text"}],"url":"https://api.activedemand.com/v1/organizations/lookup.json?account_id=12345","description":"Looks up a single organization by various identifiers.
\n","urlObject":{"protocol":"https","path":["v1","organizations","lookup.json"],"host":["api","activedemand","com"],"query":[{"description":{"content":"ActiveDEMAND Account ID.
\n","type":"text/plain"},"key":"account_id","value":"12345"},{"disabled":true,"description":{"content":"Business name of the organization.
\n","type":"text/plain"},"key":"business_name","value":"Test Business"},{"disabled":true,"description":{"content":"Pipedrive CRM ID.
\n","type":"text/plain"},"key":"pipedrive_id","value":""},{"disabled":true,"description":{"content":"Salesforce CRM ID.
\n","type":"text/plain"},"key":"salesforce_id","value":""}],"variable":[]}},"response":[{"id":"03dcf84f-2fdb-4f63-8d73-1f5de78a1ef0","name":"Organization Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/organizations/lookup.json?account_id=101","protocol":"https","host":["api","activedemand","com"],"path":["v1","organizations","lookup.json"],"query":[{"key":"account_id","value":"101"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"accounts.id\": 101,\n \"accounts.business_name\": \"Org Alpha\",\n \"accounts.websites.url\": \"http://alpha.example.com\",\n \"accounts.emails.email_address\": \"contact@alpha.example.com\",\n \"accounts.phones.phone_number\": \"555-0101\",\n \"custom_api_key_1\": \"Alpha Custom Data\",\n \"accounts.created_at\": \"2023-01-15T10:00:00Z\",\n \"accounts.updated_at\": \"2023-10-01T12:00:00Z\",\n \"accounts.last_activity_at\": \"2023-09-25T14:30:00Z\",\n \"currently_online\": true,\n \"last_seen\": \"2023-10-27T10:05:00Z\",\n \"visits\": [\n [\"2023-10-27T10:00:00Z\", \"Visitor One\", \"Organic Search\", \"Google\", \"http://alpha.example.com/productA\", 3, 180, 789],\n [\"2023-10-26T15:30:00Z\", \"Visitor Two\", \"Referral\", \"partner.com\", \"http://alpha.example.com/blog/article1\", 5, 300, 790]\n ],\n \"total_visits\": 15,\n \"first_visit_days\": 90\n}"},{"id":"a0cb9c00-3662-4674-beb8-ebf330e5a9ff","name":"Organization Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/organizations/lookup.json?account_id=99999","protocol":"https","host":["api","activedemand","com"],"path":["v1","organizations","lookup.json"],"query":[{"key":"account_id","value":"99999"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"88ff2a5b-ff73-42d5-a846-044417209aa2"},{"name":"Create Organization","id":"2f81f52c-c0b4-4bda-b6fc-50feed1e3b56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}","description":"(Optional) Your approved Application API Key if you are an API partner.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"account[accounts.business_name]","value":"CreateFromApiRequest","description":"Business name of the organization.
\n","type":"text"},{"key":"account[accounts.websites.url]","value":"apirequest.ca","description":"Primary website URL.
\n","type":"text"},{"key":"account[accounts.emails.email_address]","value":"email@one.ca","description":"Primary email address.
\n","type":"text"},{"key":"account[accounts.phones.phone_number]","value":"1234567890","description":"Primary phone number.
\n","type":"text"},{"key":"account[custom_28247]","value":"CustomFieldValue","description":"Example custom field. Replace 'custom_28247' with your custom field's API key or ID (if numeric).
\n","type":"text"},{"key":"account[accounts.addresses.city]","value":"Calgary","description":"City for the primary address.
\n","type":"text"},{"key":"account[accounts.addresses.country]","value":"Canada","description":"Country for the primary address.
\n","type":"text"},{"key":"account[accounts.addresses.is_primary]","value":"true","description":"Set to 'true' to make this the primary address.
\n","type":"text"},{"key":"pipedrive_id","value":"pd123","description":"(Optional) Pipedrive CRM ID.
\n","type":"text","disabled":true},{"key":"account[custom_fields][][name]","value":"Industry Type","description":"(Optional) Alternative way to set custom fields by name. Ensure 'Industry Type' is an existing custom field name.
\n","type":"text","disabled":true},{"key":"account[custom_fields][][value]","value":"Technology","description":"(Optional) Value for the custom field specified by name.
\n","type":"text","disabled":true}]},"url":"https://api.activedemand.com/v1/organizations.json","description":"Creates a new organization. For more details on custom fields and standard fields, refer to ActiveDEMAND API Documentation.
\n","urlObject":{"protocol":"https","path":["v1","organizations.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"69b6d66e-9efc-4cbf-943b-af8f3bae947f","name":"Organization Created Successfully","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"account[accounts.business_name]","value":"CreateFromApiRequest","type":"text"}]},"url":"https://api.activedemand.com/v1/organizations.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[{\n \"accounts.id\": 103,\n \"accounts.business_name\": \"CreateFromApiRequest\",\n \"accounts.websites.url\": \"http://apirequest.ca\",\n \"accounts.emails.email_address\": \"email@one.ca\",\n \"accounts.phones.phone_number\": \"1234567890\",\n \"custom_28247\": \"CustomFieldValue\",\n \"accounts.addresses.city\": \"Calgary\",\n \"accounts.addresses.country\": \"Canada\",\n \"accounts.addresses.is_primary\": true,\n \"org_pipedrive_id\": \"pd123\",\n \"accounts.created_at\": \"2023-10-27T14:55:00Z\",\n \"accounts.updated_at\": \"2023-10-27T14:55:00Z\",\n \"accounts.last_activity_at\": null\n }\n]"}],"_postman_id":"2f81f52c-c0b4-4bda-b6fc-50feed1e3b56"}],"id":"1f6d275c-4f69-478c-88a2-0bfd12dc3909","description":"Endpoints for managing company/organization records.
\n","_postman_id":"1f6d275c-4f69-478c-88a2-0bfd12dc3909"},{"name":"Tasks","item":[{"name":"Get Tasks","id":"35a5cda2-57ef-4a9e-9e05-1a2b9faf9634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/tasks.json?limit=100&page=0&include_completed=0&user_only=0","description":"Retrieves a list of tasks for the authenticated account. Supports pagination and filtering.
\n","urlObject":{"protocol":"https","path":["v1","tasks.json"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Default 100, max 500. Number of tasks to return per page.
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Default 0. Page number for pagination.
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Default 0. Set to 1 to include completed tasks.
\n","type":"text/plain"},"key":"include_completed","value":"0"},{"description":{"content":"Default 0. Set to 1 to restrict tasks to the authenticated user (employee). This is forced true if the user only has permissions to see their own tasks.
\n","type":"text/plain"},"key":"user_only","value":"0"},{"disabled":true,"description":{"content":"(Optional) Filter tasks by a specific contact ID.
\n","type":"text/plain"},"key":"contact_id","value":""}],"variable":[]}},"response":[{"id":"fd8588ae-eab5-4e39-a08b-bc237b120c18","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/tasks.json?limit=2","protocol":"https","host":["api","activedemand","com"],"path":["v1","tasks.json"],"query":[{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 101,\n \"title\": \"Follow up call with Jane Doe\",\n \"details_display\": \"Discuss Q4 budget and new product line.
\",\n \"due_date\": \"2024-08-15T14:00:00.000Z\",\n \"completed_at\": null,\n \"type_id\": 1,\n \"status_id\": 2,\n \"outcome_id\": null,\n \"contact_id\": 505,\n \"subject_location\": \"Q4 Budget Discussion\",\n \"created_at\": \"2024-08-01T10:00:00.000Z\",\n \"updated_at\": \"2024-08-01T10:30:00.000Z\",\n \"custom_fields\": [\n { \"name\": \"Priority\", \"value\": \"High\" }\n ]\n },\n {\n \"id\": 102,\n \"title\": \"Prepare presentation for Project X\",\n \"details_display\": \"Include market analysis and competitor overview.
\",\n \"due_date\": \"2024-08-20T17:00:00.000Z\",\n \"completed_at\": null,\n \"type_id\": 2,\n \"status_id\": 1,\n \"outcome_id\": null,\n \"contact_id\": null,\n \"subject_location\": \"Project X Presentation Prep\",\n \"created_at\": \"2024-08-05T09:00:00.000Z\",\n \"updated_at\": \"2024-08-05T09:00:00.000Z\"\n }\\n]"}],"_postman_id":"35a5cda2-57ef-4a9e-9e05-1a2b9faf9634"},{"name":"Get Tasks for a Contact","id":"6911b564-f304-4529-ac83-3de04186aba4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/tasks/contact/12345.json?include_completed=0&user_only=0","description":"Retrieves a list of tasks associated with a specific contact.
\n","urlObject":{"protocol":"https","path":["v1","tasks","contact","12345.json"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Default 0. Set to 1 to include completed tasks.
\n","type":"text/plain"},"key":"include_completed","value":"0"},{"description":{"content":"Default 0. Set to 1 to restrict tasks to the authenticated user (employee).
\n","type":"text/plain"},"key":"user_only","value":"0"}],"variable":[]}},"response":[{"id":"722a8597-7023-4d76-91f1-beadaa0abb69","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/tasks/contact/505.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 101,\n \"title\": \"Follow up call with Jane Doe\",\n \"details_display\": \"Discuss Q4 budget and new product line.
\",\n \"due_date\": \"2024-08-15T14:00:00.000Z\",\n \"completed_at\": null,\n \"type_id\": 1,\n \"status_id\": 2,\n \"outcome_id\": null,\n \"contact_id\": 505,\n \"subject_location\": \"Q4 Budget Discussion\",\n \"created_at\": \"2024-08-01T10:00:00.000Z\",\n \"updated_at\": \"2024-08-01T10:30:00.000Z\",\n \"custom_fields\": [\n { \"name\": \"Priority\", \"value\": \"High\" }\n ]\n }\n]"}],"_postman_id":"6911b564-f304-4529-ac83-3de04186aba4"},{"name":"Get Task","id":"e081fe9e-a109-4889-8ef1-0ff30ba20a4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/tasks/12345.json","description":"Retrieves details for a single task by its ID.
\n","urlObject":{"protocol":"https","path":["v1","tasks","12345.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"ec08421d-26c8-4c6c-945f-0d6c96f872cb","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/tasks/101.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 101,\n \"title\": \"Follow up call with Jane Doe\",\n \"details_display\": \"Discuss Q4 budget and new product line.
\",\n \"due_date\": \"2024-08-15T14:00:00.000Z\",\n \"completed_at\": null,\n \"type_id\": 1,\n \"status_id\": 2,\n \"outcome_id\": null,\n \"contact_id\": 505,\n \"subject_location\": \"Q4 Budget Discussion\",\n \"created_at\": \"2024-08-01T10:00:00.000Z\",\n \"updated_at\": \"2024-08-01T10:30:00.000Z\",\n \"custom_fields\": [\n { \"name\": \"Priority\", \"value\": \"High\" }\n ]\n}"}],"_postman_id":"e081fe9e-a109-4889-8ef1-0ff30ba20a4d"},{"name":"Create Task","id":"2c16ed57-8818-49fa-b620-588de72c847a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"task[title]","value":"New API Task","description":"Title of the task.
\n","type":"text"},{"key":"task[details]","value":"Details for the new API task.","description":"Detailed description of the task (can be HTML).
\n","type":"text"},{"key":"task[due_date]","value":"2024-09-01T10:00:00Z","description":"Due date and time in UTC (ISO 8601 format).
\n","type":"text"},{"key":"task[type_id]","value":"1","description":"ID of the task type (see Get Types endpoint).
\n","type":"text"},{"key":"task[status_id]","value":"1","description":"ID of the task status (see Get Statuses endpoint).
\n","type":"text"},{"key":"task[contact_id]","value":"12345","description":"(Optional) ID of the contact associated with this task.
\n","type":"text"},{"key":"task[owner_id]","value":"{{employee-id}}","description":"(Optional) ID of the employee assigned to this task. Defaults to API user or contact manager.
\n","type":"text"},{"key":"task[subject]","value":"Email Subject for Task","description":"(Optional) Subject if task type is 'Email'.
\n","type":"text"},{"key":"task[location]","value":"Meeting Room A","description":"(Optional) Location if task type is 'Appointment'.
\n","type":"text"},{"key":"task[custom_fields][][name]","value":"Custom Field Name 1","description":"(Optional) Name of the first custom field.
\n","type":"text"},{"key":"task[custom_fields][][value]","value":"Custom Value 1","description":"(Optional) Value for the first custom field.
\n","type":"text"},{"key":"task[custom_123]","value":"Another Custom Value","description":"(Optional) Value for custom field with ID 123.
\n","type":"text"},{"key":"task[attachment]","description":"(Optional) File attachment for the task.
\n","type":"file","value":null}]},"url":"https://api.activedemand.com/v1/tasks.json","description":"Creates a new task. Custom fields can be submitted via task[custom_fields][][name] and task[custom_fields][][value] pairs, or by task[custom_{field_id}].
Details for the new API task.
\",\n \"due_date\": \"2024-09-01T10:00:00.000Z\",\n \"completed_at\": null,\n \"type_id\": 1,\n \"status_id\": 1,\n \"outcome_id\": null,\n \"contact_id\": 12345,\n \"subject_location\": \"Email Subject for Task\",\n \"created_at\": \"2024-08-10T12:00:00.000Z\",\n \"updated_at\": \"2024-08-10T12:00:00.000Z\",\n \"custom_fields\": [\n { \"name\": \"Custom Field Name 1\", \"value\": \"Custom Value 1\" }\n ]\n}"},{"id":"06dc96c4-15c9-40a5-8354-d2b1b9b04782","name":"Error Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"task[title]","value":"","type":"text"}]},"url":"https://api.activedemand.com/v1/tasks.json"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Title can't be blank\\nType can't be blank\"\n}"}],"_postman_id":"2c16ed57-8818-49fa-b620-588de72c847a"},{"name":"Update Task","id":"11297846-2a66-4854-bc7f-a064a18bc4f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"task[title]","value":"Updated Task Title via API","description":"New title for the task.
\n","type":"text"},{"key":"task[status_id]","value":"2","description":"Updated status ID.
\n","type":"text"},{"key":"task[completed_at]","value":"2024-08-15T16:00:00Z","description":"(Optional) Completion date and time if status implies completion.
\n","type":"text"},{"key":"task[outcome_id]","value":"1","description":"(Optional) Outcome ID if task type requires it and task is completed.
\n","type":"text"}]},"url":"https://api.activedemand.com/v1/tasks/12345.json","description":"Updates an existing task by its ID. Only include fields you want to change.
\n","urlObject":{"protocol":"https","path":["v1","tasks","12345.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"1617bad1-99e6-4c5c-a2d6-b61b715c42f8","name":"Successful Update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.activedemand.com/v1/tasks/101.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 101,\n \"title\": \"Updated Task Title via API\",\n \"details_display\": \"Discuss Q4 budget and new product line.
\",\n \"due_date\": \"2024-08-15T14:00:00.000Z\",\n \"completed_at\": \"2024-08-15T16:00:00.000Z\",\n \"type_id\": 1,\n \"status_id\": 2,\n \"outcome_id\": 1,\n \"contact_id\": 505,\n \"subject_location\": \"Q4 Budget Discussion\",\n \"created_at\": \"2024-08-01T10:00:00.000Z\",\n \"updated_at\": \"2024-08-10T13:00:00.000Z\",\n \"custom_fields\": [\n { \"name\": \"Priority\", \"value\": \"High\" }\n ]\n}"}],"_postman_id":"11297846-2a66-4854-bc7f-a064a18bc4f4"},{"name":"Delete Task","id":"87261256-bbf1-4105-9973-c87730e65d9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/tasks/12345.json","description":"Deletes a task by its ID.
\n","urlObject":{"protocol":"https","path":["v1","tasks","12345.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"c1198850-515a-4415-b153-05cc0b1e1a3e","name":"Successful Deletion","originalRequest":{"method":"DELETE","header":[],"url":"https://api.activedemand.com/v1/tasks/103.json"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"87261256-bbf1-4105-9973-c87730e65d9e"},{"name":"Get Task Outcomes","id":"eb687eb1-3eb7-42a3-9c1a-35feacf5cc6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/tasks/outcomes.json","description":"Retrieves a list of available task outcomes for the account.
\n","urlObject":{"protocol":"https","path":["v1","tasks","outcomes.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"13453380-2d1c-4d5e-a58a-87a9bcf04354","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/tasks/outcomes.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Completed\"\n },\n {\n \"id\": 2,\n \"name\": \"Left Voicemail\"\n },\n {\n \"id\": 3,\n \"name\": \"No Answer\"\n }\n]"}],"_postman_id":"eb687eb1-3eb7-42a3-9c1a-35feacf5cc6a"},{"name":"Get Task Types","id":"6ec4153c-851c-454d-9503-c217fa43743e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/tasks/types.json","description":"Retrieves a list of available task types for the account.
\n","urlObject":{"protocol":"https","path":["v1","tasks","types.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"102acf84-e61c-4a79-82ab-09b2e2fa89ea","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/tasks/types.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Call\",\n \"icon\": \"fa-phone\",\n \"outcome\": true,\n \"position\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Email\",\n \"icon\": \"fa-envelope\",\n \"outcome\": false,\n \"position\": 2\n },\n {\n \"id\": 3,\n \"name\": \"Appointment\",\n \"icon\": \"fa-calendar-alt\",\n \"outcome\": true,\n \"position\": 3\n }\n]"}],"_postman_id":"6ec4153c-851c-454d-9503-c217fa43743e"},{"name":"Get Task Statuses","id":"06ded235-a376-460b-9147-0e9be9b4ee6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/tasks/statuses.json","description":"Retrieves a list of available task statuses for the account.
\n","urlObject":{"protocol":"https","path":["v1","tasks","statuses.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"d6e49e88-b288-486f-9371-188509de0de9","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/tasks/statuses.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Not Started\",\n \"position\": 1,\n \"completed\": false\n },\n {\n \"id\": 2,\n \"name\": \"In Progress\",\n \"position\": 2,\n \"completed\": false\n },\n {\n \"id\": 3,\n \"name\": \"Completed\",\n \"position\": 3,\n \"completed\": true\n }\n]"}],"_postman_id":"06ded235-a376-460b-9147-0e9be9b4ee6b"},{"name":"Send Task Email","id":"6ee334ac-f41b-44af-8418-e489ca1fdb6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"details","value":"This is the email body content.","description":"(Optional) The body/details of the email. If not provided, the task's current details will be used.
\n","type":"text"},{"key":"subject_location","value":"Email Subject for Task","description":"(Optional) The subject of the email. If not provided, the task's current subject/location will be used.
\n","type":"text"},{"key":"to_email","value":"recipient@example.com","description":"(Optional) The email address to send to. If not provided, the task's associated contact's email will be used.
\n","type":"text"}]},"url":"https://api.activedemand.com/v1/tasks/12345/send_email.json","description":"Sends an email related to a specific task. The task must be of type 'Email' and have an associated contact with an email address.
\n","urlObject":{"protocol":"https","path":["v1","tasks","12345","send_email.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"d1e034bb-8a7e-4303-9540-656b7e33fabb","name":"Successful Email Send","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"details","value":"Updated email body for sending.","type":"text"}]},"url":"https://api.activedemand.com/v1/tasks/101/send_email.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Updated email body for sending.
\",\n \"subject\": \"Q4 Budget Discussion\",\n \"to\": \"jane.doe@example.com\",\n \"type\": \"Email\",\n \"error\": null\n}"},{"id":"acb64bdf-6f8f-4e3a-acfd-d04856cee7fb","name":"Error Sending Email (e.g., No Contact)","originalRequest":{"method":"POST","header":[],"url":"https://api.activedemand.com/v1/tasks/{{task_id_no_contact}}/send_email.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Task details for task with no contact.
\",\n \"subject\": \"Task Subject\",\n \"to\": null,\n \"type\": \"Email\",\n \"error\": \"To complete the email task, the task must have an associated contact with a valid email address.\"\n}"}],"_postman_id":"6ee334ac-f41b-44af-8418-e489ca1fdb6b"}],"id":"e8ab0ee6-52f0-4c62-be0f-54c254083950","description":"Endpoints for managing tasks.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"084d00a5-1ff6-42ff-8f5f-511e11b4a0de"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"102058db-da5d-4c0f-b6de-e37357822f3f"}}],"_postman_id":"e8ab0ee6-52f0-4c62-be0f-54c254083950"},{"name":"Dynamic Stories","item":[{"name":"List Dynamic Stories","id":"6aebaa4e-48ef-4c76-ae8c-5822d102e16b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.activedemand.com/api/v1/dynamic_stories?page=0&limit=10&order_by=created_at&order=desc&include_archived=false","description":"Retrieves a paginated and filterable list of dynamic stories.
\nQuery Parameters:
\npage: (integer, default 0) Page number.limit: (integer, default 100, max 500) Items per page.order_by: (string, 'created_at' or 'expires_on', default 'created_at') Sort field.order: (string, 'asc' or 'desc', default 'desc') Sort direction.search_term: (string) Text to search for.include_archived: (boolean string, 'true'/'false') Whether to include archived stories.topics: (JSON string array of names) e.g., [\"Tech\", \"Updates\"]categories: (JSON string array of names) e.g., [\"General News\"]Page number for pagination (default: 0).
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Number of items per page (default: 100, max: 500).
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Field to order by ('created_at' or 'expires_on', default: 'created_at').
\n","type":"text/plain"},"key":"order_by","value":"created_at"},{"description":{"content":"Order direction ('asc' or 'desc', default: 'desc').
\n","type":"text/plain"},"key":"order","value":"desc"},{"disabled":true,"description":{"content":"Term to search in name, description, excerpt, etc.
\n","type":"text/plain"},"key":"search_term","value":"example"},{"description":{"content":"Set to 'true' to include archived stories (default: false).
\n","type":"text/plain"},"key":"include_archived","value":"false"},{"disabled":true,"description":{"content":"JSON string array of topic names to filter by (e.g., '[\"Topic1\",\"Topic2\"]').
\n","type":"text/plain"},"key":"topics","value":"[\"Tech\",\"Urgent\"]"},{"disabled":true,"description":{"content":"JSON string array of category names to filter by (e.g., '[\"Category1\"]').
\n","type":"text/plain"},"key":"categories","value":"[\"News\"]"}],"variable":[]}},"response":[],"_postman_id":"6aebaa4e-48ef-4c76-ae8c-5822d102e16b"},{"name":"Get Dynamic Story","id":"c9c6241f-39f7-41ab-a6ce-444164a50c36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.activedemand.com/v1/dynamic_stories/{{dynamic-story-id}}","description":"Retrieves a specific dynamic story by its ID. The response will include the associated image if present.
\n","urlObject":{"protocol":"https","path":["v1","dynamic_stories","{{dynamic-story-id}}"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9c6241f-39f7-41ab-a6ce-444164a50c36"},{"name":"Create Dynamic Story","id":"59d95249-c022-46ed-94d1-ff93b61092fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dynamic_story\": {\n \"name\": \"New Awesome Story via API\",\n \"account_id\": \"{{your_account_id}}\", \n \"target_url\": \"https://example.com/new-story-target\",\n \"target_name\": \"Story Target Page\",\n \"excerpt\": \"This is a compelling excerpt for the new story.\",\n \"timestamp\": \"2024-01-15T10:30:00Z\",\n \"source\": \"Postman API Test\",\n \"is_archived\": false,\n \"created_by\": \"api_user\",\n \"tag_list\": \"Urgent, Important, Release\",\n \"category_list\": \"Product Update, News\",\n \"image_url\": \"https://picsum.photos/seed/story1/600/400\" \n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/dynamic_stories","description":"Creates a new dynamic story.
\naccount_id should match the account associated with the API key.image_url is optional; if provided, an image will be generated and associated.tag_list and category_list are comma-separated strings.dynamic_story will be ignored.Updates an existing dynamic story. Provide only the fields you want to change in the dynamic_story object.
image_url is optional; if provided, the story's image will be updated.dynamic_story will be ignored.Marks a dynamic story as deleted (soft delete). Expect a 204 No Content response on success.
\n","urlObject":{"protocol":"https","path":["v1","dynamic_stories","{{dynamic-story-id}}"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d83dc394-2916-4fb5-880f-0aba7f2dc0e8"}],"id":"d16b34d4-9474-42cb-85c4-8604680a335e","_postman_id":"d16b34d4-9474-42cb-85c4-8604680a335e","description":""},{"name":"Leads","item":[{"name":"Submit Lead","id":"39278e85-895b-45e1-9b8b-c88350750db9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/leads","description":"This endpoint can be used to generate post a Lead to ActiveDemand
\nFor more details on custom fields see here.
\n","urlObject":{"protocol":"https","path":["v1","leads"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"0054b58f-bcee-47da-9618-affc92088670","name":"Submit a Lead","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"title\": \"Mr\",\n \"emails.email_address\": \"hello@example.ca\",\n \"phones.phone_number\": \"1234567890\",\n \"accounts.business_name\": \"My Awesome Business\",\n \"accounts.websites.url\": \"example.ca\",\n \"custom_fields\": [\n {\n \"name\": \"Department\",\n \"value\": \"Human Resources\"\n },\n {\n \"name\": \"Total Sales YTD\",\n \"value\": 5000.00\n }\n ]\n },\n \"url\": \"https://submitted-from-url.com\",\n \"ip_address\": \"123.123.123.123\",\n \"referer\": \"https://google.com\",\n \"user_agent\": \"\",\n \"utm_source\": \"google\",\n \"utm_medium\": \"cpc\",\n \"utm_campaign\": \"my campaign\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/v1/leads"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"39278e85-895b-45e1-9b8b-c88350750db9"}],"id":"e597032e-eaf2-4a66-acdf-9ad6ae033db6","_postman_id":"e597032e-eaf2-4a66-acdf-9ad6ae033db6","description":""},{"name":"Histories","item":[{"name":"Get Histories","id":"cc1afe3e-843c-497f-bdbc-9cf052b9c1ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/histories?page=0&limit=100&history_type=&campaign_id=12345&contact_id=12345&start_date=&end_date=&last_history_id=&contact_group=emailed&search_term&order=asc&email_guid&tracked_number_id","description":"This endpoint will return contact histories matching the given parameters
\n","urlObject":{"protocol":"https","path":["v1","histories"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Default 0
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Default 100, max 500
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Contact History Type
\n","type":"text/plain"},"key":"history_type","value":""},{"description":{"content":"Campaign ID
\n","type":"text/plain"},"key":"campaign_id","value":"12345"},{"description":{"content":"Contact ID
\n","type":"text/plain"},"key":"contact_id","value":"12345"},{"description":{"content":"Start Date
\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"End Date
\n","type":"text/plain"},"key":"end_date","value":""},{"key":"last_history_id","value":""},{"description":{"content":"Values are \"all\", \"managed\" and \"emailed\". The default is \"emailed\"
\n","type":"text/plain"},"key":"contact_group","value":"emailed"},{"description":{"content":"Search term
\n","type":"text/plain"},"key":"search_term","value":null},{"description":{"content":"Values are \"asc\" or \"desc\". The default is \"desc\"
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Email GUID
\n","type":"text/plain"},"key":"email_guid","value":null},{"description":{"content":"Return all text messages associated with this tracked number if history_type = TextMessage
\n","type":"text/plain"},"key":"tracked_number_id","value":null}],"variable":[]}},"response":[],"_postman_id":"cc1afe3e-843c-497f-bdbc-9cf052b9c1ff"},{"name":"Get Realtime Site Vists","id":"0423daf1-6f34-42e5-a1a5-05f8ecbeb9ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/histories/realtime","description":"This endpoint returns current site visitors on the account website
\n","urlObject":{"protocol":"https","path":["v1","histories","realtime"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0423daf1-6f34-42e5-a1a5-05f8ecbeb9ac"},{"name":"Create History","id":"7b98d4fb-a79d-4fd4-80ed-24efe04e19bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"history\": {\n\t\t\"history_type\": \"ValidHistoryType\",\n \"field_237\":\"12345\" // the history needs to be associated with a contact, thus use either field_237 (conact id) or field_21 (email address) \n\n }\n}"},"url":"https://api.activedemand.com/v1/histories/","description":"This endpoint can create contact histories. Currently, it can create the following types of histories:
\nFor more details on custom fields see here.
\n","urlObject":{"protocol":"https","path":["v1","histories",""],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"efc22af9-2073-4f77-87ba-c0f1943f0a52","name":"Create Sales Note","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"history\": {\n\t\t\"history_type\": \"SalesNote\",\n\t\t\"field_21\":\"test@test.com\", // Contact Email Address Field\n \"comments\":\"My sales note comments\"\n }\n}"},"url":"https://api.activedemand.com/v1/histories/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a110d0d3-c133-4815-8e2c-b64035ce0349","name":"Create Email Log","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"history\": {\n\t\t\"history_type\": \"Email Log\",\n\t\t\"field_21\":\"test@test.com\", // Contact Email Address Field\n \"email_body\":\"Email body text/html\",\n \"subject_line\": \"Email subject line\",\n \"from\": \"From email address\",\n \"to\": \"To email address\"\n }\n}"},"url":"https://api.activedemand.com/v1/histories/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ab6aa077-0eea-4b6f-9bad-64fb6990ac90","name":"Create Goal Completion","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"history\": {\n\t\t\"history_type\": \"GoaCompletion\",\n\t\t\"field_21\":\"test@test.com\", // Contact Email Address Field\n \"campaign_goal_id\":123, // The id of the goal that will be \"completed\" \n \"contact_history_id\":123 // Optional: the id of the history item that triggered the goal completion\n }\n}"},"url":"https://api.activedemand.com/v1/histories/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"aced0527-d9e2-4027-a6d1-38ef629663aa","name":"Create Custom Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"history\": {\n\t\t\"history_type\": \"CustomEvent\",\n\t\t\"field_21\":\"test@test.com\", // Contact Email Address Field\n\t\t\"event\": {\n\t\t\t\"name\": \"TestEventOneName\",\n\t\t\t\"description\": \"TestEventOneDescription\"\n\t\t},\n\t\t\"event_items\": [\n\t\t\t{\n\t\t\t\t\"name\": \"TestEventItemOneName\",\n\t\t\t\t\"description\": \"TestEventItemOneDescription\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"TestEventItemTwoName\",\n\t\t\t\t\"description\": \"TestEventItemTwoDescription\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"TestEventItemThreeName\",\n\t\t\t\t\"description\": \"TestEventItemThreeDescription\"\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"https://api.activedemand.com/v1/histories/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c58f5ee2-2470-4b1c-86a4-b00a4448d071","name":"Create Chat Transcript","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"history\": {\n\t\t\"history_type\": \"Live Chat\",\n\t\t\"field_21\":\"test@test.com\", // Contact Email Address Field if we have it\n \"transcript\":\"This is the chat message\",\n \"speaker\": \"operator\" // speaker should be one of `operator` and `visitor`\n }\n}"},"url":"https://api.activedemand.com/v1/histories/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7b98d4fb-a79d-4fd4-80ed-24efe04e19bf"},{"name":"Delete History","id":"35eff35f-4da6-4da9-9347-055be8da9766","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/histories/{{id}}","description":"This endpoint can create contact histories. Currently, it can create the following types of histories:
\nGiven a history type, this endpoint returns the fields for that Contact History type
\n","urlObject":{"protocol":"https","path":["v1","histories","fields"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Can be one of WonDeal, SalesNote, CustomEvent
\n","type":"text/plain"},"key":"history_type","value":""}],"variable":[]}},"response":[],"_postman_id":"48218243-d735-4abc-9feb-602a853c359d"},{"name":"Get History Types","id":"ba9b3681-7495-4e66-a38c-fdb4994a4f85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/histories/history_types?all=1&readable=1","description":"This endpoint returns the types of Contact Histories, given the parameters
\n","urlObject":{"protocol":"https","path":["v1","histories","history_types"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Returns all contact history types, if true
\n","type":"text/plain"},"key":"all","value":"1"},{"description":{"content":"Returns only readable history types, if true
\n","type":"text/plain"},"key":"readable","value":"1"}],"variable":[]}},"response":[],"_postman_id":"ba9b3681-7495-4e66-a38c-fdb4994a4f85"},{"name":"Copy History Event","id":"ff1fd9e4-ee99-44aa-b86e-97b7432487b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"ff1fd9e4-ee99-44aa-b86e-97b7432487b3"}],"id":"d7245676-6b87-4fd3-9eed-e9498adbba5a","description":"The following is a sample of the data that will be returned from history endpoints:
\n[\n {\n \"id\": 12345678,\n \"history_type\": \"SubmittedForm\",\n \"created_at\": \"2022-11-22 14:57:26\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"form_id\": 1234,\n \"form_name\": \"Sample Form\",\n \"fields\": [\n [\n \"Company Name\",\n \"Sample Company\"\n ],\n [\n \"First Name\",\n \"Person\"\n ],\n [\n \"Last Name\",\n \"Last\"\n ],\n [\n \"Phone Number\",\n \"1112221212\"\n ],\n [\n \"Email Address\",\n \"person@sample.com\"\n ]\n ],\n \"field_keys\": [\n {\n \"key\": \"field_151_0\",\n \"value\": \"Sample Company\"\n },\n {\n \"key\": \"field_1_1\",\n \"value\": \"Person\"\n },\n {\n \"key\": \"field_11_2\",\n \"value\": \"Last\"\n },\n {\n \"key\": \"field_31_3\",\n \"value\": \"1112221212\"\n },\n {\n \"key\": \"field_21_4\",\n \"value\": \"person@sample.com\"\n }\n ],\n \"submitted_from_url\": \"https://sample.com/contact-us\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"PartialForm\",\n \"created_at\": \"2022-11-22 14:46:31\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"SiteVisit\",\n \"created_at\": \"2022-11-22 14:57:29\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"pages\": [\n \"https://sample.com/page3\",\n \"https://sample.com/page4\"\n ],\n \"page_details\": [\n {\n \"clean_url\": \"https://sample.com/page3\",\n \"time_on_page\": 0.0,\n \"is_on_page\": false,\n \"timestamp\": \"2022-11-22T07:57:29.000-07:00\"\n },\n {\n \"clean_url\": \"https://sample.com/page4\",\n \"time_on_page\": 1180.0,\n \"is_on_page\": false,\n \"timestamp\": \"2022-11-22T08:21:08.000-07:00\"\n }\n ],\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"Live Chat\",\n \"created_at\": \"2022-11-22 14:54:25\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"transcript\": \"Sample chat conversation\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"Email Log\",\n \"created_at\": \"2022-11-22 14:57:28\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"subject_line\": \"Sample Subject\",\n \"from\": \"example@sample.com\",\n \"reply_to\": \"example@sample.com\",\n \"email_guid\": \"hfuaipthnfjgkaslh\",\n \"marketing_email\": true,\n \"view_in_browser\": \"https://www2.sample.com/submit/view_email/mjfiht849574309jtrklgj\",\n \"opened_at\": \"2022-11-22T08:03:12.000-07:00\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"EmailReply\",\n \"created_at\": \"2022-11-22 14:52:42\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"subject_line\": \"Sample Subject\",\n \"from\": \"example@sample.com\",\n \"reply_to\": null,\n \"email_guid\": \"1849fd167fd5f5e0\",\n \"to\": \"+1231231234\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"EmailLinkClick\",\n \"created_at\": \"2022-11-22 14:57:24\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"url\": \"https://sample.com/page4\",\n \"subject_line\": \"Sample Subject\",\n \"email_sent_at\": \"2022-11-21T12:31:32.000-07:00\",\n \"view_in_browser\": \"https://www2.sample.com/submit/view_email/mjfiht849574309jtrklgj\",\n \"email_log_history_id\": 1234567,\n \"marketing_email\": true,\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"Unsubscribe\",\n \"created_at\": \"2022-11-22 14:56:56\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"email\": \"person@sample.com\",\n \"reason\": \"\",\n \"subject_line\": \"Sample Subject\",\n \"email_sent_at\": \"2022-11-21T13:00:43.000-07:00\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ContactCreation\",\n \"created_at\": \"2022-11-22 14:57:19\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"EmailError\",\n \"created_at\": \"2022-11-22 14:50:37\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"SpamReport\",\n \"created_at\": \"2022-11-22 14:22:56\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"EmailOpen\",\n \"created_at\": \"2022-11-22 14:57:29\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"open_tag_type\": \"image\",\n \"subject_line\": \"Sample Subject\",\n \"email_sent_at\": \"2022-11-22T07:48:31.000-07:00\",\n \"view_in_browser\": \"https://www2.sample.com/submit/view_email/mjfiht849574309jtrklgj\",\n \"email_log_history_id\": 1234567,\n \"marketing_email\": true,\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"EmailBrokerRequest\",\n \"created_at\": \"2022-11-07 19:50:47\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"PhoneCall\",\n \"created_at\": \"2022-11-22 14:57:26\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"to\": \"+1231231234\",\n \"caller_name\": \"Sample Person\",\n \"from\": \"+1231231234\",\n \"from_city\": \"Calgary\",\n \"from_country\": \"CA\",\n \"from_state\": \"AB\",\n \"from_zip\": \"\",\n \"direction\": \"inbound\",\n \"to_phone_id\": 12345,\n \"from_phone_id\": 12345,\n \"transcript\": \"\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TwitterFollow\",\n \"created_at\": \"2022-11-22 09:03:17\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TwitterUnFollow\",\n \"created_at\": \"2016-01-07 18:15:54\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TwitterMention\",\n \"created_at\": \"2022-11-21 21:37:03\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TwitterReTweet\",\n \"created_at\": \"2022-11-21 21:37:23\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TwitterMessage\",\n \"created_at\": \"2022-11-21 21:36:45\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TwitterTweet\",\n \"created_at\": \"2022-11-22 13:46:01\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\"\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ListAdded\",\n \"created_at\": \"2022-11-22 14:57:13\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ListRemoved\",\n \"created_at\": \"2022-11-22 14:57:17\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"CampaignMatched\",\n \"created_at\": \"2022-11-22 14:57:13\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"CampaignUnmatched\",\n \"created_at\": \"2022-11-22 14:54:49\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"WebinarRegistration\",\n \"created_at\": \"2022-11-22 13:55:33\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"WebinarAttendance\",\n \"created_at\": \"2022-11-17 11:20:44\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"campaign_name\": \"Sample Campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"AppointmentAttendance\",\n \"created_at\": \"2022-11-22 05:20:34\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"LinkedInShare\",\n \"created_at\": \"2022-11-21 21:30:01\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\"\n },\n {\n \"id\": 12345678,\n \"history_type\": \"InstagramPost\",\n \"created_at\": \"2022-11-22 14:30:09\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\"\n },\n {\n \"id\": 12345678,\n \"history_type\": \"FacebookPost\",\n \"created_at\": \"2022-11-22 14:30:09\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\"\n },\n {\n \"id\": 12345678,\n \"history_type\": \"AssetDownload\",\n \"created_at\": \"2022-11-22 14:57:24\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"name\": \"Sample Book\",\n \"description\": \"\",\n \"download_url\": \"https://www2.sample.com/submit/download/1234\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ShortUrlClick\",\n \"created_at\": \"2022-11-22 14:57:24\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"InstagramComment\",\n \"created_at\": \"2022-06-30 21:40:49\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"FacebookComment\",\n \"created_at\": \"2022-11-19 11:59:10\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"FacebookLike\",\n \"created_at\": \"2022-11-19 13:52:23\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"LinkedInLike\",\n \"created_at\": \"2015-04-15 12:01:31\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"OptIn\",\n \"created_at\": \"2022-11-22 14:53:07\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"CookieAccept\",\n \"created_at\": \"2022-11-22 14:53:16\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"EmailForward\",\n \"created_at\": \"2022-11-22 14:56:33\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"GoalCompletion\",\n \"created_at\": \"2022-11-22 14:56:36\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"campaign_name\": \"Sample Campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TextMessage\",\n \"created_at\": \"2022-11-22 14:50:24\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"message\": \"This is a sample message\",\n \"to\": \"+1231231234\",\n \"from\": \"+1231231234\",\n \"from_city\": \"Calgary\",\n \"from_country\": \"CA\",\n \"from_state\": \"AB\",\n \"from_zip\": \"\",\n \"direction\": \"inbound\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"SalesNote\",\n \"created_at\": \"2022-11-22 14:47:46\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"comments\": \"sample\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"SystemActivity\",\n \"created_at\": \"2022-11-22 14:57:27\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"name\": \"System Sample Event\",\n \"description\": \"Description of sample event\",\n \"icon\": \"fa fa-google fab\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"WonDeal\",\n \"created_at\": \"2022-11-22 14:52:28\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"name\": \"Sample Deal\",\n \"value\": 200,\n \"reference_uid\": 12345,\n \"products\": [],\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"WordpressPost\",\n \"created_at\": \"2022-10-31 13:00:07\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\"\n },\n {\n \"id\": 12345678,\n \"history_type\": \"PopupView\",\n \"created_at\": \"2022-11-22 14:57:24\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"PopupClick\",\n \"created_at\": \"2022-11-22 14:51:07\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"DynamicBlockView\",\n \"created_at\": \"2022-11-22 14:57:00\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"DynamicBlockClick\",\n \"created_at\": \"2022-11-22 14:41:32\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"gclid\": \"jgr890548yhgjkrrfedgre\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"FacebookPageView\",\n \"created_at\": \"2019-07-31 12:17:18\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"PinterestPin\",\n \"created_at\": \"2022-09-29 17:00:05\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\"\n },\n {\n \"id\": 12345678,\n \"history_type\": \"Referral\",\n \"created_at\": \"2022-11-22 13:56:25\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"campaign_name\": \"Sample Campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"AffiliateLinkClick\",\n \"created_at\": \"2022-11-21 14:05:27\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"campaign_name\": \"Sample Campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"AffiliateConversion\",\n \"created_at\": \"2022-06-17 15:37:23\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"DynamicImageView\",\n \"created_at\": \"2022-11-22 14:53:27\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"Appointment\",\n \"created_at\": \"2022-11-22 13:24:12\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ContactExport\",\n \"created_at\": \"2022-11-07 00:22:38\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"IVRDigits\",\n \"created_at\": \"2022-11-22 14:57:23\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"CustomEvent\",\n \"created_at\": \"2022-11-22 14:00:00\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"event_name\": \"Sample Event\",\n \"event_description\": \"Sample event description\",\n \"custom_event_items\": {},\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ContactChange\",\n \"created_at\": \"2022-11-22 14:57:23\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ScheduleEvent\",\n \"created_at\": \"2022-11-21 20:50:24\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"workflow_name\": \"Sample Workflow\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ga_client_uid\": \"1234.1234\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"DealChange\",\n \"created_at\": \"2022-11-22 14:57:12\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"TaskChange\",\n \"created_at\": \"2022-11-22 14:23:36\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"ContactEnrichment\",\n \"created_at\": \"2022-11-22 14:44:51\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": \"https://sample.com/page3\",\n \"ip_address\": \"xxx.xxx.xxx.xxx\"\n },\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"WebChatMessage\",\n \"created_at\": \"2025-03-12 19:14:15\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": null\n },\n \"message\": \"An interesting chat message\",\n \"direction\": \"inbound\",\n \"role\": \"User\",\n \"contact\": {}\n },\n {\n \"id\": 12345678,\n \"history_type\": \"WebChatDiscussion\",\n \"created_at\": \"2025-03-12 19:14:15\",\n \"utm_medium\": \"sample-medium\",\n \"utm_source\": \"sample-source\",\n \"utm_campaign\": \"sample-campaign\",\n \"session\": {\n \"entry_page\": null\n },\n \"transcript\": \"\\u003Cspan class='speaker_user '\\u003EAn interesting chat message\\u003C/span\\u003E\\u003Cbr/\\u003E\\u003Cspan class='speaker_system'\\u003EA system response\\u003C/span\\u003E\\u003Cbr/\\u003E\",\n \"contact\": {}\n }\n]\n\nThis endpoint can be used to generate softphone tokens to make a call
\n","urlObject":{"protocol":"https","path":["v1","phones","call"],"host":["api","activedemand","com"],"query":[{"description":{"content":"ActiveDEMAND number to call from
\n","type":"text/plain"},"key":"phone_id","value":"12345"},{"description":{"content":"Number to call
\n","type":"text/plain"},"key":"phone_number","value":""},{"key":"contact_id","value":"12345"}],"variable":[]}},"response":[],"_postman_id":"5b07a209-4f3b-4a12-ae15-59ee56a36852"},{"name":"Send a Text","id":"8880dfe4-1129-4c62-a115-d5bca5f289f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"zca-xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/phones/text?phone_id=12345&phone_number=&contact_id=12345&message=Test message","description":"This endpoint can be used to send a text
\n","urlObject":{"protocol":"https","path":["v1","phones","text"],"host":["api","activedemand","com"],"query":[{"description":{"content":"ActiveDEMAND number to send the text from
\n","type":"text/plain"},"key":"phone_id","value":"12345"},{"description":{"content":"Number to send the text to
\n","type":"text/plain"},"key":"phone_number","value":""},{"key":"contact_id","value":"12345"},{"description":{"content":"The text messsage to be sent
\n","type":"text/plain"},"key":"message","value":"Test message"}],"variable":[]}},"response":[],"_postman_id":"8880dfe4-1129-4c62-a115-d5bca5f289f2"}],"id":"7046ba21-66b4-4fac-abdf-beb41ac7cc92","_postman_id":"7046ba21-66b4-4fac-abdf-beb41ac7cc92","description":""},{"name":"Emails","item":[{"name":"Track Email","id":"baf2ad5e-f1d4-4dd3-b651-065a1d43ff1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"zca-xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"to_contacts\" : [\n\t\t{\n\t\t\t\"first_name\" : \"Test\",\n\t\t\t\"last_name\" : \"Person\",\n\t\t\t\"email_address\": \"test@email.com\"\n\t\t}\n\t],\n\t\"email_body\" : \"Track API Email Body\",\n\t\"subject_line\" : \"Track API Email Subject\"\n}"},"url":"https://api.activedemand.com/v1/emails/track","description":"This endpoint adds tracking to your email and returns the tracked version for you to then send using your own email sending functionality.
\n","urlObject":{"protocol":"https","path":["v1","emails","track"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"baf2ad5e-f1d4-4dd3-b651-065a1d43ff1c"},{"name":"Update Email GUID","id":"86712b4f-5e80-4b45-b501-9f80110f9f90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/emails/update_guid/12345?email_guid=","urlObject":{"protocol":"https","path":["v1","emails","update_guid","12345"],"host":["api","activedemand","com"],"query":[{"key":"email_guid","value":""}],"variable":[]}},"response":[],"_postman_id":"86712b4f-5e80-4b45-b501-9f80110f9f90"}],"id":"2f579967-a503-4574-a615-4631514d3da3","_postman_id":"2f579967-a503-4574-a615-4631514d3da3","description":""},{"name":"Webhooks","item":[{"name":"Get Subscriptions","id":"5f9aa05d-baef-4fac-80b4-202b570939e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/web_hooks.json","description":"List all web hooks for your account.
\n","urlObject":{"protocol":"https","path":["v1","web_hooks.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f9aa05d-baef-4fac-80b4-202b570939e1"},{"name":"Subscribe to event","id":"e2393e83-9eaa-43e2-877b-b6fc6b9204d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/web_hooks.json?target_url=&event=&event_argument=&contact_id","description":"Subscribe to an event web hook. An event, target url, and optionally an event argument are required. The subscription ID is returned and can be used to unsubscribe from the web hook.
\nThe possible events are:
\nActiveDEMAND, possible history types are:
\nsubscribe to events for only this contact
\n","type":"text/plain"},"key":"contact_id","value":null}],"variable":[]}},"response":[],"_postman_id":"e2393e83-9eaa-43e2-877b-b6fc6b9204d9"},{"name":"Unsubscribe from event","id":"88f6a234-3c3a-42fa-9f9e-10806756d132","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/web_hooks/12345?target_url&event&event_argument&contact_id","description":"Unsubscribe from an event web hook. The ID of the subscription is required, or the target url or event you wish to unsubscribe from. If your target url returns a 410 response code, it will automatically be unsubscribed.
\n","urlObject":{"protocol":"https","path":["v1","web_hooks","12345"],"host":["api","activedemand","com"],"query":[{"key":"target_url","value":null},{"key":"event","value":null},{"key":"event_argument","value":null},{"description":{"content":"unsubscribe to events for only this contact
\n","type":"text/plain"},"key":"contact_id","value":null}],"variable":[]}},"response":[],"_postman_id":"88f6a234-3c3a-42fa-9f9e-10806756d132"}],"id":"da28d277-e932-4d99-a968-11b2b4facdfe","description":"Web hooks are used to subscribe to ActiveDEMAND events. The events are currently limited to new contacts being created, contacts being updated, and new contact histories being created.
\nExample Data
\nWhat gets posted to your target url is dependent the event.
\nNew Contact
\n[{ \"id\": 1326622, \"contact.edit_link\": \"https://jumpdemand.activedemand.com/contacts/1326622/edit\", \"contact.call_link\": \"https://jumpdemand.activedemand.com/contacts/1326622/edit?call=true\", \"lead_score.lead_score\": 100, \"first_name\": \"First\", \"last_name\": \"Last\", \"full_name\": \"First Last\", \"title\": null, \"contact_source_name\": \"Live Chat\", \"contact_source_description\": \"http://www.jumpdemand.com/\", \"industry_list\": null, \"tag_list\": null, \"opted_in\": \"No\", \"unsubscribed\": \"No\", \"claimed_by_id\": null, \"dni_list\": \"No\", \"addresses.address\": null, \"addresses.city\": \"Calgary\", \"addresses.province\": \"AB\", \"addresses.postal_code\": null, \"addresses.country\": \"CA\", \"phones.phone_number\": \"1112221212\", \"emails.email_address\": \"first.last@jumpdemand.com\", \"social_media_accounts.username\": null, \"accounts.business_name\": \"ActiveDEMAND\", \"accounts.addresses.address\": null, \"accounts.addresses.city\": \"Calgary\", \"accounts.addresses.province\": \"AB\", \"accounts.addresses.postal_code\": \"T3G 2P6\", \"accounts.addresses.country\": \"CA\", \"accounts.phones.phone_number\": \"8557820512\", \"accounts.emails.email_address\": \"info@activedemand.com\", \"accounts.website.url\": \"https://www.activedemand.com\", \"accounts.claimed_by_id\": null, \"custom_521\": null, \"custom_549\": \"Agency\"}]
Updated Contact
\n[{ \"id\": 1326622, \"contact.edit_link\": \"https://jumpdemand.activedemand.com/contacts/1326622/edit\", \"contact.call_link\": \"https://jumpdemand.activedemand.com/contacts/1326622/edit?call=true\", \"lead_score.lead_score\": 100, \"first_name\": \"First\", \"last_name\": \"Last\", \"full_name\": \"First Last\", \"title\": null, \"contact_source_name\": \"Live Chat\", \"contact_source_description\": \"http://www.jumpdemand.com/\", \"industry_list\": null, \"tag_list\": null, \"opted_in\": \"No\", \"unsubscribed\": \"No\", \"claimed_by_id\": null, \"dni_list\": \"No\", \"addresses.address\": null, \"addresses.city\": \"Calgary\", \"addresses.province\": \"AB\", \"addresses.postal_code\": null, \"addresses.country\": \"CA\", \"phones.phone_number\": \"1112221212\", \"emails.email_address\": \"first.last@jumpdemand.com\", \"social_media_accounts.username\": null, \"accounts.business_name\": \"ActiveDEMAND\", \"accounts.addresses.address\": null, \"accounts.addresses.city\": \"Calgary\", \"accounts.addresses.province\": \"AB\", \"accounts.addresses.postal_code\": \"T3G 2P6\", \"accounts.addresses.country\": \"CA\", \"accounts.phones.phone_number\": \"8557820512\", \"accounts.emails.email_address\": \"info@activedemand.com\", \"accounts.website.url\": \"https://www.activedemand.com\", \"accounts.claimed_by_id\": null, \"custom_521\": null, \"custom_549\": \"Agency\"}]
New History – SubmittedForm
\n[{ \"id\": 20215118, \"history_type\": \"SubmittedForm\", \"created_at\": \"2016-06-29 15:48:52\", \"form_id\": 7831, \"form_name\": \"schedule appointment\", \"fields\": [ [\"First Name\", \"First\"], [\"Last Name\", \"Last\"], [\"Checkbox\", \"1\"], [\"Email Address\", \"first.last@jumpdemand.com\"], [\"Label Text\", \"yes\"], [\"Phone Number\", \"1112221212\"], [\"Long Answer\", \"Testing\"] ], \"contact\": {} /\\* contact json structure \\*/}]
New History – Live Chat
\n[{ \"id\": 20992954, \"history_type\": \"Live Chat\", \"created_at\": \"2016-07-14 20:08:42\", \"transcript\": \"chat transcript\", \"contact\": {} /\\* contact json structure \\*/}]
New History – EmailLinkClick
\n[{ \"id\": 21545324, \"history_type\": \"EmailLinkClick\", \"created_at\": \"2016-07-25 19:53:13\", \"url\": \"http://www.activedemand.com\", \"subject_line\": \"Subject\", \"contact\": {} /\\* contact json structure \\*/}]
New History – EmailOpen
\n[{ \"id\": 21736868, \"history_type\": \"EmailOpen\", \"created_at\": \"2016-07-29 15:00:43\", \"open_tag_type\": \"image\", \"subject_line\": \"Email Subject Line, \"contact\": {} /\\* contact json structure \\*/}]
New History – PhoneCall
\n[{ \"id\": 17289272, \"history_type\": \"PhoneCall\", \"created_at\": \"2016-05-18 15:45:33\", \"to\": \"+11112221212\", \"caller_name\": \"Cell Phone AB\", \"from\": \"+11112221212\", \"from_city\": \"\", \"from_country\": \"CA\", \"from_state\": \"Alberta\", \"from_zip\": \"\", \"transcript\": \"Phone call transcript (if available)\", \"contact\": {} /\\* contact json structure \\*/}]
New History – TextMessage
\n[{ \"id\": 6549484, \"history_type\": \"TextMessage\", \"created_at\": \"2015-07-14 00:10:10\", \"message\": \"This is another test message, with another link that you should consider clicking on: http://1jp.cc/s/SaCsP\", \"to\": \"+11112221212\", \"from\": \"+11112221212\", \"from_city\": null, \"from_country\": null, \"from_state\": null, \"from_zip\": null, \"contact\": {} /\\* contact json structure \\*/}]
New History – WonDeal
\n[{ \"id\": 9836627, \"history_type\": \"WonDeal\", \"created_at\": \"2015-11-27 14:31:55\", \"name\": \"won deal details\", \"value\": null, \"contact\": {} /\\* contact json structure \\*/}]
This endpoint returns all the forms for the account
\n","urlObject":{"protocol":"https","path":["v1","forms.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1bbcfe3c-1184-4fa2-91e2-9a262f1df030"},{"name":"Get Form Fields","id":"8f71818f-ad77-4b13-9842-5d2e3c95ce1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/forms/fields?form_id=12345","description":"Given a form ID, this endpoint returns all the fields in the form
\n","urlObject":{"protocol":"https","path":["v1","forms","fields"],"host":["api","activedemand","com"],"query":[{"key":"form_id","value":"12345"}],"variable":[]}},"response":[],"_postman_id":"8f71818f-ad77-4b13-9842-5d2e3c95ce1e"},{"name":"Get Form","id":"b28a77e7-9a71-46e5-b0b3-227f94b7e415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"activedemand_session_guid","value":"","type":"text"},{"key":"url","value":"","type":"text"},{"key":"ip_address","value":"","type":"text"},{"key":"referer","value":"","type":"text"},{"key":"user_agent","value":"","type":"text"}]},"url":"https://api.activedemand.com/v1/forms/12345","description":"Given a form ID, this endpoint returns the HTML for the form
\n","urlObject":{"protocol":"https","path":["v1","forms","12345"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b28a77e7-9a71-46e5-b0b3-227f94b7e415"},{"name":"Create Form Submit","id":"f3764bd3-5ca6-47fb-af2e-bd132bc009d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"activedemand_session_guid","value":"","type":"text"},{"key":"url","value":"","type":"text"},{"key":"ip_address","value":"","type":"text"},{"key":"referer","value":"","type":"text"},{"key":"user_agent","value":"","type":"text"},{"key":"field_378228","value":"Test FromApi","description":"Form Field with ID
\n","type":"text"},{"key":"field_378229","value":"test@fromapi.ca","description":"Form Field with ID
\n","type":"text"},{"key":"field_378230","value":"form_191_2_5","description":"Form Field with ID
\n","type":"text"}]},"url":"https://api.activedemand.com/v1/forms/12345","description":"This endpoint can be used to generate a form submit, given a form ID and session information
\nFor more details on custom fields see here.
\n","urlObject":{"protocol":"https","path":["v1","forms","12345"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"85e97282-6faa-404a-81d2-c24db9014a84","name":"Submit a Form","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"activedemand_session_guid","value":"","type":"text"},{"key":"url","value":"","type":"text"},{"key":"ip_address","value":"","type":"text"},{"key":"referer","value":"","type":"text"},{"key":"user_agent","value":"","type":"text"},{"key":"field_378228","value":"Test FromApi","description":"Form Field with ID","type":"text"},{"key":"field_378229","value":"test@fromapi.ca","description":"Form Field with ID","type":"text"},{"key":"field_378230","value":"form_191_2_5","description":"Form Field with ID","type":"text"}]},"url":"https://api.activedemand.com/v1/forms/12345"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f3764bd3-5ca6-47fb-af2e-bd132bc009d5"}],"id":"f20b7708-088f-4cdb-a3a4-e43f4e5fcceb","_postman_id":"f20b7708-088f-4cdb-a3a4-e43f4e5fcceb","description":""},{"name":"Landing Pages","item":[{"name":"Get All Landing Pages","id":"89b9f582-d7de-4cfa-922c-a7e1a04434d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/cta_pages.json","description":"Get all landing pages in the account
\n","urlObject":{"protocol":"https","path":["v1","cta_pages.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"89b9f582-d7de-4cfa-922c-a7e1a04434d3"},{"name":"Get Landing Page","id":"08e10457-b4a4-4d59-ac77-873c11e6e2b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/cta_pages/12345?url&referer&ip_address&activedemand_session_guid&user_agent","description":"Given a landing page ID, this endpoint returns the landing page
\n","urlObject":{"protocol":"https","path":["v1","cta_pages","12345"],"host":["api","activedemand","com"],"query":[{"description":{"content":"URL where you will be displaying the page
\n","type":"text/plain"},"key":"url","value":null},{"description":{"content":"Referer
\n","type":"text/plain"},"key":"referer","value":null},{"description":{"content":"IP address of the client
\n","type":"text/plain"},"key":"ip_address","value":null},{"description":{"content":"ActiveDEMAND Session GUID for the client
\n","type":"text/plain"},"key":"activedemand_session_guid","value":null},{"description":{"content":"User agent of the client
\n","type":"text/plain"},"key":"user_agent","value":null}],"variable":[]}},"response":[],"_postman_id":"08e10457-b4a4-4d59-ac77-873c11e6e2b3"}],"id":"f470c6e2-b309-451b-b69d-b9a10a9ff324","_postman_id":"f470c6e2-b309-451b-b69d-b9a10a9ff324","description":""},{"name":"Dynamic Content","item":[{"name":"Get Dynamic Contents","id":"0dc42fea-06e8-409c-ae74-79ba30d4b3f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/smart_blocks.json","description":"This endpoint returns all dynamic content for the account
\n","urlObject":{"protocol":"https","path":["v1","smart_blocks.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0dc42fea-06e8-409c-ae74-79ba30d4b3f5"},{"name":"Show Dyanmic Content","id":"d858a140-4aa8-47a2-a62a-97e032a125dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/smart_blocks/12345?exclude_css=1&activedemand_session_guid&url&ip_address&referer&user_agent","description":"For a given Dynamic Content block, this endpoint returns the HTML, and the CSS depending on the given parameters.
\n","urlObject":{"protocol":"https","path":["v1","smart_blocks","12345"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Returns only HTML, if enabled
\n","type":"text/plain"},"key":"exclude_css","value":"1"},{"key":"activedemand_session_guid","value":null},{"description":{"content":"URL where you will be displaying the content
\n","type":"text/plain"},"key":"url","value":null},{"description":{"content":"IP address of the client
\n","type":"text/plain"},"key":"ip_address","value":null},{"description":{"content":"Referer
\n","type":"text/plain"},"key":"referer","value":null},{"description":{"content":"User agent of the client
\n","type":"text/plain"},"key":"user_agent","value":null}],"variable":[]}},"response":[],"_postman_id":"d858a140-4aa8-47a2-a62a-97e032a125dc"},{"name":"Show All Dyanmic Content","id":"d37e316b-0082-4fa6-a6a6-dbe7a08d0969","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"exclude_css","value":"1","description":"Exlcude all CSS, if enabled
\n","type":"text"},{"key":"exclude_block_css","value":"1","description":"Exclude block CSS, if enabled
\n","type":"text"},{"key":"exclude_form_css","value":"1","description":"Exclude form CSS, if enabled
\n","type":"text"},{"key":"shortcodes","value":"{\"forms\":{\"html_reference_id\": \"12345\"},\"popups\":false,\"blocks\":{\"html_reference_id\":\"12345\"}}","description":"For forms: the \"html_reference_id\" would be in the form of: \"activedemand_forms_\"\nFor blocks: the\"html_reference_id\" would be in the form of: \"activedemand_blocks_\"
\n","type":"text"},{"key":"activedemand_session_guid","value":"","type":"text"},{"key":"url","value":"","type":"text"},{"key":"ip_address","value":"","type":"text"},{"key":"referer","value":"","type":"text"},{"key":"user_agent","value":"","type":"text"}]},"url":"https://api.activedemand.com/v1/smart_blocks/show_all","description":"Given a URL or a session, this endpoint returns all the dynamic contents for the parameter(s)
\n","urlObject":{"protocol":"https","path":["v1","smart_blocks","show_all"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d37e316b-0082-4fa6-a6a6-dbe7a08d0969"},{"name":"Get Active Popups","id":"3e83b134-987c-4c7b-bd62-38e651026992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"activedemand_session_guid","value":"","type":"text"},{"key":"url","value":"","type":"text"},{"key":"ip_address","value":"","type":"text"},{"key":"referer","value":"","type":"text"},{"key":"user_agent","value":"","type":"text"}]},"url":"https://api.activedemand.com/v1/smart_blocks/popups","description":"Given a URL or a session GUID, this endpoint returns all active popups
\n","urlObject":{"protocol":"https","path":["v1","smart_blocks","popups"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e83b134-987c-4c7b-bd62-38e651026992"}],"id":"9deb2bac-7a13-4ff4-aca4-3058d7e8ff1d","_postman_id":"9deb2bac-7a13-4ff4-aca4-3058d7e8ff1d","description":""},{"name":"Dynamic Stories","item":[{"name":"List Dynamic Stories","id":"765aa964-c983-43e0-b8ba-8375cd0a40dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/api/v1/dynamic_stories?page=0&limit=10&order_by=created_at&order=desc&include_archived=false","description":"Retrieves a list of dynamic stories for the authenticated account. Supports pagination, sorting, and filtering by search term, topics, categories, and archive status.
\n","urlObject":{"protocol":"https","path":["api","v1","dynamic_stories"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Page number for pagination (Default: 0).
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Number of stories per page (Default: 100, Max: 500).
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Field to order by. Options: 'created_at', 'expires_on'. (Default: 'created_at').
\n","type":"text/plain"},"key":"order_by","value":"created_at"},{"description":{"content":"Order direction. Options: 'asc', 'desc'. (Default: 'desc').
\n","type":"text/plain"},"key":"order","value":"desc"},{"disabled":true,"description":{"content":"Search term for story name, description, excerpt, etc.
\n","type":"text/plain"},"key":"search_term","value":"Tech Update"},{"disabled":true,"description":{"content":"JSON array of topic names to filter by (e.g., [\"Topic1\", \"Topic2\"]).
\n","type":"text/plain"},"key":"topics","value":"[\"Technology\",\"Innovation\"]"},{"disabled":true,"description":{"content":"JSON array of category names to filter by (e.g., [\"CategoryA\", \"CategoryB\"]).
\n","type":"text/plain"},"key":"categories","value":"[\"News\",\"Updates\"]"},{"description":{"content":"Set to 'true' to include archived stories. (Default: false).
\n","type":"text/plain"},"key":"include_archived","value":"false"},{"disabled":true,"description":{"content":"Filter by a specific author ID.
\n","type":"text/plain"},"key":"author_id","value":"123"},{"disabled":true,"description":{"content":"JSON array of author IDs to filter by.
\n","type":"text/plain"},"key":"author_ids","value":"[123, 456]"}],"variable":[]}},"response":[{"id":"8dd0de21-da93-4892-96c1-874587050c89","name":"Successful Retrieval of Dynamic Stories","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/dynamic_stories?limit=2","protocol":"https","host":["api","activedemand","com"],"path":["v1","dynamic_stories"],"query":[{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[{\n \"id\": 1,\n \"name\": \"Exciting Product Launch Next Week!\",\n \"account_id\": 101,\n \"target_url\": \"https://example.com/product-launch-details\",\n \"target_name\": \"Learn More\",\n \"tag_list\": [\"Product Launch\", \"New Features\"],\n \"category_list\": [\"Announcements\"],\n \"excerpt\": \"Get ready for our biggest product update yet. New features, improved performance, and more!\",\n \"timestamp\": \"2023-11-01T10:00:00.000Z\",\n \"source\": \"Marketing Team Blog\",\n \"is_archived\": false,\n \"created_by\": 201,\n \"is_deleted\": false,\n \"expires_on\": \"2024-11-01T10:00:00.000Z\",\n \"updated_by\": 201,\n \"created_at\": \"2023-10-28T09:30:00.000Z\",\n \"updated_at\": \"2023-10-28T10:15:00.000Z\",\n \"image\": {\n \"id\": 55,\n \"image_file_name\": \"product_launch_banner.jpg\",\n \"image_content_type\": \"image/jpeg\",\n \"image_file_size\": 120540,\n \"image_updated_at\": \"2023-10-28T09:25:00.000Z\",\n \"url\": \"/system/images/images/000/000/055/original/product_launch_banner.jpg?1698485100\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Tech Conference Highlights\",\n \"account_id\": 101,\n \"target_url\": \"https://example.com/conference-recap\",\n \"target_name\": \"Read Recap\",\n \"tag_list\": [\"Conference\", \"Technology\", \"Networking\"],\n \"category_list\": [\"Events\", \"Industry News\"],\n \"excerpt\": \"A quick look at the key takeaways and announcements from the Global Tech Summit 2023.\",\n \"timestamp\": \"2023-10-25T15:00:00.000Z\",\n \"source\": \"Events Coverage\",\n \"is_archived\": false,\n \"created_by\": 202,\n \"is_deleted\": false,\n \"expires_on\": null,\n \"updated_by\": 202,\n \"created_at\": \"2023-10-25T14:00:00.000Z\",\n \"updated_at\": \"2023-10-25T14:30:00.000Z\",\n \"image\": null\n }\n]"},{"id":"ce5a20a5-fd87-4206-85fd-1b74bcc533f9","name":"Unauthorized - API Key Missing or Invalid","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/dynamic_stories"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Account not found or not authenticated\"\n}"}],"_postman_id":"765aa964-c983-43e0-b8ba-8375cd0a40dc"},{"name":"Get Dynamic Story","id":"b10be9ac-2db2-46eb-86ce-6f0c43135345","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/api/v1/dynamic_stories/{{dynamic-story-id}}","description":"Retrieves a specific dynamic story by its ID.
\n","urlObject":{"protocol":"https","path":["api","v1","dynamic_stories","{{dynamic-story-id}}"],"host":["api","activedemand","com"],"query":[],"variable":[{"id":"dd4fb50a-dd75-460b-9912-d4375d82bb27","description":{"content":"The ID of the dynamic story to retrieve.
\n","type":"text/plain"},"type":"any","value":"{{dynamic-story-id}}","key":"id"}]}},"response":[{"id":"37ac0525-1939-4564-9f55-90cbcb400008","name":"Successful Retrieval of a Dynamic Story","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/dynamic_stories/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"Exciting Product Launch Next Week!\",\n \"account_id\": 101,\n \"target_url\": \"https://example.com/product-launch-details\",\n \"target_name\": \"Learn More\",\n \"tag_list\": [\"Product Launch\", \"New Features\"],\n \"category_list\": [\"Announcements\"],\n \"excerpt\": \"Get ready for our biggest product update yet. New features, improved performance, and more!\",\n \"timestamp\": \"2023-11-01T10:00:00.000Z\",\n \"source\": \"Marketing Team Blog\",\n \"is_archived\": false,\n \"created_by\": 201,\n \"is_deleted\": false,\n \"expires_on\": \"2024-11-01T10:00:00.000Z\",\n \"updated_by\": 201,\n \"created_at\": \"2023-10-28T09:30:00.000Z\",\n \"updated_at\": \"2023-10-28T10:15:00.000Z\",\n \"image\": {\n \"id\": 55,\n \"image_file_name\": \"product_launch_banner.jpg\",\n \"image_content_type\": \"image/jpeg\",\n \"image_file_size\": 120540,\n \"image_updated_at\": \"2023-10-28T09:25:00.000Z\",\n \"url\": \"/system/images/images/000/000/055/original/product_launch_banner.jpg?1698485100\"\n }\n}"},{"id":"09963a39-b725-4414-bd4c-e39c9b92c190","name":"Dynamic Story Not Found","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/dynamic_stories/99999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"DynamicStory not found\"\n}"}],"_postman_id":"b10be9ac-2db2-46eb-86ce-6f0c43135345"},{"name":"Create Dynamic Story","id":"9d649920-3c1b-477b-ac4a-f9502a17db9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dynamic_story\": {\n \"name\": \"Our Newest Innovation\",\n \"target_url\": \"https://example.com/innovation-page\",\n \"target_name\": \"Discover Now\",\n \"excerpt\": \"Learn about the latest breakthrough from our R&D team.\",\n \"tag_list\": \"Innovation, Technology, Future\",\n \"category_list\": \"R&D, Updates\",\n \"timestamp\": \"2023-11-15T12:00:00Z\",\n \"source\": \"Company News\",\n \"expires_on\": \"2024-01-15T12:00:00Z\",\n \"image_url\": \"https://images.example.com/innovation_story.png\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.activedemand.com/api/v1/dynamic_stories","description":"Creates a new dynamic story. account_id is automatically assigned. image_url can be provided to fetch and attach an image.
Updates an existing dynamic story. Only provided fields will be updated. image_url can be used to replace the existing image.
The ID of the dynamic story to update.
\n","type":"text/plain"},"type":"any","value":"{{dynamic-story-id}}","key":"id"}]}},"response":[{"id":"1133ad96-b3b7-456b-a773-ceee3e753327","name":"Dynamic Story Updated Successfully","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"dynamic_story\": {\n \"name\": \"Updated: Our Newest Innovation\"\n }\n}"},"url":"https://api.activedemand.com/v1/dynamic_stories/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"name\": \"Updated: Our Newest Innovation\",\n \"account_id\": 101,\n \"target_url\": \"https://example.com/innovation-page\",\n \"target_name\": \"Discover Now\",\n \"tag_list\": [\"Innovation\", \"Technology\", \"Future\"],\n \"category_list\": [\"R&D\", \"Updates\"],\n \"excerpt\": \"An updated excerpt about the latest breakthrough.\",\n \"timestamp\": \"2023-11-15T12:00:00.000Z\",\n \"source\": \"Company News\",\n \"is_archived\": true,\n \"created_by\": null,\n \"is_deleted\": false,\n \"expires_on\": \"2024-01-15T12:00:00.000Z\",\n \"updated_by\": null,\n \"created_at\": \"2023-10-28T11:00:00.000Z\",\n \"updated_at\": \"2023-10-28T11:30:00.000Z\",\n \"image\": {\n \"id\": 57,\n \"image_file_name\": \"new_innovation_image.jpg\",\n \"image_content_type\": \"image/jpeg\",\n \"image_file_size\": 150220,\n \"image_updated_at\": \"2023-10-28T11:29:00.000Z\",\n \"url\": \"/system/images/images/000/000/057/original/new_innovation_image.jpg?1698488940\"\n }\n}"},{"id":"7caf5c0f-ca4f-432d-a804-32d4bca2dd8f","name":"Unprocessable Entity - Empty Parameters","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"dynamic_story\": {}\n}"},"url":"https://api.activedemand.com/v1/dynamic_stories/3"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Dynamic story parameters cannot be empty\"\n}"}],"_postman_id":"92a921cb-269e-4bc0-898e-0da31b488409"},{"name":"Delete Dynamic Story","id":"74c34e8b-19c4-4551-9fe9-189dc26022ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/api/v1/dynamic_stories/{{dynamic-story-id}}","description":"Soft-deletes a dynamic story (marks is_deleted as true).
The ID of the dynamic story to delete.
\n","type":"text/plain"},"type":"any","value":"{{dynamic-story-id}}","key":"id"}]}},"response":[{"id":"4458135a-0910-4cd4-8582-2a423cb1c210","name":"Dynamic Story Deleted Successfully","originalRequest":{"method":"DELETE","header":[],"url":"https://api.activedemand.com/v1/dynamic_stories/3"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b5bc3906-163a-42c1-80ec-a00a05acfaa4","name":"Dynamic Story Not Found","originalRequest":{"method":"DELETE","header":[],"url":"https://api.activedemand.com/v1/dynamic_stories/99999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"DynamicStory not found\"\n}"}],"_postman_id":"74c34e8b-19c4-4551-9fe9-189dc26022ad"},{"name":"Get Dynamic Story Topics","id":"754f3f56-88c5-40f6-bfa9-214c53580f73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/api/v1/dynamic_stories/topics","description":"Retrieves all unique topics (tags) used in dynamic stories for the authenticated account, along with their counts.
\n","urlObject":{"protocol":"https","path":["api","v1","dynamic_stories","topics"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"089d9134-aad8-4be9-a666-888c6d6e1195","name":"Successful Retrieval of Topics","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/dynamic_stories/topics"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 10,\n \"name\": \"Product Launch\",\n \"count\": 5\n },\n {\n \"id\": 11,\n \"name\": \"Technology\",\n \"count\": 12\n },\n {\n \"id\": 15,\n \"name\": \"Innovation\",\n \"count\": 8\n }\n]"}],"_postman_id":"754f3f56-88c5-40f6-bfa9-214c53580f73"},{"name":"Get Dynamic Story Categories","id":"0b97b95b-3004-46a1-8ade-739ae7ce8c54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/api/v1/dynamic_stories/categories","description":"Retrieves all unique categories used in dynamic stories for the authenticated account, along with their counts.
\n","urlObject":{"protocol":"https","path":["api","v1","dynamic_stories","categories"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"5fddb456-fa5c-4840-9e31-4f15d2d39207","name":"Successful Retrieval of Categories","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/dynamic_stories/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 20,\n \"name\": \"Announcements\",\n \"count\": 10\n },\n {\n \"id\": 22,\n \"name\": \"Events\",\n \"count\": 7\n },\n {\n \"id\": 25,\n \"name\": \"Updates\",\n \"count\": 15\n }\n]"}],"_postman_id":"0b97b95b-3004-46a1-8ade-739ae7ce8c54"}],"id":"3031f355-8de0-4a34-9137-b833d7ca0cfb","description":"Endpoints for managing dynamic content stories.
\n","_postman_id":"3031f355-8de0-4a34-9137-b833d7ca0cfb"},{"name":"Dynamic Story Boards","item":[{"name":"Get dynamic story boards","id":"a6c95e6b-421b-40c6-8f13-0aa431909fcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/dynamic_story_boards.json","description":"This endpoint returns a list of dynamic story boards associated with the employee's account
\n","urlObject":{"protocol":"https","path":["v1","dynamic_story_boards.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6c95e6b-421b-40c6-8f13-0aa431909fcb"},{"name":"Get dyanmic story board","id":"964046df-470d-4694-aab4-ace54b3ef023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"activedemand_session_guid","value":"","type":"text"},{"key":"url","value":"","type":"text"},{"key":"ip_address","value":"","type":"text"},{"key":"referer","value":"","type":"text"},{"key":"user_agent","value":"","type":"text"}]},"url":"https://api.activedemand.com/v1/dynamic_story_boards/{{dynamic_story_board-id}}","description":"Given a dynamic story board ID, this endpoint returns the HTML for the story board, if the story board exists within the employee's account. Otherwise, it returns an AccessDenied error
\n","urlObject":{"protocol":"https","path":["v1","dynamic_story_boards","{{dynamic_story_board-id}}"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"964046df-470d-4694-aab4-ace54b3ef023"}],"id":"9732334a-1938-46fe-a5fb-906534e3aed3","_postman_id":"9732334a-1938-46fe-a5fb-906534e3aed3","description":""},{"name":"Contact Lists","item":[{"name":"Get Static Contact Lists","id":"5a4f49f9-8932-4beb-9208-2a1576209144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/contact_lists?page=0&limit=10&tag=&order=&order_by=","description":"Get all the static contact lists that are visible for sales users for the current account
\n","urlObject":{"protocol":"https","path":["v1","contact_lists"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Current page of resulting contact lists
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Total number of results
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"\"PowerDialer\" - will return on PowerDialer contact lists
\n","type":"text/plain"},"key":"tag","value":""},{"description":{"content":"asc or desc, defaults to desc
can be created, or updated and defaults to created
Given a contact list, and a contact_ids list, the contacts are added to the given contact list
Comma separated list of contact IDs (eg \"123,234,345\")
\n","type":"text/plain"},"key":"contact_ids","value":""}],"variable":[]}},"response":[],"_postman_id":"ffd9b705-cbf8-4218-8b5d-e593b23d0a01"},{"name":"Remove Contact List Members","id":"de7b5541-a627-4973-b284-a708b7f8e714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://api.activedemand.com/v1/contact_lists/remove_members/12345?contact_ids=","description":"Given a contact list and a contact_ids list of contacts, the contacts are removed from the given list
Comma separated list of contact IDs (eg \"123,234,345\")
\n","type":"text/plain"},"key":"contact_ids","value":""}],"variable":[]}},"response":[],"_postman_id":"de7b5541-a627-4973-b284-a708b7f8e714"}],"id":"5565d512-dd52-412d-a67e-b466791100cd","_postman_id":"5565d512-dd52-412d-a67e-b466791100cd","description":""},{"name":"Contact Segments","item":[{"name":"Get Contact Segments","id":"da5e8a8f-e22a-4926-9a15-35199340d791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/contact_segments?page=0&limit=10&order=&order_by=","description":"Get all the contact segments that are visible for sales users for the current account
\n","urlObject":{"protocol":"https","path":["v1","contact_segments"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Current page of resulting contact lists
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Total number of results
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"asc or desc, defaults to desc
can be created, or updated and defaults to created
Fetches a list of campaigns. By default, it returns manual drip campaigns. Use the campaign_type query parameter to filter for other types like 'Newsletter'.
Filters campaigns by type. Set to 'Newsletter' to get newsletter campaigns. If omitted, returns manual drip campaigns.
\n","type":"text/plain"},"key":"campaign_type","value":"Newsletter"}],"variable":[]}},"response":[{"id":"e45c6c95-0278-49de-a833-8f164e883690","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/campaigns?campaign_type=Newsletter","protocol":"https","host":["api","activedemand","com"],"path":["v1","campaigns"],"query":[{"key":"campaign_type","value":"Newsletter"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"campaigns\": [\n {\n \"id\": 101,\n \"name\": \"Q3 Product Updates\",\n \"workflow\": {\n \"id\": 201,\n \"name\": \"Q3 Newsletter Workflow\",\n \"scheduled_send_date\": \"2023-09-15T10:00:00Z\",\n \"sent_date\": null\n }\n },\n {\n \"id\": 102,\n \"name\": \"August Holiday Special\",\n \"workflow\": {\n \"id\": 202,\n \"name\": \"August Holiday Workflow\",\n \"scheduled_send_date\": null,\n \"sent_date\": \"2023-08-10T11:30:00Z\"\n }\n }\n ]\n}"}],"_postman_id":"cf4ff9bb-6210-44fc-9820-5580133f05eb"},{"name":"Get a specific Campaign","id":"db2cfc76-8c81-48d2-afb2-7cd3746c3bc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/api/campaigns/:id","description":"Fetches the details of a single campaign, including its workflows and the email HTML for sales newsletter campaigns.
\n","urlObject":{"protocol":"https","path":["api","campaigns",":id"],"host":["api","activedemand","com"],"query":[],"variable":[{"id":"d4cb52e6-68c9-4cce-8e11-d1fa7c8fa8ce","type":"any","key":"id"}]}},"response":[{"id":"77874c3f-4f2e-483e-a9d9-58701f0e8b6a","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/campaigns/:id","protocol":"https","host":["api","activedemand","com"],"path":["v1","campaigns",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 101,\n \"name\": \"Q3 Product Updates\",\n \"workflow\": {\n \"id\": 201,\n \"name\": \"Q3 Newsletter Workflow\",\n \"scheduled_send_date\": \"2023-09-15T10:00:00Z\",\n \"sent_date\": null,\n \"email_html\": \"Creates a new newsletter campaign and its associated workflow.
\n","urlObject":{"protocol":"https","path":["v1","campaigns.json"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[{"id":"d808b51b-7b2c-4911-960e-62d1e150a55d","name":"Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/campaigns.json"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 103,\n \"name\": \"New Year Promo\",\n \"workflow\": {\n \"id\": 203,\n \"name\": \"New Year Promo Workflow\",\n \"scheduled_send_date\": \"2024-01-01T09:00:00Z\",\n \"sent_date\": null,\n \"email_html\": \"Creates a new workflow and attaches it to an existing campaign.
\n","urlObject":{"protocol":"https","path":["v1","campaigns",":campaign_id","workflows.json"],"host":["api","activedemand","com"],"query":[],"variable":[{"id":"338802d1-ac9a-48d7-ab8d-55b14386554b","type":"any","value":"103","key":"campaign_id"}]}},"response":[{"id":"c24f3606-6f79-4ef5-8f9d-8e63c7681d94","name":"Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/campaigns/103/workflows.json"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 103,\n \"name\": \"New Year Promo\",\n \"workflow\": {\n \"id\": 205,\n \"name\": \"February Newsletter Workflow\",\n \"scheduled_send_date\": \"2024-02-01T09:00:00Z\",\n \"sent_date\": null,\n \"email_html\": \"Updates an existing campaign and its associated workflow.
\n","urlObject":{"protocol":"https","path":["v1","campaigns",":campaign_id","workflows",":workflow_id.json"],"host":["api","activedemand","com"],"query":[],"variable":[{"id":"39d122e5-0ca7-4f1d-a960-1a597dc604ac","type":"any","value":"103","key":"campaign_id"},{"id":"0d116150-bcd0-4f1a-b411-5f808c545d4b","type":"any","value":"203","key":"workflow_id"}]}},"response":[{"id":"40bb811b-d9e8-4b65-a528-c5dc8553f805","name":"Success Response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/campaigns/103/workflows/203.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 103,\n \"name\": \"Updated New Year Promo\",\n \"workflow\": {\n \"id\": 203,\n \"name\": \"Updated New Year Promo Workflow\",\n \"scheduled_send_date\": \"2024-01-02T10:00:00Z\",\n \"sent_date\": null,\n \"email_html\": \"Given a contact_id, this endpoint returns the membership details of the contact in all currently uncompleted User Drip Campaigns.
Given a campaign and a list of contact_ids, the contact(s) are added to the campaign
Given a campaign and a list of contact_ids, the contact(s) are removed from the campaign
Activates a workflow on a campaign, making it live and ready to execute.
\n","urlObject":{"protocol":"https","path":["v1","campaigns",":campaign_id","workflows",":workflow_id","activate.json"],"host":["api","activedemand","com"],"query":[],"variable":[{"id":"a4a9289b-bb19-400e-b76b-c9acc18ff8f0","type":"any","value":"101","key":"campaign_id"},{"id":"7ae78135-8457-46ce-809d-0ee5dc4f7c2f","type":"any","value":"201","key":"workflow_id"}]}},"response":[{"id":"10d3c263-2b3e-48bd-acb0-b6ad340172d2","name":"Success Response","originalRequest":{"method":"POST","header":[],"url":"https://api.activedemand.com/v1/campaigns/101/workflows/201/activate.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Workflow has been activated.\"\n}"}],"_postman_id":"344116e4-2175-4c54-9e7c-30c6a0db565a"},{"name":"Deactivate Workflow","id":"74906d08-93b8-4af8-b86f-5a3478844725","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"}],"url":"https://api.activedemand.com/v1/campaigns/:campaign_id/workflows/:workflow_id/deactivate.json","description":"Deactivates a workflow on a campaign, pausing its execution.
\n","urlObject":{"protocol":"https","path":["v1","campaigns",":campaign_id","workflows",":workflow_id","deactivate.json"],"host":["api","activedemand","com"],"query":[],"variable":[{"id":"e8148236-f5b5-4bb9-b5b4-01d5de3b92ca","type":"any","value":"101","key":"campaign_id"},{"id":"157691d0-6368-4ad3-8886-d068db98d279","type":"any","value":"201","key":"workflow_id"}]}},"response":[{"id":"1731dc5d-07e0-4563-92b7-91aa61a2c010","name":"Success Response","originalRequest":{"method":"DELETE","header":[],"url":"https://api.activedemand.com/v1/campaigns/101/workflows/201/deactivate.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Workflow has been deactivated.\"\n}"}],"_postman_id":"74906d08-93b8-4af8-b86f-5a3478844725"}],"id":"ac5d78f4-d85c-4eec-a688-fd10dea0a27c","_postman_id":"ac5d78f4-d85c-4eec-a688-fd10dea0a27c","description":""},{"name":"Campaign Goals","item":[{"name":"GET Campaign Goals","id":"e82e1549-2544-4d12-ba3c-b554f6da33fd","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true}},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/campaign_goals?page=2&per_page=15&include_inactive=false","description":"List all the campaign goals for your account.
\n","urlObject":{"protocol":"https","path":["v1","campaign_goals"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Pagination - (Optional) Defaults to 0
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"Pagination - (Optional) Defaults to 10, maximum 500.
\n","type":"text/plain"},"key":"per_page","value":"15"},{"description":{"content":"Use this to indicate if goals from inactive campaigns should be included in the the results. (Optional) true | false. Defaults to false.
\n","type":"text/plain"},"key":"include_inactive","value":"false"}],"variable":[]}},"response":[],"_postman_id":"e82e1549-2544-4d12-ba3c-b554f6da33fd"},{"name":"GET Campaign Goals For Single Campaign","id":"60e8edd5-2a65-4bd9-8218-af53a7414e4f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true}},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/campaigns/{{campign_id}}/campaign_goals?page=2&per_page=15&tags[]=October&tags[]=click","description":"List all the campaign goals for a single campaign.
\n","urlObject":{"protocol":"https","path":["v1","campaigns","{{campign_id}}","campaign_goals"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Pagination - (Optional) Defaults to 0
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"Pagination - (Optional) Defaults to 10, maximum 500.
\n","type":"text/plain"},"key":"per_page","value":"15"},{"description":{"content":"Campaign goal must be tagged with all the listed tags. A maximum of 5 tags allowed for filtering.
\n","type":"text/plain"},"key":"tags[]","value":"October"},{"description":{"content":"Campaign goal must be tagged with all the listed tags. A maximum of 5 tags allowed for filtering.
\n","type":"text/plain"},"key":"tags[]","value":"click"}],"variable":[]}},"response":[],"_postman_id":"60e8edd5-2a65-4bd9-8218-af53a7414e4f"}],"id":"a59e4307-1fe8-44fc-9825-876f6db388cd","_postman_id":"a59e4307-1fe8-44fc-9825-876f6db388cd","description":""},{"name":"Client Account Management","item":[{"name":"Template Accounts","item":[{"name":"GET Template Accounts","id":"67364d91-eb78-4efd-a90b-008844f4e954","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true}},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"","variables":""}},"url":"https://api.activedemand.com/v1/template_accounts?page=2&limit=15","description":"List all the template accounts for your account.
\n","urlObject":{"protocol":"https","path":["v1","template_accounts"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Pagination - (Optional) Defaults to 0
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"Pagination - (Optional) Defaults to 10, maximum 500.
\n","type":"text/plain"},"key":"limit","value":"15"}],"variable":[]}},"response":[],"_postman_id":"67364d91-eb78-4efd-a90b-008844f4e954"}],"id":"2f4b1078-cc03-488d-a07b-f5500c8ce151","description":"This endpoint can be used to list the template accounts associated with the requesting account API key.
\n","_postman_id":"2f4b1078-cc03-488d-a07b-f5500c8ce151"},{"name":"Agencies","item":[{"name":"GET Agencies","id":"c33c480e-7de6-461d-b294-b7420cd91c97","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true}},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/agencies?page=2&limit=15","description":"List all the agencies for your account.
\n","urlObject":{"protocol":"https","path":["v1","agencies"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Pagination - (Optional) Defaults to 0
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"Pagination - (Optional) Defaults to 10, maximum 500.
\n","type":"text/plain"},"key":"limit","value":"15"}],"variable":[]}},"response":[],"_postman_id":"c33c480e-7de6-461d-b294-b7420cd91c97"}],"id":"e6c809bd-ac35-4dce-b435-ac1ccfdf41b5","description":"This endpoint can be used to list the agency accounts associated with the requesting account API key.
\n","_postman_id":"e6c809bd-ac35-4dce-b435-ac1ccfdf41b5"},{"name":"Clients","item":[{"name":"GET Clients","id":"52ae8e3e-ba7e-48d1-815f-2fa6474baf80","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true}},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/clients?page=2&limit=15","description":"List the client accounts for your account.
\n","urlObject":{"protocol":"https","path":["v1","clients"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Pagination - (Optional) Defaults to 0
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"Pagination - (Optional) Defaults to 10, maximum 500.
\n","type":"text/plain"},"key":"limit","value":"15"}],"variable":[]}},"response":[],"_postman_id":"52ae8e3e-ba7e-48d1-815f-2fa6474baf80"},{"name":"Create Client","id":"31f68aed-3b86-483e-9552-204f3b101fda","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true,"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"business_name\": \"Goggle\",\n \"url\": \"https://goggle.com\",\n \"page_url\": \"landing.goggle.com\",\n \"link_replace_url\": \"branding.goggle.com\",\n \"login_link_url\": \"login.goggle.com\",\n \"email_url\": \"gmail.com\",\n \"cname_endpoint\": \"cname.goggle.com\",\n \"product\": \"SmallBusinessMarketer\",\n \"template_id\": \"\",\n \"address\": \"\",\n \"address_city\": \"\",\n \"address_postal_code\": \"\",\n \"address_country\": \"\",\n \"sales_contact_id\": \"\",\n \"technical_contact_id\": \"0\",\n \"tech_contact_sales_list\": \"1\",\n \"address_suite_no\": \"\",\n \"phone_number\": \"\",\n \"email_address\": \"\",\n \"datetime_format\": \"MM/dd/yyyy\",\n \"agency_account_id\": 1,\n \"action\": \"create_sub_account\"\n}"},"url":"https://api.activedemand.com/v1/clients","description":"Creates a new client account.
\n","urlObject":{"protocol":"https","path":["v1","clients"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"31f68aed-3b86-483e-9552-204f3b101fda"}],"id":"3013c444-f641-433e-ad0f-44d7736796b8","description":"This collection of endpoints can be used to list and create clients for an agency account.
\n","_postman_id":"3013c444-f641-433e-ad0f-44d7736796b8"},{"name":"Employees","item":[{"name":"GET Employees","id":"1c6f7b3c-0ddf-4296-8b61-7781d1aefcc9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true}},"request":{"method":"GET","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.activedemand.com/v1/employees?client_account_id=12345&page=2&limit=15","description":"List the employees for the selected client account.
\n","urlObject":{"protocol":"https","path":["v1","employees"],"host":["api","activedemand","com"],"query":[{"description":{"content":"Optional. Defaults to the account registered to the API Key when not specified.
\n","type":"text/plain"},"key":"client_account_id","value":"12345"},{"description":{"content":"Pagination - (Optional) Defaults to 0
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"Pagination - (Optional) Defaults to 10, maximum 500.
\n","type":"text/plain"},"key":"limit","value":"15"}],"variable":[]}},"response":[],"_postman_id":"1c6f7b3c-0ddf-4296-8b61-7781d1aefcc9"},{"name":"Create Employee","id":"7d5ae235-65f5-4248-bf7f-1da0fe5e4135","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true,"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"xxxxx-xxxxxx-xxxxx-xxxxx","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Mr\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"john.does@example.com\",\n \"phone_number\": \"555-123-4567\",\n \"client_account_id\": 1069904565\n}"},"url":"https://api.activedemand.com/v1/employees","description":"Create a new employee for a client account.
\n","urlObject":{"protocol":"https","path":["v1","employees"],"host":["api","activedemand","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d5ae235-65f5-4248-bf7f-1da0fe5e4135"}],"id":"8465b22b-9e81-4521-8cdf-4888742a2a0b","description":"This collection of endpoints can be used to list and create employees for a client account.
\n","_postman_id":"8465b22b-9e81-4521-8cdf-4888742a2a0b"}],"id":"370f4769-4b56-455f-b049-540150be8796","_postman_id":"370f4769-4b56-455f-b049-540150be8796","description":""},{"name":"Sales Email Templates","item":[{"name":"Get Sales Email Templates","id":"22a37dae-5c73-42d8-b842-85748f7ad9a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}"}],"url":"https://api.activedemand.com/v1/sales_email_templates?page=1&limit=10","description":"This endpoint retrieves a paginated list of all sales email templates for the authenticated account.
\n","urlObject":{"protocol":"https","path":["v1","sales_email_templates"],"host":["api","activedemand","com"],"query":[{"description":{"content":"The page number for pagination. Defaults to 0.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items to return per page. Defaults to 100.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"fd309f4c-2eeb-4582-b697-397ab0305b10","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.activedemand.com/v1/sales_email_templates?page=1&limit=10","protocol":"https","host":["api","activedemand","com"],"path":["v1","sales_email_templates"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"id\":58968,\"name\":\"Sales Temp1\",\"preview_url\":\"https://example.com/preview-image-1.png\"},{\"id\":58977,\"name\":\"Sales Temp 2\",\"preview_url\":\"https://example.com/preview-image-2.png\"}],\"metadata\":{\"current_page\":1,\"last_page\":1,\"page_count\":2,\"total_count\":2}}"}],"_postman_id":"22a37dae-5c73-42d8-b842-85748f7ad9a9"},{"name":"Get Sales Email Template","id":"7a41d371-527c-4e8a-b2f5-c55ba7860608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}"}],"url":"https://api.activedemand.com/v1/sales_email_templates/:id","description":"This endpoint retrieves the details of a single sales email template.
\n","urlObject":{"protocol":"https","path":["v1","sales_email_templates",":id"],"host":["api","activedemand","com"],"query":[],"variable":[{"id":"5f237d20-ef1c-453b-bfde-b8e07ba849a4","type":"any","value":"1","key":"id"}]}},"response":[{"id":"78c70538-71d3-4cb4-8446-dafbe8934f59","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.activedemand.com/v1/sales_email_templates/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"Sales Template 1\",\n \"preview_url\": \"https://example.com/preview-image-1.png\",\n \"email_text\": \"This is the email content.
\"\n}"}],"_postman_id":"7a41d371-527c-4e8a-b2f5-c55ba7860608"},{"name":"Update Sales Email Template","id":"a2ee024b-ffde-4cb3-be5e-c9bcccf89d67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"xxxxx-xxxxxx-xxxxx-xxxxx"},{"key":"X-Application-Api-Key","value":"{{application-api-key}}"}],"body":{"mode":"raw","raw":"{\n \"email_text\": \"This is the updated email content.\"\n}"},"url":"https://api.activedemand.com/v1/sales_email_templates/:id","description":"This endpoint updates the html of the User Content block associated with a sales email template.