The LeadCenter.AI API is a REST API that uses JSON for all requests and responses. It provides endpoints to manage leads, users, notes, tasks, calendar and other resources.
\nAll endpoints require authentication via a Bearer token, which is provided after a successful login or registration, or generated from the LeadCenter.AI CRM Settings → Integrations page (Web Interface), or obtained through the OAuth 2.0 flow.
\nLeadCenter.AI uses standard HTTP response codes to indicate the status of an API request. Generally, 2xx response codes indicate success, 4xx represents a problem that occurred (e.x., authentication token was not included in request, or required fields were not present to create a \"contact\"). 5xx codes indicate there was an error on the server, even though your request appears valid.
\nThis requires both per_page and a page parameter to be passed when retrieving paginated data.
{\n \"data\": [{...}, {...}, {...}, {...}],\n \"links\": {\n \"first\": \"{{domain}}/v1/task-lists?page=1\",\n \"last\": \"{{domain}}/v1/task-lists?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"{{domain}}/v1/task-lists?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"{{domain}}/v1/task-lists\",\n \"per_page\": 10,\n \"to\": 4,\n \"total\": 4\n }\n}\n\n\n\nEach request made to the API will generate a JSON response. The responses can be classified into 3 distinct types.
\n
When returning a single resource, the object is represented as a JSON object of its properties.
\nWhen returning a collection of resources, the response is an array of objects ([{}]) by default. If the collection is paginated, the response is wrapped in a JSON object with a data property, and includes meta and links for pagination details.
When a request is unsuccessful, the API returns a JSON object with three keys: success (set to false), message (providing a brief overview of the error), and errors (containing one or more specific error details).
This endpoint allows the user to log in by sending a POST request to the specified URL. The request should include the user's email and password in the request body.
\nemail (string): The email of the user.
\npassword (string): The password of the user.
\nThe response will be in JSON format with the following schema:
\n{\n \"access_token\": \"******************************\",\n \"token_type\": \"bearer\"\n}\n\n{\n \"message\": \"The provided credentials are incorrect.\",\n \"errors\": [\n \"The provided credentials are incorrect.\"\n ],\n \"success\": false\n}\n\nThis endpoint allows you to register a new user.
\nname (string): The name of the user.
email (string): The email address of the user.
password (string): The password for the user account.
mobile (string): The mobile number of the user.
{\n \"access_token\": \"161|5DbnqqNSvTXZRxbYCJuR7iG2J55T7CRHSFo07PfU099f3cb3\",\n \"token_type\": \"bearer\"\n}\n\n{\n \"message\": \"Validation failed\",\n \"errors\": [\n \"The email has already been taken.\"\n \"The password field must be at least 8 characters.\"\n ],\n \"success\": false\n}\n\nThis endpoint is used to initiate the process of resetting a user's password by sending a reset code to the provided email address.
\nemail (string, required): The email address for which the password reset link will be sent.
The response will indicate the success or failure of the request to initiate the password reset process.
\n{\n \"message\": \"If the provided email is associated with an account, a reset code will be sent.\"\n}\n\n{\n \"message\": \"The email field must be a valid email address.\",\n \"errors\": [\n \"The email field must be a valid email address.\"\n ],\n \"success\": false\n}\n\nThis endpoint is used to reset the password for a user account.
\npassword (string, required): The new password for the user account.
password_confirmation (string, required): The confirmation of the new password.
token (string, required): The reset token received by the user.
email (string, required): The email address of the user.
The response will indicate the success or failure of the password reset request.
\n{\n \"message\": \"Password has been reset successfully\"\n}\n\n{\n \"message\": \"Invalid token\",\n \"errors\": [\"Token expired or invalid\"],\n \"success\": false\n}\n\nThis endpoint is used to verify the user's email by providing the verification token.
\ntoken (string, required): The verification token received by the user.
{\n \"message\": \"Email verified successfully\"\n}\n\n{\n \"message\": \"Validation failed\",\n \"errors\": [\"Token is required\"],\n \"success\": false\n}\n\nAll requests to LeadCenter.AI must be authenticated. You can authorize requests either by using a personal API access token (available in your user settings) or by obtaining a token through the Login or Register endpoints.
\nLeadCenter’s API supports OAuth 2.0 authentication using both the authorization code grant and refresh token flow, as outlined in RFC 6749. Access is granted on a per-user basis, meaning each user’s permissions may vary.
\nTo get started, you'll need to register your application so we can provide a unique client ID and client secret. The client ID is safe to expose during the authorization flow, while the client secret must be kept confidential—it's used to verify your app’s identity with LeadCenter. If you think your secret has been exposed, reach out to us right away to get it rotated.
\nTo request credentials and register your app, email us at support@leadcenter.ai with details about your application.
\nRedirect the user to:
\nhttps://app.leadcenter.ai/oauth/authorize
Parameters
\nclient_id: Must match what was sent to support@leadcenter.ai
redirect_uri: Must match what was sent to support@leadcenter.ai
response_type: code
scope: Optional
Example
\nhttps://app.leadcenter.ai/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&response_type=code&scope=\\\\*
If the user is not already logged into LeadCenter.ai, they’ll be prompted to log in and then approve access for your application.
\nAfter the user grants access, they’ll be redirected back to your redirect_uri with an authorization code.
Exchange this code for an access token by making a POST request to:
https://app.leadcenter.ai/oauth/token
Example request body:
\n{\n \"client_id\":\"CLIENT_ID\",\n \"client_secret\":\"CLIENT_SECRET\",\n \"code\":\"AUTHORIZATION_CODE\",\n \"grant_type\":\"authorization_code\",\n \"redirect_uri\":\"CALLBACK_URL\"\n}\n\nExample response body:
\n{\n \"access_token\": \"eyjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"created_at\": 10588285800,\n \"expires_in\": 7200,\n \"refresh_token\": \"eyjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"scope\": \"\",\n \"token_type\": \"Bearer\"\n}\n\nTo obtain a new access token using the refresh token:
\nPOST https://app.leadcenter.ai/oauth/token
{\n \"client_id\":\"CLIENT_ID\",\n \"client_secret\":\"CLIENT_SECRET\",\n \"code\":\"AUTHORIZATION_CODE\",\n \"grant_type\":\"refresh_token\",\n \"refresh_token\":\"REFRESH_TOKEN\"\n}\n\nReturns a collection of all email messages sent to or received from the lead. Each entry includes metadata such as subject, sender, recipient, timestamp, and status (e.g., delivered, opened).
\n","_postman_id":"00d8b5f4-4b29-4ca3-a1fb-00cf660e5d80","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Calls","item":[{"name":"List","id":"d8687e97-ae70-4262-a3d3-0ec5f37c75f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{domain}}/v1/leads/:id/communication/calls","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","communication","calls"],"host":["{{domain}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"e9dbc518-75b9-4894-9b6d-091615f78d7b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/communication/calls","host":["{{domain}}"],"path":["v1","leads",":id","communication","calls"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 15:34:55 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 78577,\n \"call_sid\": \"CA34c159a89a480402b5e422d4daece6a5\",\n \"lead_id\": 461168,\n \"lead\": {\n \"id\": 461168,\n \"first_name\": \"John\",\n \"last_name\": \"Carter\",\n \"email\": \"john.carter@example.com\",\n \"phone\": \"+14029510921\",\n \"created_at\": \"2025-05-01T10:15:00Z\",\n \"updated_at\": \"2025-05-12T11:30:00Z\"\n },\n \"direction\": \"outbound-dial\",\n \"call_type\": \"inbound\",\n \"caller_number\": \"+99999999999\",\n \"called_number\": \"+55555555555\",\n \"call_status\": \"completed\",\n \"duration\": 25,\n \"is_private\": false\n }\n]"},{"id":"317703c0-3e66-4493-9e02-77ca1c5807f4","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/communication/calls","host":["{{domain}}"],"path":["v1","leads",":id","communication","calls"],"variable":[{"key":"id","value":"4611681"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 15:39:41 GMT"},{"key":"phpdebugbar-id","value":"X5e2affb6782d291e080a68a03023466d"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"d8687e97-ae70-4262-a3d3-0ec5f37c75f2"}],"id":"e56a7dd5-affa-4d9d-a404-de045a2c23fe","description":"Contains a history of phone calls associated with the lead. Each call record includes the call type (inbound/outbound), duration, timestamp, and optional notes or call summaries.
\n","_postman_id":"e56a7dd5-affa-4d9d-a404-de045a2c23fe","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Messages","item":[{"name":"List","id":"79028b3d-85ab-4804-a313-206a6972a38d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{domain}}/v1/leads/:id/communication/messages","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","communication","messages"],"host":["{{domain}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"1ec3fa16-2d69-443b-a163-2354fb116fe1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/communication/messages","host":["{{domain}}"],"path":["v1","leads",":id","communication","messages"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 15:45:12 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 43504,\n \"lead_id\": 461168,\n \"lead\": {\n \"id\": 461168,\n \"first_name\": \"John\",\n \"last_name\": \"Carter\",\n \"email\": \"john.carter@example.com\",\n \"phone\": \"+14029510921\",\n \"created_at\": \"2025-05-01T10:15:00Z\",\n \"updated_at\": \"2025-05-12T11:30:00Z\"\n },\n \"from\": \"+12818004771\",\n \"to\": \"+919953846309\",\n \"message\": \"Hi John, just a reminder — you have an appointment with Steve Doe on Tuesday, January 28th at 8:00 PM (EST). Reply 1 to confirm, 2 to reschedule, or 3 to cancel.\",\n \"is_outgoing\": true,\n \"is_private\": false,\n \"status\": \"delivered\",\n \"created_at\": \"2025-01-28T14:10:08Z\"\n }\n]\n"},{"id":"69c55745-f808-4c4c-ab6f-3f37f6516cf1","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/communication/messages","host":["{{domain}}"],"path":["v1","leads",":id","communication","messages"],"variable":[{"key":"id","value":"409928"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 15:43:48 GMT"},{"key":"phpdebugbar-id","value":"X4776d3579d47cea48ce033d4350bbac0"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"79028b3d-85ab-4804-a313-206a6972a38d"}],"id":"f8700f84-73f4-476c-bd8c-ce6eb102f78a","description":"Represents SMS or internal chat messages. Each message includes sender/receiver info, content, delivery status, and timestamp.
\n","_postman_id":"f8700f84-73f4-476c-bd8c-ce6eb102f78a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}}],"id":"e5f1faf2-05a3-498b-bc80-8d4626257bfd","description":"The communication resource provides access to all interaction records related to a specific lead
Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"48a9b10c-2c66-4d06-8038-27628eb75c7e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/notes","host":["{{domain}}"],"path":["v1","leads",":id","notes"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 15:50:27 GMT"},{"key":"phpdebugbar-id","value":"Xebcf68abe4fdf719d4485bd0c97ae544"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 83607,\n \"created_by\": 17673,\n \"comment\": \"@MarkDoe please confirm rates\",\n \"lead_id\": 416823,\n \"lead\": {\n \"id\": 416823,\n \"first_name\": \"Joanne\",\n \"last_name\": \"Hettinger-Pacocha\",\n \"email\": \"joanne.hettinger@example.com\",\n \"phone\": \"(708) 379-7184\",\n \"created_at\": \"2025-05-03T00:33:51Z\",\n \"updated_at\": \"2025-05-08T13:18:11Z\"\n },\n \"is_private\": false,\n \"created_at\": \"2025-05-07T09:39:08Z\",\n \"updated_at\": \"2025-05-07T10:03:56Z\"\n }\n]\n"},{"id":"25fd9aa2-d40e-49d1-b6b6-14fb23024c3d","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/notes","host":["{{domain}}"],"path":["v1","leads",":id","notes"],"query":[{"key":"","value":"","type":"text","disabled":true}],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 19:49:58 GMT"},{"key":"phpdebugbar-id","value":"Xbe2c55e41483cf110751699bd2658790"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"57eabe31-3718-4446-bc0f-5f5d724db6e8"},{"name":"Create","id":"33df80e6-8b58-43a2-995d-f09815d9036c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"Client confirmed appointment\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id/notes","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","notes"],"host":["{{domain}}"],"query":[],"variable":[{"description":{"content":"Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e751ea7b-a393-408b-82d2-6f849c94119e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"Client confirmed appointment\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/notes","host":["{{domain}}"],"path":["v1","leads",":id","notes"],"variable":[{"key":"id","value":""}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 19:55:23 GMT"},{"key":"phpdebugbar-id","value":"X2944a8de26120816076509af8b378fa2"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 83611,\n \"created_by\": 17673,\n \"creator\": {\n \"id\": 17673,\n \"first_name\": \"Mark\",\n \"last_name\": \"Joe\",\n \"email\": \"mark.joe@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"comment\": \"Client confirmed appointment\",\n \"appointment_id\": null,\n \"event_id\": null,\n \"lead_id\": 416823,\n \"lead\": {\n \"id\": 416823,\n \"first_name\": \"Joanne\",\n \"last_name\": \"Hettinger-Pacocha\",\n \"email\": \"joanne.hettinger@example.com\",\n \"phone\": \"(708) 379-7184\",\n \"created_at\": \"2025-05-03T00:33:51Z\",\n \"updated_at\": \"2025-05-08T13:18:11Z\"\n },\n \"is_private\": false,\n \"created_at\": \"2025-05-12T19:55:23.000000Z\",\n \"updated_at\": \"2025-05-12T19:55:23.000000Z\"\n}"},{"id":"f7e7417b-0689-450f-b3c5-f49bd38a5d87","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"Client confirmed appointment\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/notes","host":["{{domain}}"],"path":["v1","leads",":id","notes"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 19:57:42 GMT"},{"key":"phpdebugbar-id","value":"Xaffdcba5f8a435bf11a037fe19111549"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"33df80e6-8b58-43a2-995d-f09815d9036c"},{"name":"Update","id":"65cd2b8c-c2d0-4eea-9116-d5bf16ffcccf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"@MarkDoe please confirm rates [UPDATED]\",\n \"is_private\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id/notes/:noteId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","notes",":noteId"],"host":["{{domain}}"],"query":[],"variable":[{"description":{"content":"Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Note ID
\n","type":"text/plain"},"type":"any","value":"","key":"noteId"}]}},"response":[{"id":"ece66d3c-3508-45b6-ae40-1aa67a15ded2","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"@MarkDoe please confirm rates [UPDATED]\",\n \"is_private\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/notes/:noteId","host":["{{domain}}"],"path":["v1","leads",":id","notes",":noteId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"noteId","value":"","description":"Note ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:24:51 GMT"},{"key":"phpdebugbar-id","value":"X9891195efcf61c885c16ac2447522a40"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 83611,\n \"created_by\": 17673,\n \"creator\": {\n \"id\": 17673,\n \"first_name\": \"Mark\",\n \"last_name\": \"Joe\",\n \"email\": \"mark.joe@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"comment\": \"@MarkDoe please confirm rates [UPDATED]\",\n \"appointment_id\": null,\n \"event_id\": null,\n \"lead_id\": 416823,\n \"lead\": {\n \"id\": 416823,\n \"first_name\": \"Joanne\",\n \"last_name\": \"Hettinger-Pacocha\",\n \"email\": \"joanne.hettinger@example.com\",\n \"phone\": \"(708) 379-7184\",\n \"created_at\": \"2025-05-03T00:33:51Z\",\n \"updated_at\": \"2025-05-08T13:18:11Z\"\n },\n \"is_private\": true,\n \"created_at\": \"2025-05-12T19:55:23.000000Z\",\n \"updated_at\": \"2025-05-12T19:55:23.000000Z\"\n}"},{"id":"7ca830df-f31e-43e8-aed4-5bc8819f044e","name":"Error","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"@MarkDoe please confirm rates [UPDATED]\",\n \"is_private\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/notes/:noteId","host":["{{domain}}"],"path":["v1","leads",":id","notes",":noteId"],"variable":[{"key":"id","value":"416823"},{"key":"noteId","value":"83601"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:24:31 GMT"},{"key":"phpdebugbar-id","value":"X5dc85b677c6c97e8d05402dbe20ae479"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Note not found\",\n \"errors\": [\n \"The requested note could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"65cd2b8c-c2d0-4eea-9116-d5bf16ffcccf"},{"name":"Delete","id":"266265f0-d948-4f15-a6dd-554e1d6a2b72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{domain}}/v1/leads/:id/notes/:noteId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","notes",":noteId"],"host":["{{domain}}"],"query":[],"variable":[{"description":{"content":"Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Note ID
\n","type":"text/plain"},"type":"any","value":"","key":"noteId"}]}},"response":[{"id":"f64e4eaf-85bf-4b9f-ac2d-9801a974ea14","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/notes/:noteId","host":["{{domain}}"],"path":["v1","leads",":id","notes",":noteId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"noteId","value":"","description":"Note ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:33:35 GMT"},{"key":"phpdebugbar-id","value":"Xb3aff9c9a545b727c77f436fc80510f6"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Note deleted successfully\"\n}"},{"id":"27092484-ffe9-448f-a880-9613ba4078b4","name":"Error","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id/notes/:noteId","host":["{{domain}}"],"path":["v1","leads",":id","notes",":noteId"],"variable":[{"key":"id","value":"416823","description":"Lead ID"},{"key":"noteId","value":"83611","description":"Note ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:28:50 GMT"},{"key":"phpdebugbar-id","value":"Xb89a154e316de358d8a5264aa09a97bc"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Note not found\",\n \"errors\": [\n \"The requested note could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"266265f0-d948-4f15-a6dd-554e1d6a2b72"},{"name":"Get","id":"c51151f4-dd6a-40f6-bae2-d33537ee3a23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/notes/:noteId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","notes",":noteId"],"host":["{{domain}}"],"query":[],"variable":[{"description":{"content":"Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Note ID
\n","type":"text/plain"},"type":"any","value":"","key":"noteId"}]}},"response":[{"id":"e73cb080-4be8-4e75-80b5-64f2b4862f1e","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/notes/:noteId","host":["{{domain}}"],"path":["v1","leads",":id","notes",":noteId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"noteId","value":"","description":"Note ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:35:26 GMT"},{"key":"phpdebugbar-id","value":"X7c5f94f39c3a67cfbe1862810385bb97"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 83611,\n \"created_by\": 17673,\n \"creator\": {\n \"id\": 17673,\n \"first_name\": \"Mark\",\n \"last_name\": \"Joe\",\n \"email\": \"mark.joe@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"comment\": \"Client confirmed appointment\",\n \"appointment_id\": null,\n \"event_id\": null,\n \"lead_id\": 416823,\n \"lead\": {\n \"id\": 416823,\n \"first_name\": \"Joanne\",\n \"last_name\": \"Hettinger-Pacocha\",\n \"email\": \"joanne.hettinger@example.com\",\n \"phone\": \"(708) 379-7184\",\n \"created_at\": \"2025-05-03T00:33:51Z\",\n \"updated_at\": \"2025-05-08T13:18:11Z\"\n },\n \"is_private\": false,\n \"created_at\": \"2025-05-12T19:55:23.000000Z\",\n \"updated_at\": \"2025-05-12T19:55:23.000000Z\"\n}"},{"id":"e1a26a2d-6142-4a11-9478-b26b4c6c2d81","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/notes/:noteId","host":["{{domain}}"],"path":["v1","leads",":id","notes",":noteId"],"variable":[{"key":"id","value":"416723","description":"Lead ID"},{"key":"noteId","value":"8361","description":"Note ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:36:40 GMT"},{"key":"phpdebugbar-id","value":"Xe306af4b88bd4492583b583cd36c8692"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Note not found\",\n \"errors\": [\n \"The requested note could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"c51151f4-dd6a-40f6-bae2-d33537ee3a23"}],"id":"0de0d48d-5263-4dbf-841c-f638238f8591","_postman_id":"0de0d48d-5263-4dbf-841c-f638238f8591","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Upcoming Activities","item":[{"name":"List","id":"338b9a8b-4a5f-4545-aad1-d589c76115d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/upcoming-activities","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","upcoming-activities"],"host":["{{domain}}"],"query":[],"variable":[{"description":{"content":"Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6b033a30-e1ed-4a26-80fa-b32c5d8f5e74","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/upcoming-activities","host":["{{domain}}"],"path":["v1","leads",":id","upcoming-activities"],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:45:24 GMT"},{"key":"phpdebugbar-id","value":"Xaea31edfd747b0323e5d9a83f13c8da5"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"appointments\": [\n {\n \"id\": 22455,\n \"crm_type\": \"crm:appointment\",\n \"title\": \"Initial Consultation\",\n \"type\": \"appointment\",\n \"lead_id\": 159481,\n \"lead\": {\n \"id\": 159481,\n \"first_name\": \"Elfrieda\",\n \"last_name\": \"Hand\",\n \"email\": \"elfrieda.hand@example.com\",\n \"phone\": \"(312) 555-0198\",\n \"created_at\": \"2023-09-23T09:38:00Z\",\n \"updated_at\": \"2025-05-12T22:45:21Z\"\n },\n \"host_user_calendar_id\": 1109,\n \"host_user_id\": 12345,\n \"host_user\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"creator_id\": 12345,\n \"creator\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"organizers\": [\n {\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\"\n }\n ],\n \"guests\": [],\n \"location\": \"Custom location\",\n \"calendar_ids\": [\n 1109\n ],\n \"start_time\": \"2025-05-14T23:30:00Z\",\n \"end_time\": \"2025-05-15T00:30:00Z\",\n \"is_all_day\": false,\n \"timezone\": \"America/New_York\",\n \"meeting_type\": \"custom\",\n \"meeting_details\": \"Custom location\",\n \"meeting_link_details\": null,\n \"is_private\": false,\n \"comment\": \"Appointments description
\",\n \"is_busy\": true,\n \"user_available_locations\": [],\n \"status_id\": 3,\n \"status\": {\n \"id\": 3,\n \"name\": \"CONFIRMED\",\n \"created_at\": \"2020-07-23T15:55:51.000000Z\",\n \"updated_at\": \"2020-07-23T15:55:51.000000Z\"\n },\n \"parent_id\": null,\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"cancelled_at\": null,\n \"cancellation_reason\": null,\n \"priority\": null,\n \"importance\": null,\n \"category_id\": 622,\n \"category\": {\n \"id\": 622,\n \"tenant_id\": 17673,\n \"source\": \"redtail\",\n \"source_id\": \"4\",\n \"name\": \"Customer Service\",\n \"color\": null,\n \"is_public\": 0,\n \"created_at\": \"2024-03-02T08:15:10.000000Z\",\n \"updated_at\": \"2024-03-02T08:15:10.000000Z\",\n \"deleted_at\": null\n },\n \"appointment_answers\": null,\n \"is_spouse_included\": false,\n \"zoomJoinUrl\": \"\",\n \"spouse\": null,\n \"source\": \"leadcenter\",\n \"source_color\": \"#1f6cc4\",\n \"created_at\": \"2025-05-12T22:44:17.000000Z\",\n \"updated_at\": \"2025-05-12T22:44:30.000000Z\"\n }\n ],\n \"tasks\": [\n {\n \"id\": 20133,\n \"type\": \"task\",\n \"title\": \"Upcoming task\",\n \"owner_id\": 17673,\n \"owner\": {\n \"id\": 17673,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 1109\n },\n \"team_id\": null,\n \"team\": null,\n \"lead_id\": 159481,\n \"lead\": {\n \"id\": 159481,\n \"first_name\": \"Elfrieda\",\n \"last_name\": \"Hand\",\n \"email\": \"elfrieda.hand@example.com\",\n \"phone\": \"(312) 555-0198\",\n \"created_at\": \"2023-09-23T09:38:00Z\",\n \"updated_at\": \"2025-05-12T22:45:21Z\"\n },\n \"task_list_id\": 243,\n \"task_list\": {\n \"id\": 243,\n \"name\": \"PRIVATE LIST\",\n \"description\": \"\",\n \"order\": 4,\n \"is_private\": true,\n \"created_at\": \"2025-03-03T13:45:31.000000Z\",\n \"updated_at\": \"2025-03-03T15:04:49.000000Z\"\n },\n \"state_id\": 2,\n \"state\": {\n \"id\": 2,\n \"name\": \"In Progress\",\n \"color\": \"lime\",\n \"icon\": null,\n \"created_at\": \"2020-11-14T07:35:29.000000Z\",\n \"updated_at\": \"2023-12-01T13:31:55.000000Z\"\n },\n \"appointment_id\": null,\n \"priority\": \"medium\",\n \"is_recurring\": true,\n \"recurrence_rule\": \"FREQ=DAILY;INTERVAL=1\",\n \"recurrence_start_date\": \"2025-05-12\",\n \"recurrence_summary\": \"Daily\",\n \"completed_at\": null,\n \"due_at\": \"2025-05-12T04:00:00.000000Z\",\n \"cancelled_at\": null,\n \"created_at\": \"2025-05-12T22:45:21.000000Z\",\n \"updated_at\": \"2025-05-12T22:45:21.000000Z\",\n \"deleted_at\": null\n }\n ]\n}"},{"id":"8276664f-ccfa-4824-b1d5-2342bc627cd7","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/upcoming-activities","host":["{{domain}}"],"path":["v1","leads",":id","upcoming-activities"],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 12 May 2025 22:38:06 GMT"},{"key":"phpdebugbar-id","value":"X25adccf6a10b68ed5955a52abe4f58b0"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"338b9a8b-4a5f-4545-aad1-d589c76115d2"}],"id":"a1ad21f3-c3ca-4bd2-8d8c-6553fe4da793","description":"Retrieves a lead’s upcoming activities. Currently, this includes only upcoming tasks and appointments.
\n","_postman_id":"a1ad21f3-c3ca-4bd2-8d8c-6553fe4da793","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Emails","item":[{"name":"List","id":"a985ae6b-7759-4620-a109-d8794721a85f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/emails","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","emails"],"host":["{{domain}}"],"query":[{"disabled":true,"key":"per_page","value":"10"},{"disabled":true,"key":"page","value":"1"}],"variable":[{"description":{"content":"Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f69eb3ae-73a6-417a-9551-28fce5ee6a48","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/emails","host":["{{domain}}"],"path":["v1","leads",":id","emails"],"query":[{"key":"per_page","value":"10","type":"text","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:35:42 GMT"},{"key":"phpdebugbar-id","value":"X8eaaf4470ba2deafbc36f432bd9a62d2"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 194936,\n \"lead_id\": 416723,\n \"title\": \"Home\",\n \"type\": \"Home\",\n \"email\": \"steve.doe@example.com\",\n \"description\": null,\n \"is_primary\": false,\n \"is_preferred\": false,\n \"created_at\": \"2025-03-11T17:16:27.000000Z\",\n \"updated_at\": \"2025-04-27T16:33:16.000000Z\"\n },\n {\n \"id\": 195017,\n \"lead_id\": 416723,\n \"title\": \"Main Email\",\n \"type\": \"Home\",\n \"email\": \"janet@example.com\",\n \"description\": \"Client wants to change her email to janet@lexample.com\",\n \"is_primary\": true,\n \"is_preferred\": true,\n \"created_at\": \"2025-04-27T16:33:16.000000Z\",\n \"updated_at\": \"2025-04-27T16:33:16.000000Z\"\n }\n]"},{"id":"ac63ac9f-2c38-43ab-b252-452eb84f5ba4","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/emails","host":["{{domain}}"],"path":["v1","leads",":id","emails"],"query":[{"key":"per_page","value":"10","type":"text","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:40:41 GMT"},{"key":"phpdebugbar-id","value":"Xa7d32098476e001aee64d9143c34b91a"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"a985ae6b-7759-4620-a109-d8794721a85f"},{"name":"Create","id":"2bc9ec82-b6af-4d83-b3c8-20f40db42597","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Main Email\",\n \"description\": \"Client wants to change her email to janet@leadcenter.ai\",\n \"email\": \"janet.smith@example.com\",\n \"type\": \"Home\", // ['Home', 'Work', 'Other']\n \"is_primary\": true,\n \"is_preferred\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id/emails","description":"This endpoint allows you to add a new email to a specific lead identified by the :id.
title (string): The title of the email.
description (string): A description of the email.
email (string): The email address.
type (string): The type of email Options (home, work, other).
is_primary (boolean): Indicates if the email is the primary one.
is_preferred (boolean): Indicates if the email is preferred by client.
The response will be in JSON format with the following schema:
\n{\n \"id\": 195023,\n \"lead_id\": 416723,\n \"title\": \"Main Email\",\n \"type\": \"Home\",\n \"email\": \"janet.smith@example.com\",\n \"description\": \"Client wants to change her email to janet.smith@example.com\",\n \"is_primary\": true,\n \"is_preferred\": true,\n \"created_at\": \"2025-05-13T08:39:25.000000Z\",\n \"updated_at\": \"2025-05-13T08:39:25.000000Z\"\n}\n\nThis endpoint allows you to update the email details for a specific lead by providing the lead ID and email ID in the URL path. The request should be sent as an HTTP PUT to the specified URL.
\nThe request body should be in raw format and include the following parameters:
\ntitle (string): The title of the email.
description (string): A description of the email.
email (string): The email address.
type (string): The type of email Options (home, work, other).
is_primary (boolean): Indicates if the email is the primary one.
is_preferred (boolean): Indicates if the email is preferred by client.
The response to this request will include the updated details of the email for the specified lead, confirming the changes made.
\n{\n \"id\": 195023,\n \"lead_id\": 416723,\n \"title\": \"Main Email\",\n \"type\": \"Home\",\n \"email\": \"janet.smith@example.com\",\n \"description\": \"Client wants to change her email to janet.smith@example.com\",\n \"is_primary\": true,\n \"is_preferred\": true,\n \"created_at\": \"2025-05-13T08:39:25.000000Z\",\n \"updated_at\": \"2025-05-13T08:39:25.000000Z\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Email ID
\n","type":"text/plain"},"type":"any","value":"","key":"emailId"}]}},"response":[{"id":"fa9c29c5-cb18-4e33-bf08-748efecbff2a","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"janet.smith@example.com\",\n \"title\": \"Main Email\",\n \"description\": \"Client wants to change her email to janet.smith@example.com\",\n \"type\": \"Home\",\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/emails/:emailId","host":["{{domain}}"],"path":["v1","leads",":id","emails",":emailId"],"variable":[{"key":"id","value":"416723","description":"Lead ID"},{"key":"emailId","value":"195023","description":"Email ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:49:07 GMT"},{"key":"phpdebugbar-id","value":"X5255c48a08bf5d4fe2594bd8af8a5cb3"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 195023,\n \"lead_id\": 416723,\n \"title\": \"Main Email\",\n \"type\": \"Home\",\n \"email\": \"janet.smith@example.com\",\n \"description\": \"Client wants to change her email to janet.smith@example.com\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T08:39:25.000000Z\",\n \"updated_at\": \"2025-05-13T08:49:07.000000Z\"\n}"},{"id":"e6758d67-9c86-4fbe-9265-8ba815c7c864","name":"Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"janet.smith@example.com\",\n \"title\": \"Main Email\",\n \"description\": \"Client wants to change her email to janet.smith@example.com\",\n \"type\": \"Home\",\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/emails/:emailId","host":["{{domain}}"],"path":["v1","leads",":id","emails",":emailId"],"variable":[{"key":"id","value":"416723","description":"Lead ID"},{"key":"emailId","value":"","description":"Email ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:49:25 GMT"},{"key":"phpdebugbar-id","value":"Xea834871da1b33a8adbafc83ec6c3b85"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead email address not found\",\n \"errors\": [\n \"The requested lead email address could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"b46dc5c7-9220-4b92-966a-ec96a4a62854"},{"name":"Get","id":"9a79b60e-dd73-4e9e-9620-4222e9b5c7a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/emails/:emailId","description":"This endpoint retrieves the details of a specific email associated with a lead.
\nMethod: GET
\nURL: {{domain}}/v1/leads/:id/emails/:emailId
The response will contain the details of the email associated with the lead in JSON format.
\nExample:
\n{\n \"id\": 195023,\n \"lead_id\": 416723,\n \"title\": \"Main Email\",\n \"type\": \"Home\",\n \"email\": \"janet.smith@example.com\",\n \"description\": \"Client wants to change her email to janet.smith@example.com\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T08:39:25.000000Z\",\n \"updated_at\": \"2025-05-13T08:49:07.000000Z\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Email ID
\n","type":"text/plain"},"type":"any","value":"","key":"emailId"}]}},"response":[{"id":"de1118a0-f444-4d9a-9969-3f908590d9c5","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/emails/:emailId","host":["{{domain}}"],"path":["v1","leads",":id","emails",":emailId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"emailId","value":"","description":"Email ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:51:40 GMT"},{"key":"phpdebugbar-id","value":"Xaadb8bdf7b20c29052c0372124735ebf"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 195023,\n \"lead_id\": 416723,\n \"title\": \"Main Email\",\n \"type\": \"Home\",\n \"email\": \"janet.smith@example.com\",\n \"description\": \"Client wants to change her email to janet.smith@example.com\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T08:39:25.000000Z\",\n \"updated_at\": \"2025-05-13T08:49:07.000000Z\"\n}"},{"id":"26fab444-9c15-4626-8d19-3d1064d785c4","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/emails/:emailId","host":["{{domain}}"],"path":["v1","leads",":id","emails",":emailId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"emailId","value":"","description":"Email ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:52:59 GMT"},{"key":"phpdebugbar-id","value":"X95be7f95a7fcc67015751d6311ebcd55"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"9a79b60e-dd73-4e9e-9620-4222e9b5c7a9"},{"name":"Delete","id":"b07708db-2156-43f8-a4b9-0ee791d75e32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{domain}}/v1/leads/:id/emails/:emailId","description":"This endpoint is used to delete a specific email associated with a lead.
\nMethod: DELETE
\nURL: {{domain}}/v1/leads/:id/emails/:emailId
The response will contain a message key with a string value, indicating the status of the deletion operation.
The response for this request is a JSON object with the following schema:
\n{\n \"message\": \"Lead email address deleted successfully\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Email ID
\n","type":"text/plain"},"type":"any","value":"","key":"emailId"}]}},"response":[{"id":"6c2f7066-f019-480a-bfe1-120f82430761","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/emails/:emailId","host":["{{domain}}"],"path":["v1","leads",":id","emails",":emailId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"emailId","value":"","description":"Email ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:54:34 GMT"},{"key":"phpdebugbar-id","value":"Xf123c7a62641635d4f7b6514f397224a"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead email address deleted successfully\"\n}"},{"id":"c7ca4dc0-c74a-49b1-94ac-e97dbf5728a8","name":"Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/emails/:emailId","host":["{{domain}}"],"path":["v1","leads",":id","emails",":emailId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"emailId","value":"","description":"Email ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 08:53:56 GMT"},{"key":"phpdebugbar-id","value":"X4a3100c612e03f82b57cdd5e4516d839"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead email address not found\",\n \"errors\": [\n \"The requested lead email address could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"b07708db-2156-43f8-a4b9-0ee791d75e32"}],"id":"3706463c-6068-472c-bce1-721b688d28f6","_postman_id":"3706463c-6068-472c-bce1-721b688d28f6","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Address","item":[{"name":"List","id":"3c4c34c3-1e63-41e1-92cf-bb10f831907b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/addresses","description":"This endpoint retrieves the addresses associated with a specific lead.
\nRequest Body
This request does not require a request body.
Response
\nid (integer): The unique identifier for the address.
type (string): The type of address.
title (string): The title of the address.
description (string): Additional description of the address.
country (string): The country of the address.
state (string): The state of the address.
city (string): The city of the address.
address_line_1 (string): The first line of the address.
address_line_2 (string): The second line of the address.
zip_code (string): The postal code of the address.
is_primary (boolean): Indicates if the address is the primary address.
is_preferred (boolean): Indicates if the address is the preferred address.
created_at (string): The date and time when the address was created.
updated_at (string): The date and time when the address was last updated.
Example Response
\n[\n {\n \"id\": 191348,\n \"type\": \"Home\",\n \"title\": \"Primary Residence\",\n \"description\": \"\", \n \"country\": \"United States\",\n \"state\": \"California\",\n \"city\": \"Los Angeles\",\n \"address_line_1\": \"1234 Sunset Blvd\",\n \"address_line_2\": \"Apt 5B\",\n \"zip_code\": \"90001\",\n \"is_primary\": false,\n \"is_preferred\": false,\n \"created_at\": \"2025-04-27T16:58:57Z\",\n \"updated_at\": \"2025-04-27T17:07:26Z\"\n }\n]\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ed273180-1957-4b55-90d7-1b7b91336526","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/addresses","host":["{{domain}}"],"path":["v1","leads",":id","addresses"],"query":[{"key":"per_page","value":"10","type":"text","disabled":true}],"variable":[{"key":"id","value":"416723","description":"Lead ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:06:01 GMT"},{"key":"phpdebugbar-id","value":"X60ecbe3350ab83528a331f15f4569222"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 191348,\n \"type\": \"Home\",\n \"title\": \"Primary Residence\",\n \"description\": \"\",\n \"country\": \"United States\",\n \"state\": \"California\",\n \"city\": \"Los Angeles\",\n \"address_line_1\": \"1234 Sunset Blvd\",\n \"address_line_2\": \"Apt 5B\",\n \"zip_code\": \"90001\",\n \"is_primary\": false,\n \"is_preferred\": false,\n \"created_at\": \"2025-04-27T16:58:57Z\",\n \"updated_at\": \"2025-04-27T17:07:26Z\"\n }\n]"},{"id":"26032af9-3a86-46ca-9c05-d4af14b9ba3a","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/addresses","host":["{{domain}}"],"path":["v1","leads",":id","addresses"],"query":[{"key":"per_page","value":"10","type":"text","disabled":true}],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:07:04 GMT"},{"key":"phpdebugbar-id","value":"X87ededfb4133d319f7a37d9cec015a6c"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"3c4c34c3-1e63-41e1-92cf-bb10f831907b"},{"name":"Create","id":"6c2bee0a-3d46-4ba7-909e-de13bcc906ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"city\": \"Orlando\",\n \"state_id\": 1,\n \"country_id\": 1,\n \"zip_code\": \"80001\",\n \"type\": \"Home\", // ['Home', 'Work', 'Mailing', 'Other']\n \"is_primary\": true,\n \"is_preferred\": true\n}\n","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id/addresses","description":"This endpoint allows the user to add a new address for a specific lead.
\ntitle (string, required): The title of the address.
description (string, required): Description of the address.
address_line_1 (string, required): First line of the address.
address_line_2 (string): Second line of the address.
city (string, required): City of the address.
state_id (integer, required): ID of the state for the address. (Retrieve states list from List -> System -> States)
country_id (integer, required): ID of the country for the address. (Retrieve countries list from List -> System -> Countries)
zip_code (string, required): Zip code of the address.
type (string, required): Type of the address Options: ['Home', 'Work', 'Mailing', 'Other'].
is_primary (boolean, required): Indicates if the address is the primary address.
is_preferred (boolean, required): Indicates if the address is the preferred address.
{\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"city\": \"Orlando\",\n \"state_id\": 1,\n \"country_id\": 1,\n \"zip_code\": \"80001\",\n \"type\": \"Home\", // ['Home', 'Work', 'Mailing', 'Other']\n \"is_primary\": true,\n \"is_preferred\": true\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"47215f35-5da0-4859-93ba-49e0170e8ddf","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"city\": \"Orlando\",\n \"state_id\": 1,\n \"country_id\": 1,\n \"zip_code\": \"80001\",\n \"type\": \"Home\", // ['Home', 'Work', 'Mailing', 'Other']\n \"is_primary\": true,\n \"is_preferred\": true\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/addresses","host":["{{domain}}"],"path":["v1","leads",":id","addresses"],"variable":[{"key":"id","value":"416723"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:12:08 GMT"},{"key":"phpdebugbar-id","value":"X225b9575dacb1edd57808a53c84436cd"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 191350,\n \"type\": \"Home\",\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"country\": \"United States\",\n \"state\": \"Alaska\",\n \"city\": \"Orlando\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"zip_code\": \"80001\",\n \"is_primary\": true,\n \"is_preferred\": true,\n \"created_at\": \"2025-05-13T09:12:08.000000Z\",\n \"updated_at\": \"2025-05-13T09:12:08.000000Z\"\n}"},{"id":"411451c4-e1a9-46ef-8c2c-5a4bdf8eabbe","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"city\": \"Orlando\",\n \"state_id\": 1,\n \"country_id\": 1,\n \"zip_code\": \"80001\",\n \"type\": \"Home\", // ['Home', 'Work', 'Mailing', 'Other']\n \"is_primary\": true,\n \"is_preferred\": true\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/addresses","host":["{{domain}}"],"path":["v1","leads",":id","addresses"],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:18:26 GMT"},{"key":"phpdebugbar-id","value":"Xc80c5344306b4de9c6e077d679716f5e"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"6c2bee0a-3d46-4ba7-909e-de13bcc906ce"},{"name":"Update","id":"a2d905c0-3268-488f-bce2-fc270557a945","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"city\": \"Orlando\",\n \"state_id\": 1,\n \"country_id\": 1,\n \"zip_code\": \"80001\",\n \"type\": \"Mailing\", // ['Home', 'Work', 'Mailing', 'Other']\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id/addresses/:addressId","description":"This endpoint allows the client to update a specific address associated with a lead.
\nMethod: PUT
\nURL: {{domain}}/v1/leads/:id/addresses/:addressId
Body (raw, JSON):
\ntitle (string, required): The title of the address.
description (string, required): Description of the address.
address_line_1 (string, required): First line of the address.
address_line_2 (string): Second line of the address.
city (string, required): City of the address.
state_id (integer, required): ID of the state for the address. (Retrieve states list from List -> System -> States)
country_id (integer, required): ID of the country for the address. (Retrieve countries list from List -> System -> Countries)
zip_code (string, required): Zip code of the address.
type (string, required): Type of the address Options: ['Home', 'Work', 'Mailing', 'Other'].
is_primary (boolean, required): Indicates if the address is the primary address.
is_preferred (boolean, required): Indicates if the address is the preferred address.
The response is in JSON format and follows the schema below:
\n{\n \"id\": 191348,\n \"type\": \"Mailing\",\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"country\": \"United States\",\n \"state\": \"Alaska\",\n \"city\": \"Orlando\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"zip_code\": \"80001\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-04-27T16:58:57.000000Z\",\n \"updated_at\": \"2025-05-13T09:19:27.000000Z\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Address ID
\n","type":"text/plain"},"type":"any","value":"","key":"addressId"}]}},"response":[{"id":"45bbc334-17cd-47e9-b7bf-e4a7afd9b502","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"city\": \"Orlando\",\n \"state_id\": 1,\n \"country_id\": 1,\n \"zip_code\": \"80001\",\n \"type\": \"Mailing\", // ['Home', 'Work', 'Mailing', 'Other']\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/addresses/:addressId","host":["{{domain}}"],"path":["v1","leads",":id","addresses",":addressId"],"variable":[{"key":"id","value":"416723","description":"Lead ID"},{"key":"addressId","value":"191348","description":"Address ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:19:27 GMT"},{"key":"phpdebugbar-id","value":"Xf87f3dd22e3b45da674fee8822aca5da"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 191348,\n \"type\": \"Mailing\",\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"country\": \"United States\",\n \"state\": \"Alaska\",\n \"city\": \"Orlando\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"zip_code\": \"80001\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-04-27T16:58:57.000000Z\",\n \"updated_at\": \"2025-05-13T09:19:27.000000Z\"\n}"},{"id":"b919878f-38a8-4529-8a85-a8cfbb4358c2","name":"Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"city\": \"Orlando\",\n \"state_id\": 1,\n \"country_id\": 1,\n \"zip_code\": \"80001\",\n \"type\": \"Mailing\", // ['Home', 'Work', 'Mailing', 'Other']\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/addresses/:addressId","host":["{{domain}}"],"path":["v1","leads",":id","addresses",":addressId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"addressId","value":"","description":"Address ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:21:37 GMT"},{"key":"phpdebugbar-id","value":"X12e25220001aa866c4e797f96362587d"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"a2d905c0-3268-488f-bce2-fc270557a945"},{"name":"Get","id":"779a5686-52ef-404f-a457-d61de7eac99d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/addresses/:addressId","description":"This endpoint retrieves the details of a specific address associated with a lead.
\nMethod: GET
\nURL: {{domain}}/v1/leads/:id/addresses/:addressId
{\n \"id\": 191348,\n \"type\": \"Mailing\",\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"country\": \"United States\",\n \"state\": \"Alaska\",\n \"city\": \"Orlando\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"zip_code\": \"80001\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-04-27T16:58:57.000000Z\",\n \"updated_at\": \"2025-05-13T09:19:27.000000Z\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Address ID
\n","type":"text/plain"},"type":"any","value":"","key":"addressId"}]}},"response":[{"id":"9a67a86c-c585-4429-86bc-a02781ba00bb","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/addresses/:addressId","host":["{{domain}}"],"path":["v1","leads",":id","addresses",":addressId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"addressId","value":"","description":"Address ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:24:24 GMT"},{"key":"phpdebugbar-id","value":"Xb76e9371ef77c5747a394f189bc2b611"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 191348,\n \"type\": \"Mailing\",\n \"title\": \"Primary Home Address\",\n \"description\": \"Client moved recently and requested this address be set as their primary and preferred location.\",\n \"country\": \"United States\",\n \"state\": \"Alaska\",\n \"city\": \"Orlando\",\n \"address_line_1\": \"456 Elm Street\",\n \"address_line_2\": \"Suite 300\",\n \"zip_code\": \"80001\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-04-27T16:58:57.000000Z\",\n \"updated_at\": \"2025-05-13T09:19:27.000000Z\"\n}"},{"id":"a543101d-88bf-4eec-a6d6-23a9f824d16b","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/addresses/:addressId","host":["{{domain}}"],"path":["v1","leads",":id","addresses",":addressId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"addressId","value":"","description":"Address ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:27:13 GMT"},{"key":"phpdebugbar-id","value":"X8f52bb3c061222a44f2cea7bb2df0765"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"779a5686-52ef-404f-a457-d61de7eac99d"},{"name":"Delete","id":"9f5e5dd7-0292-45a2-a81c-387086a67c57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{domain}}/v1/leads/:id/addresses/:addressId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}},"urlObject":{"path":["v1","leads",":id","addresses",":addressId"],"host":["{{domain}}"],"query":[],"variable":[{"description":{"content":"Lead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Address ID
\n","type":"text/plain"},"type":"any","value":"","key":"addressId"}]}},"response":[{"id":"90410627-455d-4d92-809d-36b3e347453e","name":"Delete","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/addresses/:addressId","host":["{{domain}}"],"path":["v1","leads",":id","addresses",":addressId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"addressId","value":"","description":"Address ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:28:10 GMT"},{"key":"phpdebugbar-id","value":"Xaeee54f1ac627e2888776362100c77a9"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Lead address deleted successfully\"\n}"},{"id":"646f24e0-6aef-473a-8492-8ee524627b87","name":"Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/addresses/:addressId","host":["{{domain}}"],"path":["v1","leads",":id","addresses",":addressId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"addressId","value":"","description":"Address ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:27:34 GMT"},{"key":"phpdebugbar-id","value":"Xe12e5cd0754cdce5dac0eb6259b69d0d"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead address not found\",\n \"errors\": [\n \"The requested lead address could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"9f5e5dd7-0292-45a2-a81c-387086a67c57"}],"id":"d0db9a09-3a82-44ce-ac75-cf8b7e15f540","_postman_id":"d0db9a09-3a82-44ce-ac75-cf8b7e15f540","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Phones","item":[{"name":"List","id":"ccb5c1ad-9af5-425e-a1f9-d8678cd3aeaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/phones","description":"This endpoint retrieves the list of phones associated with a specific lead.
\nRequest
\nMethod: GET
\nURL: {{domain}}/v1/leads/:id/phones
Response
The response will contain an array of phone objects, with each object having the following properties:
id (number): The unique identifier for the phone.
lead_id (number): The ID of the lead associated with the phone.
title (string): The title of the phone.
description (string): The description of the phone.
type (string): The type of the phone.
phone (string): The phone number.
formatted_phone (string): The formatted version of the phone number.
is_primary (boolean): Indicates if the phone is the primary phone for the lead.
is_preferred (boolean): Indicates if the phone is the preferred phone for the lead.
created_at (string): The date and time when the phone record was created.
updated_at (string): The date and time when the phone record was last updated.
Example Response
\n[\n {\n \"id\": 215596,\n \"lead_id\": 416723,\n \"title\": \"Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"+13125551234\",\n \"formatted_phone\": \"+1 (312) 555-1234\",\n \"is_primary\": false,\n \"is_preferred\": false,\n \"created_at\": \"2025-03-11T17:16:27Z\",\n \"updated_at\": \"2025-04-28T09:19:25Z\"\n }\n]\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b8ead722-5cd0-4617-8a06-221812af7337","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/phones","host":["{{domain}}"],"path":["v1","leads",":id","phones"],"query":[{"key":"per_page","value":"10","disabled":true}],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:29:52 GMT"},{"key":"phpdebugbar-id","value":"X390c2241381367f75b10ea70f3f6531f"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 215596,\n \"lead_id\": 416723,\n \"title\": \"Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"+13125551234\",\n \"formatted_phone\": \"+1 (312) 555-1234\",\n \"is_primary\": false,\n \"is_preferred\": false,\n \"created_at\": \"2025-03-11T17:16:27Z\",\n \"updated_at\": \"2025-04-28T09:19:25Z\"\n },\n {\n \"id\": 215643,\n \"lead_id\": 416723,\n \"title\": \"Main Phone\",\n \"description\": \"Client wants to update her contact number for follow-up calls.\",\n \"type\": \"Home\",\n \"phone\": \"+12125559876\",\n \"formatted_phone\": null,\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-04-28T09:18:38Z\",\n \"updated_at\": \"2025-04-28T09:19:25Z\"\n }\n]\n"},{"id":"3ca04990-bd43-4bed-b02d-bde1b847a47f","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/phones","host":["{{domain}}"],"path":["v1","leads",":id","phones"],"query":[{"key":"per_page","value":"10","disabled":true}],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:46:22 GMT"},{"key":"phpdebugbar-id","value":"Xeaebbb3e809185a6a1c76dd891549ee0"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"ccb5c1ad-9af5-425e-a1f9-d8678cd3aeaf"},{"name":"Create","id":"ca872166-7b76-4ceb-8284-c3300fc198b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"phone\": \"+13125559876\",\n \"type\": \"Mobile\",\n \"is_primary\": true,\n \"is_preferred\": true\n}\n","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id/phones","description":"This endpoint allows the addition of a phone number to a specific lead.
\ntitle (string): Title of the phone number.
description (string): Description related to the phone number.
phone (string): Phone number.
type (string): Type of phone number. Options: ['Direct Dial', 'Fax', 'Home', 'Work', 'Mobile', 'Toll Free', 'Other']
is_primary (boolean): Indicates if the phone number is the primary contact number.
is_preferred (boolean): Indicates if the phone number is preferred.
The response for this request is in the form of a JSON schema:
\n{\n \"id\": 215649,\n \"lead_id\": 416723,\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"type\": \"Mobile\",\n \"phone\": \"+13125559876\",\n \"formatted_phone\": \"+13125559876\",\n \"is_primary\": true,\n \"is_preferred\": true,\n \"created_at\": \"2025-05-13T09:50:29.000000Z\",\n \"updated_at\": \"2025-05-13T09:50:29.000000Z\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"00833ce2-6309-41c3-8ff5-3861bef64d3e","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"phone\": \"+13125559876\",\n \"type\": \"Mobile\", // ['Direct Dial', 'Fax', 'Home', 'Work', 'Mobile', 'Toll Free','Other']\n \"is_primary\": true,\n \"is_preferred\": true\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/phones","host":["{{domain}}"],"path":["v1","leads",":id","phones"],"variable":[{"key":"id","value":"416723","description":"Lead ID"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:50:29 GMT"},{"key":"phpdebugbar-id","value":"X6a16fc7eb967c78a250798beb092a350"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 215649,\n \"lead_id\": 416723,\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"type\": \"Mobile\",\n \"phone\": \"+13125559876\",\n \"formatted_phone\": \"+13125559876\",\n \"is_primary\": true,\n \"is_preferred\": true,\n \"created_at\": \"2025-05-13T09:50:29.000000Z\",\n \"updated_at\": \"2025-05-13T09:50:29.000000Z\"\n}"},{"id":"f0c125ea-a691-42dc-8630-d93745c96f6b","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"phone\": \"+13125559876\",\n \"is_primary\": true,\n \"is_preferred\": true\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/phones","host":["{{domain}}"],"path":["v1","leads",":id","phones"],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:51:38 GMT"},{"key":"phpdebugbar-id","value":"Xf1611c6b052c78675628814ae363f666"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Validation failed\",\n \"errors\": [\n \"The type field is required.\"\n ],\n \"success\": false\n}"}],"_postman_id":"ca872166-7b76-4ceb-8284-c3300fc198b6"},{"name":"Update","id":"ad907bf1-8056-4f96-9b35-3045fe0e6ced","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"phone\": \"+13125559876\",\n \"type\": \"Mobile\",\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id/phones/:phoneId","description":"This endpoint allows the user to update a specific phone number associated with a lead.
\ntitle (string): The title of the phone number.
description (string): A description of the phone number update.
phone (string): The updated phone number.
type (string): The type of the phone number. Options: ['Direct Dial', 'Fax', 'Home', 'Work', 'Mobile', 'Toll Free', 'Other']
is_primary (boolean): Indicates if the phone number is the primary contact number.
is_preferred (boolean): Indicates if the phone number is preferred.
id (integer): The unique identifier of the updated phone number.
lead_id (integer): The unique identifier of the associated lead.
title (string): The title of the phone number.
description (string): The description of the phone number.
type (string): The type of the phone number.
phone (string): The updated phone number.
formatted_phone (string): The formatted version of the phone number.
is_primary (boolean): Indicates if the phone number is the primary contact number.
is_preferred (boolean): Indicates if the phone number is preferred.
created_at (string): The timestamp of creation.
updated_at (string): The timestamp of the last update.
{\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"phone\": \"+13125559876\",\n \"type\": \"Mobile\",\n \"is_primary\": true,\n \"is_preferred\": false\n}\n\n{\n \"id\": 215649,\n \"lead_id\": 416723,\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"type\": \"Mobile\",\n \"phone\": \"+13125559876\",\n \"formatted_phone\": \"+13125559876\",\n \"is_primary\": true,\n \"is_preferred\": true,\n \"created_at\": \"2025-05-13T09:50:29.000000Z\",\n \"updated_at\": \"2025-05-13T09:50:29.000000Z\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Phone ID
\n","type":"text/plain"},"type":"any","value":"","key":"phoneId"}]}},"response":[{"id":"78b4a783-f7c3-4195-b6ee-7117951cd629","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"phone\": \"+13125559876\",\n \"type\": \"Mobile\",\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/phones/:phoneId","host":["{{domain}}"],"path":["v1","leads",":id","phones",":phoneId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"phoneId","value":"","description":"Phone ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:54:32 GMT"},{"key":"phpdebugbar-id","value":"Xe94ea1cad784f9bb958472746ee80599"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 215649,\n \"lead_id\": 416723,\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"type\": \"Mobile\",\n \"phone\": \"+13125559876\",\n \"formatted_phone\": \"+13125559876\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T09:50:29.000000Z\",\n \"updated_at\": \"2025-05-13T09:54:32.000000Z\"\n}"},{"id":"b5a01bb0-5481-404f-9d22-0bd529678036","name":"Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"phone\": \"+13125559876\",\n \"type\": \"Mobile\",\n \"is_primary\": true,\n \"is_preferred\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/leads/:id/phones/:phoneId","host":["{{domain}}"],"path":["v1","leads",":id","phones",":phoneId"],"variable":[{"key":"id","value":"416723","description":"Lead ID"},{"key":"phoneId","value":"","description":"Phone ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 09:55:17 GMT"},{"key":"phpdebugbar-id","value":"X82163d79c980a627739c748e5eae88fc"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead phone not found\",\n \"errors\": [\n \"The requested lead phone could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"ad907bf1-8056-4f96-9b35-3045fe0e6ced"},{"name":"Get","id":"f96859dd-7392-4d46-b928-2fb995355087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/phones/:phoneId","description":"This endpoint retrieves the details of a specific phone associated with a lead.
\nMethod: GET
\nURL: {{domain}}/v1/leads/:id/phones/:phoneId
Example response body:
\n{\n \"id\": 215649,\n \"lead_id\": 416723,\n \"title\": \"Primary Contact Number\",\n \"description\": \"Client requested to update their main contact number.\",\n \"type\": \"Mobile\",\n \"phone\": \"+13125559876\",\n \"formatted_phone\": \"+13125559876\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T09:50:29.000000Z\",\n \"updated_at\": \"2025-05-13T09:54:32.000000Z\"\n}\n\nThis endpoint sends an HTTP DELETE request to delete a specific phone number associated with a lead. The request should include the lead ID and the phone ID in the URL parameters.
\nURL: {{domain}}/v1/leads/:id/phones/:phoneId
Method: DELETE
The response will contain a JSON object with a message indicating the result of the deletion operation.
\n{\n \"message\": \"Lead phone deleted successfully\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"Phone ID
\n","type":"text/plain"},"type":"any","value":"","key":"phoneId"}]}},"response":[{"id":"cada3137-47e8-4694-acd6-3e99b46d29a4","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/phones/:phoneId","host":["{{domain}}"],"path":["v1","leads",":id","phones",":phoneId"],"variable":[{"key":"id","value":"","description":"Lead ID"},{"key":"phoneId","value":"","description":"Phone ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:00:44 GMT"},{"key":"phpdebugbar-id","value":"Xe8e50e32e890cf4b571387cfd457fda0"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead phone deleted successfully\"\n}"},{"id":"402cb5d5-63c6-4c5b-9d6c-0f0af5c30ebf","name":"Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{domain}}/v1/leads/:id/phones/:phoneId","host":["{{domain}}"],"path":["v1","leads",":id","phones",":phoneId"],"variable":[{"key":"id","value":"416723","description":"Lead ID"},{"key":"phoneId","value":"215642","description":"Phone ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:00:11 GMT"},{"key":"phpdebugbar-id","value":"X245a5c25491032d98eb99e6cac86af9a"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead phone not found\",\n \"errors\": [\n \"The requested lead phone could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"494a3c5b-2253-44bd-ae60-d7ff3bb9ee01"}],"id":"9858722b-2a73-428c-8112-3b634b77a5be","_postman_id":"9858722b-2a73-428c-8112-3b634b77a5be","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Custom Fields","item":[{"name":"Index","id":"d9051750-ce65-4d89-89c2-b7e34e7cd0a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/leads/:id/custom-fields","description":"This endpoint retrieves custom fields for a specific lead identified by the :id parameter.
Method: GET
\nURL: {{domain}}/v1/leads/:id/custom-fields
The response will be a JSON array containing custom field objects with the following properties:
\nid (number): The ID of the custom field
definition (object): An object containing the definition of the custom field
id (number): The ID of the definition
name (string): The name of the custom field
field_type (string): The type of the custom field
options (array): An array of options for the custom field
name (string): The name of the custom field
value (string): The value of the custom field
[\n {\n \"id\": 1556,\n \"definition\": {\n \"id\": 1556,\n \"name\": \"Custom fullname\",\n \"field_type\": \"single_line_text_input\",\n \"options\": []\n },\n \"name\": \"Custom fullname\",\n \"value\": \"John Doe\"\n }\n]\n\nThis endpoint allows updating custom fields for a specific lead.
\nThe request body should be in the raw format and contain an array of objects, each representing a custom field to be updated. Each object should have the following keys:
\ndefinition_id (string) - The ID of the custom field definition.
value (string) - The new value for the custom field.
Example:
\n[\n {\n \"definition_id\": \"1556\",\n \"value\": \"John Doe\"\n },\n {...},\n {...}\n]\n\nResponse:
\n[\n {\n \"id\": 1556,\n \"definition\": {\n \"id\": 1556,\n \"name\": \"Custom fullname\",\n \"field_type\": \"single_line_text_input\",\n \"options\": []\n },\n \"name\": \"Custom fullname\",\n \"value\": \"John Doe\"\n }\n]\n\nRetrieves leads/contacts data, returning a structured JSON response that includes lead records, associated metadata, and related entities. The schema below outlines the response format.
\n{\n \"data\": [\n {\n \"id\": 416824,\n \"type\": \"lead\",\n \"owner_id\": 17673,\n \"is_lead\": true,\n \"owner\": {\n \"id\": 17673,\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"referred_by\": \"John Doe\",\n \"nickname\": \"James\",\n \"maiden_name\": \"Anderson\",\n \"family_name\": \"Smith\",\n \"first_name\": \"James\",\n \"last_name\": \"Smith\",\n \"full_name\": \"James L Smith\",\n \"client_status_id\": 416,\n \"client_status\": {\n \"id\": 416,\n \"name\": \"Client\",\n \"created_at\": \"2023-10-05T18:18:48.000000Z\",\n \"updated_at\": \"2023-10-05T18:18:48.000000Z\"\n },\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"salutation\": \"Mr.\",\n \"suffix\": null,\n \"job_title\": \"Attorney\",\n \"company\": \"LeadCenter.AI\",\n \"date_of_birth\": \"2025-05-08T05:00:00.000000Z\",\n \"client_since\": \"2025-05-02T05:00:00.000000Z\",\n \"date_of_death\": null,\n \"client_termination_date\": null,\n \"termination_reason\": null,\n \"gender\": \"Male\",\n \"marital_status\": \"Single\",\n \"marital_anniversary_date\": null,\n \"investment_objective\": \"Aggressive Growth\",\n \"time_horizon\": \"long-term\",\n \"risk_tolerance\": \"moderate\",\n \"employment\": [\n {\n \"id\": 11,\n \"occupation\": \"Attorney\",\n \"occupation_start_date\": \"2017-05-01T05:00:00.000000Z\"\n }\n ],\n \"family\": {\n \"id\": 117938,\n \"name\": \"Smith's Family\",\n \"created_at\": \"2025-05-13T10:07:53.000000Z\",\n \"updated_at\": \"2025-05-13T10:07:53.000000Z\",\n \"members\": [\n {\n \"id\": 416824,\n \"type\": \"lead\",\n \"full_name\": \"James L Smith\",\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\",\n \"relationship\": \"Hoh\"\n },\n {\n \"id\": 416826,\n \"type\": \"lead\",\n \"full_name\": \"Sarah Smith\",\n \"email\": \"sarah.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-13T10:08:38.000000Z\",\n \"updated_at\": \"2025-05-13T10:08:38.000000Z\",\n \"relationship\": \"Spouse\"\n }\n ]\n },\n \"addresses\": [],\n \"emails\": [\n {\n \"id\": 195021,\n \"lead_id\": 416824,\n \"title\": \"Primary Email\",\n \"type\": \"Home\",\n \"email\": \"james.smith@example.com\",\n \"description\": null,\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"phone_numbers\": [\n {\n \"id\": 215647,\n \"lead_id\": 416824,\n \"tenant_id\": 17673,\n \"title\": \"Primary Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"+15555555555\",\n \"formatted_phone\": \"+15555555555\",\n \"is_primary\": 1,\n \"is_preferred\": 0,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"websites\": [],\n \"medium_id\": 4,\n \"medium\": {\n \"id\": 4,\n \"name\": \"Offline\",\n \"description\": \"Contacts added from sales pipeline or contacts dashboard in LeadCenter.\",\n \"created_at\": \"2021-07-07T10:27:16.000000Z\",\n \"updated_at\": \"2024-09-02T11:22:37.000000Z\"\n },\n \"stage_id\": 99830,\n \"stage\": {\n \"id\": 99830,\n \"name\": \"To be Qualified\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2025-02-20T11:40:15.000000Z\"\n },\n \"source_id\": 66980,\n \"source\": {\n \"id\": 66980,\n \"name\": \"Email Marketing\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2023-09-05T22:51:05.000000Z\"\n },\n \"category_id\": 2775,\n \"category\": {\n \"id\": 2775,\n \"name\": \"AAA Client\",\n \"description\": null,\n \"created_at\": \"2025-05-07T11:19:45.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:45.000000Z\"\n },\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https://api.leadcenter.test/v1/leads?page=1\",\n \"last\": \"https://api.leadcenter.test/v1/leads?page=20\",\n \"prev\": null,\n \"next\": \"https://api.leadcenter.test/v1/leads?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 20,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=5\",\n \"label\": \"5\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=6\",\n \"label\": \"6\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=7\",\n \"label\": \"7\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=8\",\n \"label\": \"8\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=9\",\n \"label\": \"9\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=10\",\n \"label\": \"10\",\n \"active\": false\n },\n {\n \"url\": null,\n \"label\": \"...\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=19\",\n \"label\": \"19\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=20\",\n \"label\": \"20\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://api.leadcenter.test/v1/leads\",\n \"per_page\": 10,\n \"to\": 10,\n \"total\": 193\n }\n}\n\nSearch contacts by id, email, phone, name
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"The id of the stage being searched for
\n","type":"text/plain"},"key":"stage_id","value":""},{"disabled":true,"description":{"content":"The id of the category being searched for
\n","type":"text/plain"},"key":"category_id","value":""},{"disabled":true,"description":{"content":"The id of the medium being searched for
\n","type":"text/plain"},"key":"medium_id","value":""},{"disabled":true,"description":{"content":"The id of the client status being searched for
\n","type":"text/plain"},"key":"client_status_id","value":""},{"disabled":true,"description":{"content":"The id of the source being searched for
\n","type":"text/plain"},"key":"source_id","value":""},{"disabled":true,"description":{"content":"The id of the tag being searched for
\n","type":"text/plain"},"key":"tag_id","value":""},{"disabled":true,"description":{"content":"The id of the owner contact is assigned to
\n","type":"text/plain"},"key":"owner_id","value":""},{"disabled":true,"description":{"content":"Optional modules to load
\n","type":"text/plain"},"key":"load","value":"tags,notes,appointments,email_verification,phone_verification"},{"disabled":true,"key":"per_page","value":""},{"disabled":true,"key":"order_direction","value":"desc"},{"disabled":true,"key":"order_by_field","value":"updated_at"},{"description":{"content":"When the limit parameter is provided, default pagination is disabled. The value must be greater than 0 and less than 100.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"2c768172-b01a-468a-96af-f69398b3e2a4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads","host":["{{domain}}"],"path":["v1","leads"],"query":[{"key":"query","value":"","description":"Search contacts by id, email, phone, name","disabled":true},{"key":"stage_id","value":"","description":"The id of the stage being searched for","disabled":true},{"key":"category_id","value":"","description":"The id of the category being searched for","type":"text","disabled":true},{"key":"medium_id","value":"","description":"The id of the medium being searched for","type":"text","disabled":true},{"key":"client_status_id","value":"","description":"The id of the client status being searched for","type":"text","disabled":true},{"key":"source_id","value":"","description":"The id of the source being searched for","disabled":true},{"key":"tag_id","value":"","description":"The id of the tag being searched for","type":"text","disabled":true},{"key":"owner_id","value":"","description":"The id of the owner contact is assigned to","type":"text","disabled":true},{"key":"load","value":"tags,notes,appointments,email_verification,phone_verification","description":"Optional modules to load","disabled":true},{"key":"per_page","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:03:47 GMT"},{"key":"phpdebugbar-id","value":"X64ff602570134d89429af34a415c14c4"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 416824,\n \"type\": \"lead\",\n \"owner_id\": 17673,\n \"is_lead\": true,\n \"owner\": {\n \"id\": 17673,\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"referred_by\": \"John Doe\",\n \"nickname\": \"James\",\n \"maiden_name\": \"Anderson\",\n \"family_name\": \"Smith\",\n \"first_name\": \"James\",\n \"last_name\": \"Smith\",\n \"full_name\": \"James L Smith\",\n \"client_status_id\": 416,\n \"client_status\": {\n \"id\": 416,\n \"name\": \"Client\",\n \"created_at\": \"2023-10-05T18:18:48.000000Z\",\n \"updated_at\": \"2023-10-05T18:18:48.000000Z\"\n },\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"salutation\": \"Mr.\",\n \"suffix\": null,\n \"job_title\": \"Attorney\",\n \"company\": \"LeadCenter.AI\",\n \"date_of_birth\": \"2025-05-08T05:00:00.000000Z\",\n \"client_since\": \"2025-05-02T05:00:00.000000Z\",\n \"date_of_death\": null,\n \"client_termination_date\": null,\n \"termination_reason\": null,\n \"gender\": \"Male\",\n \"marital_status\": \"Single\",\n \"marital_anniversary_date\": null,\n \"investment_objective\": \"Aggressive Growth\",\n \"time_horizon\": \"long-term\",\n \"risk_tolerance\": \"moderate\",\n \"employment\": [\n {\n \"id\": 11,\n \"occupation\": \"Attorney\",\n \"occupation_start_date\": \"2017-05-01T05:00:00.000000Z\"\n }\n ],\n \"family\": {\n \"id\": 117938,\n \"name\": \"Smith's Family\",\n \"created_at\": \"2025-05-13T10:07:53.000000Z\",\n \"updated_at\": \"2025-05-13T10:07:53.000000Z\",\n \"members\": [\n {\n \"id\": 416824,\n \"type\": \"lead\",\n \"full_name\": \"James L Smith\",\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\",\n \"relationship\": \"Hoh\"\n },\n {\n \"id\": 416826,\n \"type\": \"lead\",\n \"full_name\": \"Sarah Smith\",\n \"email\": \"sarah.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-13T10:08:38.000000Z\",\n \"updated_at\": \"2025-05-13T10:08:38.000000Z\",\n \"relationship\": \"Spouse\"\n }\n ]\n },\n \"addresses\": [],\n \"emails\": [\n {\n \"id\": 195021,\n \"lead_id\": 416824,\n \"title\": \"Primary Email\",\n \"type\": \"Home\",\n \"email\": \"james.smith@example.com\",\n \"description\": null,\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"phone_numbers\": [\n {\n \"id\": 215647,\n \"lead_id\": 416824,\n \"tenant_id\": 17673,\n \"title\": \"Primary Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"+15555555555\",\n \"formatted_phone\": \"+15555555555\",\n \"is_primary\": 1,\n \"is_preferred\": 0,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"websites\": [],\n \"medium_id\": 4,\n \"medium\": {\n \"id\": 4,\n \"name\": \"Offline\",\n \"description\": \"Contacts added from sales pipeline or contacts dashboard in LeadCenter.\",\n \"created_at\": \"2021-07-07T10:27:16.000000Z\",\n \"updated_at\": \"2024-09-02T11:22:37.000000Z\"\n },\n \"stage_id\": 99830,\n \"stage\": {\n \"id\": 99830,\n \"name\": \"To be Qualified\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2025-02-20T11:40:15.000000Z\"\n },\n \"source_id\": 66980,\n \"source\": {\n \"id\": 66980,\n \"name\": \"Email Marketing\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2023-09-05T22:51:05.000000Z\"\n },\n \"category_id\": 2775,\n \"category\": {\n \"id\": 2775,\n \"name\": \"AAA Client\",\n \"description\": null,\n \"created_at\": \"2025-05-07T11:19:45.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:45.000000Z\"\n },\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https://api.leadcenter.test/v1/leads?page=1\",\n \"last\": \"https://api.leadcenter.test/v1/leads?page=20\",\n \"prev\": null,\n \"next\": \"https://api.leadcenter.test/v1/leads?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 20,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=5\",\n \"label\": \"5\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=6\",\n \"label\": \"6\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=7\",\n \"label\": \"7\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=8\",\n \"label\": \"8\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=9\",\n \"label\": \"9\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=10\",\n \"label\": \"10\",\n \"active\": false\n },\n {\n \"url\": null,\n \"label\": \"...\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=19\",\n \"label\": \"19\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=20\",\n \"label\": \"20\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/leads?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://api.leadcenter.test/v1/leads\",\n \"per_page\": 10,\n \"to\": 10,\n \"total\": 193\n }\n}"}],"_postman_id":"31efd60c-127f-4475-8473-2fe5f4bb5e9b"},{"name":"Update","id":"cc5d5113-c8e6-4576-9a54-eb639f3a8f9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"owner_id\": 17673, // Default is authenticated user\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"nick_name\": \"John\",\n \"middle_name\": \"L\",\n \"maiden_name\": \"Richard\",\n \"family_name\": \"John's Family\",\n \"email\": \"john.smith@example.com\",\n \"phone\": \"+155555555555\",\n \"company\": \"LeadCenter.AI\",\n \"job_title\": \"Attorney\",\n \"is_lead\": true,\n \"medium_id\": 4,\n \"source_id\": 66980,\n \"stage_id\": 99830,\n \"category_id\": 2775,\n \"client_status_id\": 416,\n \"spouse_lead_id\": null,\n \"is_head_of_household\": true,\n \"marital_status_id\": 2, // [1 = SINGLE, 2 = MARRIED, 3 = DIVORCED, 4 = WIDOWED, 5 = UNKNOWN, 6 = SEPARATED]\n \"salutation_id\": 1, // [1 = 'DR', 2 = 'MISS', 3 = 'MR', 4 = 'MRS', 5 = 'MS']\n \"job_status_id\": 1, // [1 = 'FULL_TIME', 2 = 'PART_TIME', 3 = 'RETIRED', 4 = 'LAID_OFF', 5 = 'SEMI_RETIRED']\n \"gender_id\": 1, //[ 1 = 'MALE', 2 = 'FEMALE', 3 = 'NON_BINARY', 4 = 'OTHER', 5 = 'UNKNOWN']\n \"client_since\": \"01-05-2022\",\n \"client_termination_date\": \"01-05-2022\",\n \"date_of_birth\": \"01-05-1999\",\n \"marital_anniversary_date\": \"01-05-2005\",\n \"date_of_death\": null,\n \"referred_by\": \"Jonny Richard\",\n \"primary_note\": \"Primary Note [I]\",\n \"enquiry\": \"\",\n \"country_id\": \"United States\",\n \"city\": \"Chicago\",\n \"state\": \"Illinois\",\n \"address\": \"1234 Elm Street\",\n \"postal_code\": \"60601\",\n \"writing_advisor_id\": 17711,// System user\n \"servicing_advisor_id\": 17711,\n \"tax_id\": \"12-3456789\",\n \"engagement_signed_date\": \"01-05-2023\",\n \"risk_tolerance\": \"moderate\", // [conservative, moderate, aggressive]\n \"estimated_total_assets\": 100000,\n \"estimated_non_liquid_assets\": 100000,\n \"adjusted_gross_income\": 100000,\n \"estimated_investable_assets\": 100000,\n \"net_worth_amount\": 100000,\n \"estimated_taxes\": 100000,\n \"monthly_expenses\": 100000,\n \"updated_since\": \"2025-06-02T12:30:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/leads/:id?load=tags,notes,appointments,email_verification,phone_verification","description":"This endpoint allows the user to update lead information along with tags, notes, appointments, email verification, and phone verification.
\nowner_id (integer): The ID of the owner. Defaults to the authenticated user.
first_name (string): The first name of the lead.
last_name (string): The last name of the lead.
nick_name (string): The nickname of the lead.
middle_name (string): The middle name of the lead.
maiden_name (string): The maiden name of the lead.
family_name (string): The name of the lead's family group or household.
email (string): The lead's email address.
phone (string): The lead's phone number (e.g., +155555555555).
company (string): The lead's company name.
job_title (string): The job title or profession of the lead.
is_lead (boolean): Indicates whether the record is a lead (true) or not.
medium_id (integer): ID of the marketing medium.
source_id (integer): ID of the lead source.
stage_id (integer): ID of the lead’s stage in the pipeline.
category_id (integer): ID of the lead category.
client_status_id (integer): ID representing the client status.
spouse_lead_id (integer|null): ID of the spouse if another lead, or null.
is_head_of_household (boolean): Whether this lead is marked as head of household.
marital_status_id (integer): Marital status ID. [1 = SINGLE, 2 = MARRIED, 3 = DIVORCED, 4 = WIDOWED, 5 = UNKNOWN, 6 = SEPARATED]
salutation_id (integer): Salutation ID. [1 = DR, 2 = MISS, 3 = MR, 4 = MRS, 5 = MS]
job_status_id (integer): Job status ID. [1 = FULL TIME, 2 = PART TIME, 3 = RETIRED, 4 = LAID OFF, 5 = SEMI RETIRED]
gender_id (integer): Gender ID. [1 = MALE, 2 = FEMALE, 3 = NON_BINARY, 4 = OTHER, 5 = UNKNOWN]
client_since (string:date): The date the client relationship started (format: MM-DD-YYYY).
client_termination_date (string:date): The date the client relationship ended (format: MM-DD-YYYY).
date_of_birth (string:date): The lead's birth date (format: MM-DD-YYYY).
marital_anniversary_date (string:date): The date of marriage anniversary (format: MM-DD-YYYY).
date_of_death (string:date|null): Date of death if applicable, or null.
referred_by (string): The name of the person who referred the lead.
primary_note (string): Main notes about the lead.
enquiry (string): Notes or content related to the enquiry.
country_id (string): Country name or code (e.g., \"United States\").
city (string): City name.
state (string): State name.
address (string): Street address.
postal_code (string): ZIP or postal code.
writing_advisor_id (integer): ID of the writing advisor (user).
servicing_advisor_id (integer): ID of the servicing advisor (user).
tax_id (string): Tax ID (e.g., EIN or SSN format: 12-3456789).
engagement_signed_date (string:date): The date the engagement agreement was signed (format: MM-DD-YYYY).
risk_tolerance (string): Risk tolerance level. [conservative, moderate, aggressive]
estimated_total_assets (integer): Estimated total assets value.
estimated_non_liquid_assets (integer): Estimated value of non-liquid assets.
adjusted_gross_income (integer): Adjusted gross income amount.
estimated_investable_assets (integer): Estimated investable assets.
net_worth_amount (integer): Net worth value.
estimated_taxes (integer): Estimated taxes due.
monthly_expenses (integer): Estimated monthly expenses.
The response will be a JSON object conforming to the following schema:
\n{\n \"id\": 416828,\n \"type\": \"lead\",\n \"owner_id\": 17673,\n \"owner\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"email\": \"amanda.ross@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"email\": \"john.smith@example.com\",\n \"phone\": \"+155555555555\",\n \"is_lead\": true,\n \"referred_by\": \"Jonny Richard\",\n \"nickname\": \"John\",\n \"maiden_name\": \"Richard\",\n \"family_name\": \"John's Family\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"full_name\": \"John Smith\",\n \"nick_name\": \"John\",\n \"client_status_id\": 416,\n \"client_status\": {\n \"id\": 416,\n \"name\": \"Client\",\n \"created_at\": \"2023-10-05T18:18:48.000000Z\",\n \"updated_at\": \"2023-10-05T18:18:48.000000Z\"\n },\n \"spouse_lead_id\": null,\n \"is_head_of_household\": true,\n \"enquiry\": \"\",\n \"primary_note\": \"Primary Note example\",\n \"salutation_id\": 1,\n \"salutation\": \"Dr.\",\n \"suffix\": null,\n \"job_title\": \"Attorney\",\n \"job_status_id\": 1,\n \"job_status\": \"Full Time\",\n \"company\": \"LeadCenter.AI\",\n \"date_of_birth\": \"1999-05-01T05:00:00.000000Z\",\n \"client_since\": \"2022-05-01T05:00:00.000000Z\",\n \"date_of_death\": null,\n \"client_termination_date\": null,\n \"termination_reason\": null,\n \"gender_id\": 1,\n \"gender\": \"Male\",\n \"writing_advisor_id\": 17711,\n \"writing_advisor\": {\n \"id\": 17711,\n \"name\": \"Jane Advisor\",\n \"email\": \"jane.advisor@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-10-25T11:27:17.000000Z\",\n \"updated_at\": \"2023-10-25T11:33:27.000000Z\"\n },\n \"servicing_advisor_id\": 17711,\n \"servicing_advisor\": {\n \"id\": 17712,\n \"name\": \"Jim Advisor\",\n \"email\": \"jim.advisor@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-10-25T11:27:17.000000Z\",\n \"updated_at\": \"2023-10-25T11:33:27.000000Z\"\n },\n \"tax_id\": \"12-3456789\",\n \"marital_status_id\": 2,\n \"marital_status\": \"Married\",\n \"marital_anniversary_date\": \"2005-05-01T05:00:00.000000Z\",\n \"engagement_signed_date\": \"2023-05-01T05:00:00.000000Z\",\n \"investment_objective\": null,\n \"time_horizon\": null,\n \"estimated_total_assets\": \"100000.00\",\n \"estimated_non_liquid_assets\": \"100000.00\",\n \"adjusted_gross_income\": \"100000.00\",\n \"estimated_investable_assets\": \"100000.00\",\n \"net_worth_amount\": \"100000.0000\",\n \"estimated_taxes\": \"100000.0000\",\n \"monthly_expenses\": \"100000.0000\",\n \"risk_tolerance\": \"moderate\",\n \"employment\": [],\n \"family\": null,\n \"addresses\": [\n {\n \"id\": 191352,\n \"type\": \"Home\",\n \"title\": \"Primary Address\",\n \"description\": null,\n \"country\": \"United States\",\n \"state\": \"Illinois\",\n \"city\": \"Chicago\",\n \"address_line_1\": \"1234 Elm Street\",\n \"address_line_2\": null,\n \"zip_code\": \"60601\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T18:05:40.000000Z\"\n }\n ],\n \"emails\": [\n {\n \"id\": 195026,\n \"lead_id\": 416828,\n \"title\": \"Primary Email\",\n \"type\": \"Home\",\n \"email\": \"john.smith@example.com\",\n \"description\": null,\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T18:05:40.000000Z\"\n }\n ],\n \"phone_numbers\": [\n {\n \"id\": 215652,\n \"lead_id\": 416828,\n \"tenant_id\": 17673,\n \"title\": \"Primary Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"+155555555555\",\n \"formatted_phone\": null,\n \"is_primary\": 1,\n \"is_preferred\": 0,\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T21:17:44.000000Z\"\n }\n ],\n \"websites\": [],\n \"medium_id\": 4,\n \"medium\": {\n \"id\": 4,\n \"name\": \"Offline\",\n \"description\": \"Contacts added from sales pipeline or contacts dashboard in LeadCenter.\",\n \"color\": \"purple\",\n \"created_at\": \"2021-07-07T10:27:16.000000Z\",\n \"updated_at\": \"2024-09-02T11:22:37.000000Z\"\n },\n \"stage_id\": 99830,\n \"stage\": {\n \"id\": 99830,\n \"name\": \"To be Qualified\",\n \"description\": null,\n \"color\": \"orange\",\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2025-02-20T11:40:15.000000Z\"\n },\n \"source_id\": 66980,\n \"source\": {\n \"id\": 66980,\n \"name\": \"Email Marketing\",\n \"description\": null,\n \"color\": \"orange\",\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2023-09-05T22:51:05.000000Z\"\n },\n \"category_id\": 2775,\n \"category\": {\n \"id\": 2775,\n \"name\": \"AAA Client\",\n \"description\": null,\n \"color\": \"indigo\",\n \"created_at\": \"2025-05-07T11:19:45.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:45.000000Z\"\n },\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T21:21:31.000000Z\",\n \"tags\": [],\n \"notes\": [],\n \"appointments\": [],\n \"email_verification\": {\n \"id\": 98882,\n \"lead_id\": 416828,\n \"email\": \"john.smith@example.com\",\n \"result\": \"valid\",\n \"reason\": \"accepted_email\",\n \"verification_done_at\": \"2025-05-13T18:03:25.000000Z\",\n \"mx_record\": \"\",\n \"mx_domain\": \"\",\n \"safe_to_send\": false,\n \"free\": false,\n \"disposable\": false,\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T18:05:40.000000Z\"\n },\n \"phone_verification\": {\n \"id\": 87686,\n \"user_id\": 17673,\n \"tenant_id\": 17673,\n \"lead_id\": 416828,\n \"result\": \"invalid_syntax\",\n \"error_code\": null,\n \"phone_number\": \"+155555555555\",\n \"country_code\": null,\n \"national_format\": null,\n \"owner_name\": null,\n \"owner_type\": null,\n \"carrier_country_code\": null,\n \"carrier_network_code\": null,\n \"carrier_name\": null,\n \"carrier_type\": null,\n \"state\": null,\n \"lookup_done_at\": \"2025-05-13T21:17:44.000000Z\",\n \"created_at\": \"2025-05-13T21:17:44.000000Z\",\n \"updated_at\": \"2025-05-13T21:17:44.000000Z\",\n \"cost\": null,\n \"stripe_uasge_record_id\": null,\n \"charged_at\": null,\n \"error_message\": null\n }\n}\n\nCreate a new lead/contact
\nMethod: POST
\nURL: {{domain}}/v1/leads/
owner_id (integer): The ID of the owner. Defaults to the authenticated user.
first_name (string): The first name of the lead.
last_name (string): The last name of the lead.
nick_name (string): The nickname of the lead.
middle_name (string): The middle name of the lead.
maiden_name (string): The maiden name of the lead.
family_name (string): The name of the lead's family group or household.
email (string): The lead's email address.
phone (string): The lead's phone number (e.g., +155555555555).
company (string): The lead's company name.
job_title (string): The job title or profession of the lead.
is_lead (boolean): Indicates whether the record is a lead (true) or not.
medium_id (integer): ID of the marketing medium.
source_id (integer): ID of the lead source.
stage_id (integer): ID of the lead’s stage in the pipeline.
category_id (integer): ID of the lead category.
client_status_id (integer): ID representing the client status.
spouse_lead_id (integer|null): ID of the spouse if another lead, or null.
is_head_of_household (boolean): Whether this lead is marked as head of household.
marital_status_id (integer): Marital status ID. [1 = SINGLE, 2 = MARRIED, 3 = DIVORCED, 4 = WIDOWED, 5 = UNKNOWN, 6 = SEPARATED]
salutation_id (integer): Salutation ID. [1 = DR, 2 = MISS, 3 = MR, 4 = MRS, 5 = MS]
job_status_id (integer): Job status ID. [1 = FULL TIME, 2 = PART TIME, 3 = RETIRED, 4 = LAID OFF, 5 = SEMI RETIRED]
gender_id (integer): Gender ID. [1 = MALE, 2 = FEMALE, 3 = NON_BINARY, 4 = OTHER, 5 = UNKNOWN]
client_since (string:date): The date the client relationship started (format: MM-DD-YYYY).
client_termination_date (string:date): The date the client relationship ended (format: MM-DD-YYYY).
date_of_birth (string:date): The lead's birth date (format: MM-DD-YYYY).
marital_anniversary_date (string:date): The date of marriage anniversary (format: MM-DD-YYYY).
date_of_death (string:date|null): Date of death if applicable, or null.
referred_by (string): The name of the person who referred the lead.
primary_note (string): Main notes about the lead.
enquiry (string): Notes or content related to the enquiry.
country_id (string): Country name or code (e.g., \"United States\").
city (string): City name.
state (string): State name.
address (string): Street address.
postal_code (string): ZIP or postal code.
writing_advisor_id (integer): ID of the writing advisor (user).
servicing_advisor_id (integer): ID of the servicing advisor (user).
tax_id (string): Tax ID (e.g., EIN or SSN format: 12-3456789).
engagement_signed_date (string:date): The date the engagement agreement was signed (format: MM-DD-YYYY).
risk_tolerance (string): Risk tolerance level. [conservative, moderate, aggressive]
estimated_total_assets (integer): Estimated total assets value.
estimated_non_liquid_assets (integer): Estimated value of non-liquid assets.
adjusted_gross_income (integer): Adjusted gross income amount.
estimated_investable_assets (integer): Estimated investable assets.
net_worth_amount (integer): Net worth value.
estimated_taxes (integer): Estimated taxes due.
monthly_expenses (integer): Estimated monthly expenses.
The response for this request will be a JSON object following the schema below:
\n{\n \"id\": 416828,\n \"type\": \"lead\",\n \"owner_id\": 17673,\n \"is_lead\": true,\n \"owner\": {\n \"id\": 17673,\n \"name\": \"Noureddine Abdelbadie\",\n \"email\": \"noureddine@leadcenter.ai\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"referred_by\": \"Jonny Richard\",\n \"nickname\": null,\n \"maiden_name\": \"Richard\",\n \"family_name\": \"John's Family\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"full_name\": \"John Smith\",\n \"client_status_id\": null,\n \"client_status\": null,\n \"email\": \"john.smith@example.com\",\n \"phone\": null,\n \"salutation\": \"Dr.\",\n \"suffix\": null,\n \"job_title\": \"Attorney\",\n \"company\": \"LeadCenter.AI\",\n \"date_of_birth\": \"1999-05-01T05:00:00.000000Z\",\n \"client_since\": \"2022-05-01T05:00:00.000000Z\",\n \"date_of_death\": null,\n \"client_termination_date\": null,\n \"termination_reason\": null,\n \"gender\": \"Male\",\n \"marital_status\": \"Married\",\n \"marital_anniversary_date\": null,\n \"investment_objective\": null,\n \"time_horizon\": null,\n \"risk_tolerance\": null,\n \"employment\": [],\n \"family\": null,\n \"addresses\": [\n {\n \"id\": 191352,\n \"type\": \"Home\",\n \"title\": \"Primary Address\",\n \"description\": null,\n \"country\": \"United States\",\n \"state\": \"Illinois\",\n \"city\": \"Chicago\",\n \"address_line_1\": \"1234 Elm Street\",\n \"address_line_2\": null,\n \"zip_code\": \"60601\",\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T18:05:40.000000Z\"\n }\n ],\n \"emails\": [\n {\n \"id\": 195026,\n \"lead_id\": 416828,\n \"title\": \"Primary Email\",\n \"type\": \"Home\",\n \"email\": \"john.smith@example.com\",\n \"description\": null,\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T18:05:40.000000Z\"\n }\n ],\n \"phone_numbers\": [\n {\n \"id\": 215652,\n \"lead_id\": 416828,\n \"tenant_id\": 17673,\n \"title\": \"Primary Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"555555555555\",\n \"formatted_phone\": null,\n \"is_primary\": 1,\n \"is_preferred\": 0,\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T18:05:40.000000Z\"\n }\n ],\n \"websites\": [],\n \"medium_id\": 4,\n \"medium\": {\n \"id\": 4,\n \"name\": \"Offline\",\n \"description\": \"Contacts added from sales pipeline or contacts dashboard in LeadCenter.\",\n \"created_at\": \"2021-07-07T10:27:16.000000Z\",\n \"updated_at\": \"2024-09-02T11:22:37.000000Z\"\n },\n \"stage_id\": 99830,\n \"stage\": {\n \"id\": 99830,\n \"name\": \"To be Qualified\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2025-02-20T11:40:15.000000Z\"\n },\n \"source_id\": 66980,\n \"source\": {\n \"id\": 66980,\n \"name\": \"Email Marketing\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2023-09-05T22:51:05.000000Z\"\n },\n \"category_id\": 2775,\n \"category\": {\n \"id\": 2775,\n \"name\": \"AAA Client\",\n \"description\": null,\n \"created_at\": \"2025-05-07T11:19:45.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:45.000000Z\"\n },\n \"created_at\": \"2025-05-13T18:05:40.000000Z\",\n \"updated_at\": \"2025-05-13T18:05:40.000000Z\"\n}\n\nThis endpoint retrieves the details of a specific lead identified by the provided ID.
\nMethod: GET
\nURL: {{domain}}/v1/leads/:id
{\n \"id\": 416824,\n \"type\": \"lead\",\n \"owner_id\": 17673,\n \"is_lead\": true,\n \"owner\": {\n \"id\": 17673,\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"referred_by\": \"John Doe\",\n \"nickname\": \"James\",\n \"maiden_name\": \"Anderson\",\n \"family_name\": \"Smith\",\n \"first_name\": \"James\",\n \"last_name\": \"Smith\",\n \"full_name\": \"James L Smith\",\n \"client_status_id\": 416,\n \"client_status\": {\n \"id\": 416,\n \"name\": \"Client\",\n \"created_at\": \"2023-10-05T18:18:48.000000Z\",\n \"updated_at\": \"2023-10-05T18:18:48.000000Z\"\n },\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"salutation\": \"Mr.\",\n \"suffix\": null,\n \"job_title\": \"Attorney\",\n \"company\": \"LeadCenter.AI\",\n \"date_of_birth\": \"2025-05-08T05:00:00.000000Z\",\n \"client_since\": \"2025-05-02T05:00:00.000000Z\",\n \"date_of_death\": null,\n \"client_termination_date\": null,\n \"termination_reason\": null,\n \"gender\": \"Male\",\n \"marital_status\": \"Single\",\n \"marital_anniversary_date\": null,\n \"investment_objective\": \"Aggressive Growth\",\n \"time_horizon\": \"long-term\",\n \"risk_tolerance\": \"moderate\",\n \"employment\": [\n {\n \"id\": 11,\n \"occupation\": \"Attorney\",\n \"occupation_start_date\": \"2017-05-01T05:00:00.000000Z\"\n }\n ],\n \"family\": {\n \"id\": 117938,\n \"name\": \"Smith's Family\",\n \"created_at\": \"2025-05-13T10:07:53.000000Z\",\n \"updated_at\": \"2025-05-13T10:07:53.000000Z\",\n \"members\": [\n {\n \"id\": 416824,\n \"type\": \"lead\",\n \"full_name\": \"James L Smith\",\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\",\n \"relationship\": \"Hoh\"\n },\n {\n \"id\": 416826,\n \"type\": \"lead\",\n \"full_name\": \"Sarah Smith\",\n \"email\": \"sarah.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-13T10:08:38.000000Z\",\n \"updated_at\": \"2025-05-13T10:08:38.000000Z\",\n \"relationship\": \"Spouse\"\n }\n ]\n },\n \"addresses\": [],\n \"emails\": [\n {\n \"id\": 195021,\n \"lead_id\": 416824,\n \"title\": \"Primary Email\",\n \"type\": \"Home\",\n \"email\": \"james.smith@example.com\",\n \"description\": null,\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"phone_numbers\": [\n {\n \"id\": 215647,\n \"lead_id\": 416824,\n \"tenant_id\": 17673,\n \"title\": \"Primary Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"+15555555555\",\n \"formatted_phone\": \"+15555555555\",\n \"is_primary\": 1,\n \"is_preferred\": 0,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"websites\": [],\n \"medium_id\": 4,\n \"medium\": {\n \"id\": 4,\n \"name\": \"Offline\",\n \"description\": \"Contacts added from sales pipeline or contacts dashboard in LeadCenter.\",\n \"created_at\": \"2021-07-07T10:27:16.000000Z\",\n \"updated_at\": \"2024-09-02T11:22:37.000000Z\"\n },\n \"stage_id\": 99830,\n \"stage\": {\n \"id\": 99830,\n \"name\": \"To be Qualified\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2025-02-20T11:40:15.000000Z\"\n },\n \"source_id\": 66980,\n \"source\": {\n \"id\": 66980,\n \"name\": \"Email Marketing\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2023-09-05T22:51:05.000000Z\"\n },\n \"category_id\": 2775,\n \"category\": {\n \"id\": 2775,\n \"name\": \"AAA Client\",\n \"description\": null,\n \"created_at\": \"2025-05-07T11:19:45.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:45.000000Z\"\n },\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"74ad36e9-254d-46ee-ba80-0b2623396a40","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id","host":["{{domain}}"],"path":["v1","leads",":id"],"query":[{"key":"load","value":"tags,interests,appointments","disabled":true}],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:13:13 GMT"},{"key":"phpdebugbar-id","value":"Xc712e9c9beeed273ef802748302c1f20"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 416824,\n \"type\": \"lead\",\n \"owner_id\": 17673,\n \"is_lead\": true,\n \"owner\": {\n \"id\": 17673,\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\",\n \"phone\": null,\n \"created_at\": \"2023-09-05T22:51:03.000000Z\",\n \"updated_at\": \"2025-05-12T15:00:19.000000Z\"\n },\n \"referred_by\": \"John Doe\",\n \"nickname\": \"James\",\n \"maiden_name\": \"Anderson\",\n \"family_name\": \"Smith\",\n \"first_name\": \"James\",\n \"last_name\": \"Smith\",\n \"full_name\": \"James L Smith\",\n \"client_status_id\": 416,\n \"client_status\": {\n \"id\": 416,\n \"name\": \"Client\",\n \"created_at\": \"2023-10-05T18:18:48.000000Z\",\n \"updated_at\": \"2023-10-05T18:18:48.000000Z\"\n },\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"salutation\": \"Mr.\",\n \"suffix\": null,\n \"job_title\": \"Attorney\",\n \"company\": \"LeadCenter.AI\",\n \"date_of_birth\": \"2025-05-08T05:00:00.000000Z\",\n \"client_since\": \"2025-05-02T05:00:00.000000Z\",\n \"date_of_death\": null,\n \"client_termination_date\": null,\n \"termination_reason\": null,\n \"gender\": \"Male\",\n \"marital_status\": \"Single\",\n \"marital_anniversary_date\": null,\n \"investment_objective\": \"Aggressive Growth\",\n \"time_horizon\": \"long-term\",\n \"risk_tolerance\": \"moderate\",\n \"employment\": [\n {\n \"id\": 11,\n \"occupation\": \"Attorney\",\n \"occupation_start_date\": \"2017-05-01T05:00:00.000000Z\"\n }\n ],\n \"family\": {\n \"id\": 117938,\n \"name\": \"Smith's Family\",\n \"created_at\": \"2025-05-13T10:07:53.000000Z\",\n \"updated_at\": \"2025-05-13T10:07:53.000000Z\",\n \"members\": [\n {\n \"id\": 416824,\n \"type\": \"lead\",\n \"full_name\": \"James L Smith\",\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\",\n \"relationship\": \"Hoh\"\n },\n {\n \"id\": 416826,\n \"type\": \"lead\",\n \"full_name\": \"Sarah Smith\",\n \"email\": \"sarah.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-13T10:08:38.000000Z\",\n \"updated_at\": \"2025-05-13T10:08:38.000000Z\",\n \"relationship\": \"Spouse\"\n }\n ]\n },\n \"addresses\": [],\n \"emails\": [\n {\n \"id\": 195021,\n \"lead_id\": 416824,\n \"title\": \"Primary Email\",\n \"type\": \"Home\",\n \"email\": \"james.smith@example.com\",\n \"description\": null,\n \"is_primary\": true,\n \"is_preferred\": false,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"phone_numbers\": [\n {\n \"id\": 215647,\n \"lead_id\": 416824,\n \"tenant_id\": 17673,\n \"title\": \"Primary Mobile\",\n \"description\": null,\n \"type\": \"Mobile\",\n \"phone\": \"+15555555555\",\n \"formatted_phone\": \"+15555555555\",\n \"is_primary\": 1,\n \"is_preferred\": 0,\n \"created_at\": \"2025-05-07T11:19:06.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:06.000000Z\"\n }\n ],\n \"websites\": [],\n \"medium_id\": 4,\n \"medium\": {\n \"id\": 4,\n \"name\": \"Offline\",\n \"description\": \"Contacts added from sales pipeline or contacts dashboard in LeadCenter.\",\n \"created_at\": \"2021-07-07T10:27:16.000000Z\",\n \"updated_at\": \"2024-09-02T11:22:37.000000Z\"\n },\n \"stage_id\": 99830,\n \"stage\": {\n \"id\": 99830,\n \"name\": \"To be Qualified\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2025-02-20T11:40:15.000000Z\"\n },\n \"source_id\": 66980,\n \"source\": {\n \"id\": 66980,\n \"name\": \"Email Marketing\",\n \"description\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2023-09-05T22:51:05.000000Z\"\n },\n \"category_id\": 2775,\n \"category\": {\n \"id\": 2775,\n \"name\": \"AAA Client\",\n \"description\": null,\n \"created_at\": \"2025-05-07T11:19:45.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:45.000000Z\"\n },\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\"\n}"},{"id":"079df034-9d83-4174-a9c6-6c3fbb1f3c85","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/leads/:id","host":["{{domain}}"],"path":["v1","leads",":id"],"query":[{"key":"load","value":"tags,interests,appointments","disabled":true}],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:14:53 GMT"},{"key":"phpdebugbar-id","value":"X1970e7534fd3ea70d1c2de45e4fd5f34"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lead not found\",\n \"errors\": [\n \"The requested lead could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"9f0a3827-b968-41c8-94f5-8c55e0c4f72d"},{"name":"Archive","id":"3deb2b46-daf5-47c2-afc9-dc86d2576115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{domain}}/v1/leads/:id","description":"This endpoint allows you to delete a specific lead by providing the lead's ID in the URL.
\nThis endpoint does not require a request body.
\nUpon successful deletion, the server will respond with a status code of 200 and a JSON object with a \"message\" key indicating the success of the operation.
Example response:
{\n \"message\": \"Lead archived successfully\"\n}\n\nLead ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"10f717c0-ef51-4df0-817b-baa8fa171a60","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id","host":["{{domain}}"],"path":["v1","leads",":id"],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:24:42 GMT"},{"key":"phpdebugbar-id","value":"Xa505bba4260a3f71bc37892f467c88da"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Lead archived successfully\"\n}"},{"id":"fd9e66ed-ecac-4992-849d-50e6f061a29d","name":"Error","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{domain}}/v1/leads/:id","host":["{{domain}}"],"path":["v1","leads",":id"],"variable":[{"key":"id","value":"","description":"Lead ID"}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:23:59 GMT"},{"key":"phpdebugbar-id","value":"X896df6711541a4ae292eb86976b6cf52"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Contact #416824 has appointments and can't be deleted!\",\n \"errors\": [\n \"Contact #416824 has appointments and can't be deleted!\"\n ],\n \"success\": false\n}"}],"_postman_id":"3deb2b46-daf5-47c2-afc9-dc86d2576115"}],"id":"90020549-73f7-490f-8a47-863b87a8581b","event":[{"listen":"prerequest","script":{"id":"e2c4ae8c-cebe-4a63-8a63-38a546c76fcb","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3afa7a8a-99e0-4cf4-bf5c-88f0f0abfc9c","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"90020549-73f7-490f-8a47-863b87a8581b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Lists","item":[{"name":"Sources","item":[{"name":"List","id":"797728ac-6271-4a1a-b072-f6eed57894f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/lists/sources","description":"This endpoint retrieves a list of sources via an HTTP GET request to {{domain}}/v1/lists/sources. The response is in JSON format and includes an array of objects, each representing a source with various properties such as id, parent_id, user_id, name, description, color, icon, start_date, end_date, is_active, utm_source, utm_medium, utm_name, utm_term, utm_content, created_at, updated_at, and deleted_at.
Here is an example of the response JSON schema:
\n[\n {\n \"id\": 66980,\n \"parent_id\": null,\n \"user_id\": 17673,\n \"tenant_id\": 17673,\n \"name\": \"Email Marketing\",\n \"description\": null,\n \"color\": \"orange\",\n \"icon\": \"mail\",\n \"start_date\": null,\n \"end_date\": null,\n \"is_active\": 1,\n \"utm_source\": null,\n \"utm_medium\": null,\n \"utm_name\": null,\n \"utm_term\": null,\n \"utm_content\": null,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2023-09-05T22:51:05.000000Z\",\n \"deleted_at\": null\n }\n]\n\nThis endpoint retrieves a list of mediums.
\nThis request does not require any parameters.
\nThe response will be a JSON array containing objects with the following properties:
\nid (number): The ID of the medium.
name (string): The name of the medium.
color (string): The color associated with the medium.
icon (string): The icon representing the medium.
route (string): The route for the medium.
description (string): Description of the medium.
created_at (string): Timestamp indicating when the medium was created.
updated_at (string): Timestamp indicating when the medium was last updated.
Example response:
\n[\n {\n \"id\": 18,\n \"name\": \"Bigmarker\",\n \"color\": \"blue\",\n \"icon\": \"square-rounded-letter-b\",\n \"route\": \"integrations.index\",\n \"description\": \"Contact captured from Bigmarker using API integration.\",\n \"created_at\": \"2024-11-27T12:22:38.000000Z\",\n \"updated_at\": \"2024-11-27T12:22:38.000000Z\"\n }\n]\n\nThis endpoint retrieves a list of tags.
\nThis request does not require any request body.
\nThe response is a JSON array containing tag objects with the following properties:
\nid (number): The unique identifier for the tag.
tenant_id (number): The identifier for the tenant associated with the tag.
name (string): The name of the tag.
description (string): The description of the tag, can be null.
created_at (string): The timestamp indicating when the tag was created.
updated_at (string): The timestamp indicating when the tag was last updated.
Example response:
\n[\n {\n \"id\": 14,\n \"tenant_id\": 17673,\n \"name\": \"Active\",\n \"description\": null,\n \"created_at\": \"2023-09-29T09:50:49.000000Z\",\n \"updated_at\": \"2023-09-29T09:50:49.000000Z\"\n }\n]\n\nThis endpoint retrieves a list of stages.
\nNo request body is required for this endpoint.
\nThe response is a JSON array containing objects with the following properties:
\nid (number): The ID of the stage.
user_id (number): The ID of the user.
tenant_id (number): The ID of the tenant.
name (string): The name of the stage.
description (string, null): The description of the stage, if available.
color (string): The color associated with the stage.
icon (string): The icon associated with the stage.
order (number): The order of the stage.
is_closed_stage (number): Indicates if the stage is closed.
is_won (number): Indicates if the stage is won.
is_lost (number): Indicates if the stage is lost.
created_at (string): The timestamp of when the stage was created.
updated_at (string): The timestamp of when the stage was last updated.
deleted_at (string, null): The timestamp of when the stage was deleted, if applicable.
[\n {\n \"id\": 99830,\n \"user_id\": 17673,\n \"tenant_id\": 17673,\n \"name\": \"To be Qualified\",\n \"description\": null,\n \"color\": \"orange\",\n \"icon\": \"edit\",\n \"order\": 1,\n \"is_closed_stage\": 0,\n \"is_won\": 0,\n \"is_lost\": 0,\n \"created_at\": \"2023-09-05T22:51:05.000000Z\",\n \"updated_at\": \"2025-02-20T11:40:15.000000Z\",\n \"deleted_at\": null\n }\n]\n\nThis endpoint retrieves a list of categories.
\nMethod: GET
\nURL: {{domain}}/v1/lists/categories
Status: 200 OK
\nContent-Type: application/json
\nExample Response Body:
\n[\n {\n \"id\": 2775,\n \"user_id\": 17673,\n \"tenant_id\": 17673,\n \"name\": \"High Priority\",\n \"color\": \"indigo\",\n \"icon\": \"check\",\n \"created_at\": \"2025-05-07T11:19:45.000000Z\",\n \"updated_at\": \"2025-05-07T11:19:45.000000Z\"\n },\n]\n\nThis endpoint makes an HTTP GET request to retrieve client statuses from the specified domain. The request does not include a request body.
\nThis request does not include a request body.
\nUpon successful execution, the server responds with a status code of 200 and a JSON array containing client status objects. Each client status object includes the following properties:
\nid: The unique identifier for the client status.
\ntenant_id: The identifier for the tenant associated with the client status.
\nname: The name of the client status.
\ncreated_at: The timestamp indicating when the client status was created.
\nupdated_at: The timestamp indicating when the client status was last updated.
\n[\n {\n \"id\": 416,\n \"tenant_id\": 17673,\n \"name\": \"Client\",\n \"created_at\": \"2023-10-05T18:18:48.000000Z\",\n \"updated_at\": \"2023-10-05T18:18:48.000000Z\"\n }\n]\n\nThis endpoint makes an HTTP GET request to retrieve a list of countries.
\nNo request body is required for this endpoint.
\nThe response will be a JSON array containing country objects with the following properties:
\nid (number): The unique identifier for the country.
name (string): The name of the country.
iso_code (string): The ISO code of the country.
Example response:
\n[\n {\n \"id\": 1,\n \"name\": \"United States\",\n \"iso_code\": \"US\"\n }\n]\n\nThis endpoint makes an HTTP GET request to retrieve a list of states. The request does not require any specific parameters. The response will be in JSON format and will include an array of state objects. Each state object will have properties such as id, name, state_code, latitude, longitude, country_id, and country. Here is an example of the response body:
\n[\n {\n \"id\": 1,\n \"name\": \"Alaska\",\n \"state_code\": \"AK\",\n \"latitude\": \"63.5887530\",\n \"longitude\": \"-154.4930620\",\n \"country_id\": 1,\n \"country\": \"United States\"\n }\n]\n\nThis endpoint retrieves custom fields definitions for lists.
\nNo request body is required for this endpoint.
\nThe response is a JSON array containing custom field definitions. Each custom field definition object has the following properties:
\nid (number): The unique identifier for the custom field.
name (string): The name of the custom field.
field_type (string): The type of the custom field.
options (array): An array of options for the custom field.
[\n {\n \"id\": 1556,\n \"name\": \"Custom fullname\",\n \"field_type\": \"single_line_text_input\",\n \"options\": []\n },\n {\n \"id\": 1826,\n \"name\": \"Custom notes\",\n \"field_type\": \"multiline_text_input\",\n \"options\": []\n },\n {\n \"id\": 1827,\n \"name\": \"Custom lead source\",\n \"field_type\": \"dropdown_list\",\n \"options\": [\n \"Marketing\",\n \"Cold\",\n \"Youtube\"\n ]\n },\n {\n \"id\": 1828,\n \"name\": \"Has account ?\",\n \"field_type\": \"single_checkbox\",\n \"options\": []\n },\n {\n \"id\": 1829,\n \"name\": \"Custom services Interested\",\n \"field_type\": \"set_of_checkboxes\",\n \"options\": [\n \"OPT A\",\n \"OPT B\",\n \"OPT C\"\n ]\n },\n {\n \"id\": 1830,\n \"name\": \"Custom contact method\",\n \"field_type\": \"set_of_radio_buttons\",\n \"options\": [\n \"1\",\n \"2\",\n \"3\",\n \"4\"\n ]\n },\n {\n \"id\": 1831,\n \"name\": \"Custom account register date\",\n \"field_type\": \"date_picker\",\n \"options\": []\n }\n]\n\nThis endpoint retrieves the details of the currently logged-in user.
\nMethod: GET
\nURL: {{domain}}/v1/user/me
Upon a successful request, the server will respond with a status code of 200 and a JSON object containing the user's details, including their ID, name, email, admin status, timezone, and other related information. Additionally, the response includes an array of users and an array of tenants, each with their respective details.
\nExample response body:
\n{\n \"user\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"full_name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2001,\n \"tenant\": {\n \"id\": 5001,\n \"name\": \"NorthBridge Advisors\"\n }\n },\n \"users\": [\n {\n \"id\": 1002,\n \"name\": \"Alex Johnson\",\n \"full_name\": \"Alex Johnson\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"admin\": 1,\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2002\n },\n {\n \"id\": 1003,\n \"name\": \"Morgan Lee\",\n \"full_name\": \"Morgan Lee\",\n \"first_name\": \"Morgan\",\n \"last_name\": \"Lee\",\n \"email\": \"morgan.lee@example.com\",\n \"admin\": 1,\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2003\n },\n {\n \"id\": 1004,\n \"name\": \"Jordan Smith\",\n \"full_name\": \"Jordan Smith\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Smith\",\n \"email\": \"jordan.smith@example.com\",\n \"admin\": 1,\n \"timezone\": null,\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2004\n }\n ],\n \"tenants\": [\n {\n \"id\": 5001,\n \"name\": \"NorthBridge Advisors\",\n \"is_2fa_enabled\": 0\n },\n {\n \"id\": 5002,\n \"name\": \"Acme Wealth\",\n \"is_2fa_enabled\": 0\n }\n ]\n}\n\nThis endpoint retrieves the details of all users.
\nMethod: GET
\nURL: {{domain}}/v1/user/users
The response will be a JSON array containing objects with the following user details:
\nid (number): The unique identifier for the user.
name (string): The username.
full_name (string): The full name of the user.
first_name (string): The first name of the user.
last_name (string): The last name of the user.
email (string): The email address of the user.
admin (number): Indicates if the user is an admin (0 for false, 1 for true).
timezone (string): The timezone of the user.
phone (string): The phone number of the user, if available.
last_login (string): The date and time of the user's last login.
calendar_id (number): The ID of the user's calendar.
Example response:
\n[\n {\n \"id\": 1001,\n \"name\": \"Alex Johnson\",\n \"full_name\": \"Alex Johnson\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"admin\": 1,\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2101\n },\n {\n \"id\": 1002,\n \"name\": \"Morgan Lee\",\n \"full_name\": \"Morgan Lee\",\n \"first_name\": \"Morgan\",\n \"last_name\": \"Lee\",\n \"email\": \"morgan.lee@example.com\",\n \"admin\": 1,\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n {\n \"id\": 1003,\n \"name\": \"Jordan Smith\",\n \"full_name\": \"Jordan Smith\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Smith\",\n \"email\": \"jordan.smith@example.com\",\n \"admin\": 1,\n \"timezone\": null,\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2103\n },\n {\n \"id\": 1004,\n \"name\": \"Amanda Ross\",\n \"full_name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2104\n }\n]\n\nSearch system users by name, email
\n","type":"text/plain"},"key":"query","value":""}],"variable":[]}},"response":[{"id":"6447559c-27a3-4c10-b59e-54acb73638d3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"{{domain}}/v1/user/users","host":["{{domain}}"],"path":["v1","user","users"],"query":[{"key":"query","value":"","description":"Search system users by name, email","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:46:53 GMT"},{"key":"phpdebugbar-id","value":"X9de0a20e4d93e24e2d02d5e2a666be2e"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n\t{\n\t\t\"id\": 1001,\n\t\t\"name\": \"Alex Johnson\",\n\t\t\"full_name\": \"Alex Johnson\",\n\t\t\"first_name\": \"Alex\",\n\t\t\"last_name\": \"Johnson\",\n\t\t\"email\": \"alex.johnson@example.com\",\n\t\t\"admin\": 1,\n\t\t\"timezone\": \"America/Chicago\",\n\t\t\"phone\": null,\n\t\t\"last_login\": null,\n\t\t\"calendar_id\": 2101\n\t},\n\t{\n\t\t\"id\": 1002,\n\t\t\"name\": \"Morgan Lee\",\n\t\t\"full_name\": \"Morgan Lee\",\n\t\t\"first_name\": \"Morgan\",\n\t\t\"last_name\": \"Lee\",\n\t\t\"email\": \"morgan.lee@example.com\",\n\t\t\"admin\": 1,\n\t\t\"timezone\": \"America/Chicago\",\n\t\t\"phone\": null,\n\t\t\"last_login\": null,\n\t\t\"calendar_id\": 2102\n\t},\n\t{\n\t\t\"id\": 1003,\n\t\t\"name\": \"Jordan Smith\",\n\t\t\"full_name\": \"Jordan Smith\",\n\t\t\"first_name\": \"Jordan\",\n\t\t\"last_name\": \"Smith\",\n\t\t\"email\": \"jordan.smith@example.com\",\n\t\t\"admin\": 1,\n\t\t\"timezone\": null,\n\t\t\"phone\": null,\n\t\t\"last_login\": null,\n\t\t\"calendar_id\": 2103\n\t},\n\t{\n\t\t\"id\": 1004,\n\t\t\"name\": \"Amanda Ross\",\n\t\t\"full_name\": \"Amanda Ross\",\n\t\t\"first_name\": \"Amanda\",\n\t\t\"last_name\": \"Ross\",\n\t\t\"admin\": 1,\n\t\t\"email\": \"amanda.ross@example.com\",\n\t\t\"timezone\": \"America/New_York\",\n\t\t\"phone\": null,\n\t\t\"last_login\": null,\n\t\t\"calendar_id\": 2104\n\t}\n]"}],"_postman_id":"de7eafeb-f594-44ad-9d05-6f19158df714"},{"name":"Switch Account","id":"91d3b30d-085a-46cd-8dc0-9c92ac009fbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tenant_id\": 17673\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/user/switch-account","description":"The POST /v1/user/switch-account endpoint allows the user to switch between different accounts.
tenant_id (integer) - The ID of the tenant to switch to.The API returns a JSON response with the following schema:
\n{\n \"access_token\": \"216|demoGeneratedToken1234567890abcdef\",\n \"token_type\": \"bearer\",\n \"user\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"full_name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2001,\n \"tenant\": {\n \"id\": 5001,\n \"name\": \"NorthBridge Advisors\"\n }\n },\n \"users\": [\n {\n \"id\": 1002,\n \"name\": \"Alex Johnson\",\n \"full_name\": \"Alex Johnson\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"admin\": 1,\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2002\n },\n {\n \"id\": 1003,\n \"name\": \"Morgan Lee\",\n \"full_name\": \"Morgan Lee\",\n \"first_name\": \"Morgan\",\n \"last_name\": \"Lee\",\n \"email\": \"morgan.lee@example.com\",\n \"admin\": 1,\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2003\n },\n {\n \"id\": 1004,\n \"name\": \"Jordan Smith\",\n \"full_name\": \"Jordan Smith\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Smith\",\n \"email\": \"jordan.smith@example.com\",\n \"admin\": 1,\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2004\n }\n ],\n \"tenants\": [\n {\n \"id\": 5001,\n \"name\": \"NorthBridge Advisors\",\n \"is_2fa_enabled\": 0\n },\n {\n \"id\": 5002,\n \"name\": \"Acme Wealth Management\",\n \"is_2fa_enabled\": 0\n }\n ]\n}\n\nThe endpoint retrieves a list of appointments for a specific calendar within the given date range. The response is a JSON array containing appointment details such as ID, title, type, host user information, creator information, location, start and end times, meeting type, privacy status, recurrence, cancellation details, category, and other related attributes.
\n[\n {\n \"id\": 22455,\n \"crm_type\": \"crm:appointment\",\n \"title\": \"Initial Consultation\",\n \"type\": \"appointment\",\n \"lead_id\": 159481,\n \"lead\": {\n \"id\": 159481,\n \"first_name\": \"Elfrieda\",\n \"last_name\": \"Hand\",\n \"email\": \"elfrieda.hand@example.com\",\n \"phone\": \"(312) 555-0198\",\n \"created_at\": \"2023-09-23T09:38:00Z\",\n \"updated_at\": \"2025-05-12T22:45:21Z\"\n },\n \"host_user_calendar_id\": 1109,\n \"host_user_id\": 12345,\n \"host_user\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"creator_id\": 12345,\n \"creator\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"organizers\": [\n {\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\"\n }\n ],\n \"guests\": [],\n \"location\": \"Custom location\",\n \"calendar_ids\": [\n 1109\n ],\n \"start_time\": \"2025-05-14T23:30:00Z\",\n \"end_time\": \"2025-05-15T00:30:00Z\",\n \"is_all_day\": false,\n \"timezone\": \"America/New_York\",\n \"meeting_type\": \"custom\",\n \"meeting_details\": \"Custom location\",\n \"meeting_link_details\": null,\n \"is_private\": false,\n \"comment\": \"<p class='preserveHtml' class='preserveHtml'>Appointments description</p>\",\n \"is_busy\": true,\n \"user_available_locations\": [],\n \"status_id\": 3,\n \"status\": {\n \"id\": 3,\n \"name\": \"CONFIRMED\",\n \"created_at\": \"2020-07-23T15:55:51.000000Z\",\n \"updated_at\": \"2020-07-23T15:55:51.000000Z\"\n },\n \"parent_id\": null,\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"cancelled_at\": null,\n \"cancellation_reason\": null,\n \"priority\": null,\n \"importance\": null,\n \"category_id\": 622,\n \"category\": {\n \"id\": 622,\n \"tenant_id\": 17673,\n \"source\": \"redtail\",\n \"source_id\": \"4\",\n \"name\": \"Customer Service\",\n \"color\": null,\n \"is_public\": 0,\n \"created_at\": \"2024-03-02T08:15:10.000000Z\",\n \"updated_at\": \"2024-03-02T08:15:10.000000Z\",\n \"deleted_at\": null\n },\n \"appointment_answers\": null,\n \"is_spouse_included\": false,\n \"zoomJoinUrl\": \"\",\n \"spouse\": null,\n \"source\": \"leadcenter\",\n \"source_color\": \"#1f6cc4\",\n \"created_at\": \"2025-05-12T22:44:17.000000Z\",\n \"updated_at\": \"2025-05-12T22:44:30.000000Z\"\n }\n]\n\nCalendar ID
\n","type":"text/plain"},"type":"any","value":"","key":"calendarId"}]}},"response":[{"id":"15492c12-8d96-4543-8f8d-dda9436218fe","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-LeadCenter-Platform","value":"Mobile","type":"text"}],"url":{"raw":"{{domain}}/v1/calendars/:calendarId/appointments?startDate=05-05-2025&endDate=06-05-2025","host":["{{domain}}"],"path":["v1","calendars",":calendarId","appointments"],"query":[{"key":"startDate","value":"05-05-2025","description":"Start Date range"},{"key":"endDate","value":"06-05-2025","description":"End Date range"}],"variable":[{"key":"calendarId","value":"","description":"Calendar ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:55:51 GMT"},{"key":"phpdebugbar-id","value":"X5dcc7135886b6c0287007e94adb5e262"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 22455,\n \"crm_type\": \"crm:appointment\",\n \"title\": \"Initial Consultation\",\n \"type\": \"appointment\",\n \"lead_id\": 159481,\n \"lead\": {\n \"id\": 159481,\n \"first_name\": \"Elfrieda\",\n \"last_name\": \"Hand\",\n \"email\": \"elfrieda.hand@example.com\",\n \"phone\": \"(312) 555-0198\",\n \"created_at\": \"2023-09-23T09:38:00Z\",\n \"updated_at\": \"2025-05-12T22:45:21Z\"\n },\n \"host_user_calendar_id\": 1109,\n \"host_user_id\": 12345,\n \"host_user\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"creator_id\": 12345,\n \"creator\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"organizers\": [\n {\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\"\n }\n ],\n \"guests\": [],\n \"location\": \"Custom location\",\n \"calendar_ids\": [\n 1109\n ],\n \"start_time\": \"2025-05-14T23:30:00Z\",\n \"end_time\": \"2025-05-15T00:30:00Z\",\n \"is_all_day\": false,\n \"timezone\": \"America/New_York\",\n \"meeting_type\": \"custom\",\n \"meeting_details\": \"Custom location\",\n \"meeting_link_details\": null,\n \"is_private\": false,\n \"comment\": \"Appointments description
\",\n \"is_busy\": true,\n \"user_available_locations\": [],\n \"status_id\": 3,\n \"status\": {\n \"id\": 3,\n \"name\": \"CONFIRMED\",\n \"created_at\": \"2020-07-23T15:55:51.000000Z\",\n \"updated_at\": \"2020-07-23T15:55:51.000000Z\"\n },\n \"parent_id\": null,\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"cancelled_at\": null,\n \"cancellation_reason\": null,\n \"priority\": null,\n \"importance\": null,\n \"category_id\": 622,\n \"category\": {\n \"id\": 622,\n \"tenant_id\": 17673,\n \"source\": \"redtail\",\n \"source_id\": \"4\",\n \"name\": \"Customer Service\",\n \"color\": null,\n \"is_public\": 0,\n \"created_at\": \"2024-03-02T08:15:10.000000Z\",\n \"updated_at\": \"2024-03-02T08:15:10.000000Z\",\n \"deleted_at\": null\n },\n \"appointment_answers\": null,\n \"is_spouse_included\": false,\n \"zoomJoinUrl\": \"\",\n \"spouse\": null,\n \"source\": \"leadcenter\",\n \"source_color\": \"#1f6cc4\",\n \"created_at\": \"2025-05-12T22:44:17.000000Z\",\n \"updated_at\": \"2025-05-12T22:44:30.000000Z\"\n }\n]"},{"id":"ce3cf308-01f3-494e-8aaa-ce947e4ba18b","name":"Error","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"{{domain}}/v1/calendars/:calendarId/appointments?startDate=05-05-2025&endDate=06-05-2025","host":["{{domain}}"],"path":["v1","calendars",":calendarId","appointments"],"query":[{"key":"startDate","value":"05-05-2025"},{"key":"endDate","value":"06-05-2025"},{"key":"","value":"","disabled":true}],"variable":[{"key":"calendarId","value":"","description":"Calendar ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 10:59:54 GMT"},{"key":"phpdebugbar-id","value":"X08b78ec868076d34642bb1941ceaa51c"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Calendar not found\",\n \"errors\": [\n \"The requested calendar could not be found\"\n ],\n \"success\": false\n}"},{"id":"003af4b9-8de1-4993-b355-8b82e24e7564","name":"Invalid","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"{{domain}}/v1/calendars/:calendarId/appointments?startDate=05-05-2025&endDate=03-05-2025","host":["{{domain}}"],"path":["v1","calendars",":calendarId","appointments"],"query":[{"key":"startDate","value":"05-05-2025"},{"key":"endDate","value":"03-05-2025"}],"variable":[{"key":"calendarId","value":"","description":"Calendar ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 11:00:46 GMT"},{"key":"phpdebugbar-id","value":"Xd7dd82d250dae441c58a2d1f5c6ceca6"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid date range\",\n \"errors\": [\n \"End date must be greater than start date\"\n ],\n \"success\": false\n}"}],"_postman_id":"d77d50bc-f112-48ee-8f3b-466955d2c42b"},{"name":"Cancel","id":"36f9ef9b-9f5d-45a0-8246-e18ad658ba2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"appointment_id\": 6046,\n \"should_send_email_notification\": 1,\n \"reason\": \"Test cancellation\",\n \"occurance_start_date\": \"2025-05-22T08:30:00.000Z\",\n \"occurance_end_date\": \"2025-05-22T09:30:00.000Z\",\n \"defaultUpdateType\": \"single\", // \"all\"\n \"is_all_day\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/calendars/:calendarId/appointments/:appointmentId/cancel","description":"The endpoint retrieves a list of appointments for a specific calendar within the given date range. The response is a JSON array containing appointment details such as ID, title, type, host user information, creator information, location, start and end times, meeting type, privacy status, recurrence, cancellation details, category, and other related attributes.
\n[\n {\n \"id\": 22455,\n \"crm_type\": \"crm:appointment\",\n \"title\": \"Initial Consultation\",\n \"type\": \"appointment\",\n \"lead_id\": 159481,\n \"lead\": {\n \"id\": 159481,\n \"first_name\": \"Elfrieda\",\n \"last_name\": \"Hand\",\n \"email\": \"elfrieda.hand@example.com\",\n \"phone\": \"(312) 555-0198\",\n \"created_at\": \"2023-09-23T09:38:00Z\",\n \"updated_at\": \"2025-05-12T22:45:21Z\"\n },\n \"host_user_calendar_id\": 1109,\n \"host_user_id\": 12345,\n \"host_user\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"creator_id\": 12345,\n \"creator\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"organizers\": [\n {\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\"\n }\n ],\n \"guests\": [],\n \"location\": \"Custom location\",\n \"calendar_ids\": [\n 1109\n ],\n \"start_time\": \"2025-05-14T23:30:00Z\",\n \"end_time\": \"2025-05-15T00:30:00Z\",\n \"is_all_day\": false,\n \"timezone\": \"America/New_York\",\n \"meeting_type\": \"custom\",\n \"meeting_details\": \"Custom location\",\n \"meeting_link_details\": null,\n \"is_private\": false,\n \"comment\": \"<p class='preserveHtml' class='preserveHtml'>Appointments description</p>\",\n \"is_busy\": true,\n \"user_available_locations\": [],\n \"status_id\": 3,\n \"status\": {\n \"id\": 3,\n \"name\": \"CONFIRMED\",\n \"created_at\": \"2020-07-23T15:55:51.000000Z\",\n \"updated_at\": \"2020-07-23T15:55:51.000000Z\"\n },\n \"parent_id\": null,\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"cancelled_at\": null,\n \"cancellation_reason\": null,\n \"priority\": null,\n \"importance\": null,\n \"category_id\": 622,\n \"category\": {\n \"id\": 622,\n \"tenant_id\": 17673,\n \"source\": \"redtail\",\n \"source_id\": \"4\",\n \"name\": \"Customer Service\",\n \"color\": null,\n \"is_public\": 0,\n \"created_at\": \"2024-03-02T08:15:10.000000Z\",\n \"updated_at\": \"2024-03-02T08:15:10.000000Z\",\n \"deleted_at\": null\n },\n \"appointment_answers\": null,\n \"is_spouse_included\": false,\n \"zoomJoinUrl\": \"\",\n \"spouse\": null,\n \"source\": \"leadcenter\",\n \"source_color\": \"#1f6cc4\",\n \"created_at\": \"2025-05-12T22:44:17.000000Z\",\n \"updated_at\": \"2025-05-12T22:44:30.000000Z\"\n }\n]\n\nCalendar ID
\n","type":"text/plain"},"type":"any","value":"","key":"calendarId"},{"type":"any","value":"","key":"appointmentId"}]}},"response":[{"id":"373c62ac-cfeb-4bcf-beea-974325d1cc4a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"appointment_id\": 112122,\n \"should_send_email_notification\": 1,\n \"reason\": \"Test cancellation\",\n \"occurance_start_date\": \"2025-05-21T08:30:00.000Z\",\n \"occurance_end_date\": \"2025-05-21T09:30:00.000Z\",\n \"defaultUpdateType\": \"single\", // \"all\"\n \"is_all_day\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/calendars/:calendarId/appointments/:appointmentId/cancel","host":["{{domain}}"],"path":["v1","calendars",":calendarId","appointments",":appointmentId","cancel"],"variable":[{"key":"calendarId","value":"1792","description":"Calendar ID"},{"key":"appointmentId","value":"112122","description":"Appointment ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 22 May 2025 10:16:16 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 112122,\n \"crm_type\": \"crm:appointment\",\n \"title\": \"Test appointment\",\n \"type\": \"appointment\",\n \"lead_id\": 456484,\n \"lead\": {\n \"id\": 456484,\n \"first_name\": \"Noureddine\",\n \"last_name\": \"\",\n \"email\": \"noureddine+301@leadcenter.ai\",\n \"phone\": null,\n \"created_at\": \"2025-04-22T11:30:43.000000Z\",\n \"updated_at\": \"2025-04-22T13:50:09.000000Z\"\n },\n \"host_user_calendar_id\": 1792,\n \"host_user_id\": 18325,\n \"host_user\": {\n \"id\": 18325,\n \"name\": \"Farhan Ali\",\n \"first_name\": \"Farhan\",\n \"last_name\": \"Ali\",\n \"admin\": 1,\n \"email\": \"farhan@leadcenter.ai\",\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 1792\n },\n \"creator_id\": 18325,\n \"creator\": {\n \"id\": 18325,\n \"name\": \"Farhan Ali\",\n \"first_name\": \"Farhan\",\n \"last_name\": \"Ali\",\n \"admin\": 1,\n \"email\": \"farhan@leadcenter.ai\",\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 1792\n },\n \"organizers\": [\n {\n \"name\": \"Farhan Ali\",\n \"email\": \"farhan@leadcenter.ai\"\n }\n ],\n \"guests\": [],\n \"location\": null,\n \"calendar_ids\": [\n 1792\n ],\n \"start_time\": \"2025-05-21T10:30:00Z\",\n \"end_time\": \"2025-05-21T11:00:00Z\",\n \"is_all_day\": false,\n \"timezone\": \"Asia/Kolkata\",\n \"meeting_type\": \"virtual\",\n \"meeting_details\": null,\n \"meeting_link_details\": null,\n \"is_private\": false,\n \"comment\": \"This is a test appointment
\",\n \"is_busy\": true,\n \"user_available_locations\": [],\n \"status_id\": 4,\n \"status\": {\n \"id\": 4,\n \"name\": \"CANCELLED\",\n \"created_at\": \"2020-07-23T14:55:51.000000Z\",\n \"updated_at\": \"2020-07-23T14:55:51.000000Z\"\n },\n \"parent_id\": null,\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"cancelled_at\": \"2025-05-22T10:16:16.000000Z\",\n \"cancellation_reason\": \"Test cancellation\",\n \"priority\": null,\n \"importance\": null,\n \"category_id\": 4179,\n \"category\": {\n \"id\": 4179,\n \"tenant_id\": 1287,\n \"source\": \"redtail\",\n \"source_id\": \"7\",\n \"name\": \"1st Appointment\",\n \"color\": null,\n \"is_public\": 0,\n \"created_at\": \"2025-04-23T16:01:28.000000Z\",\n \"updated_at\": \"2025-04-23T16:01:28.000000Z\",\n \"deleted_at\": null\n },\n \"appointment_answers\": null,\n \"is_spouse_included\": false,\n \"zoomJoinUrl\": \"\",\n \"spouse\": null,\n \"source\": \"leadcenter\",\n \"source_color\": \"#1f6cc4\",\n \"created_at\": \"2025-05-21T07:51:05.000000Z\",\n \"updated_at\": \"2025-05-22T10:16:16.000000Z\"\n}"},{"id":"7dc14c49-606d-45be-b78f-85d9e23c1996","name":"Error","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"appointment_id\": 0,\n \"should_send_email_notification\": 1,\n \"reason\": \"Test cancellation\",\n \"occurance_start_date\": \"2025-05-22T08:30:00.000Z\",\n \"occurance_end_date\": \"2025-05-22T09:30:00.000Z\",\n \"defaultUpdateType\": \"single\", // \"all\"\n \"is_all_day\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/calendars/:calendarId/appointments/:appointmentId/cancel","host":["{{domain}}"],"path":["v1","calendars",":calendarId","appointments",":appointmentId","cancel"],"variable":[{"key":"calendarId","value":"","description":"Calendar ID"},{"key":"appointmentId","value":"0"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Appointment not found\",\n \"errors\": [\n \"The requested appointment could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"36f9ef9b-9f5d-45a0-8246-e18ad658ba2b"},{"name":"No show","id":"f7883f1e-9b1e-40c4-aadd-4cefec46e973","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/calendars/:calendarId/appointments/:appointmentId/no-show","description":"The endpoint retrieves a list of appointments for a specific calendar within the given date range. The response is a JSON array containing appointment details such as ID, title, type, host user information, creator information, location, start and end times, meeting type, privacy status, recurrence, cancellation details, category, and other related attributes.
\n[\n {\n \"id\": 22455,\n \"crm_type\": \"crm:appointment\",\n \"title\": \"Initial Consultation\",\n \"type\": \"appointment\",\n \"lead_id\": 159481,\n \"lead\": {\n \"id\": 159481,\n \"first_name\": \"Elfrieda\",\n \"last_name\": \"Hand\",\n \"email\": \"elfrieda.hand@example.com\",\n \"phone\": \"(312) 555-0198\",\n \"created_at\": \"2023-09-23T09:38:00Z\",\n \"updated_at\": \"2025-05-12T22:45:21Z\"\n },\n \"host_user_calendar_id\": 1109,\n \"host_user_id\": 12345,\n \"host_user\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"creator_id\": 12345,\n \"creator\": {\n \"id\": 12345,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"calendar_id\": 1109\n },\n \"organizers\": [\n {\n \"name\": \"Amanda Ross\",\n \"email\": \"amanda.ross@example.com\"\n }\n ],\n \"guests\": [],\n \"location\": \"Custom location\",\n \"calendar_ids\": [\n 1109\n ],\n \"start_time\": \"2025-05-14T23:30:00Z\",\n \"end_time\": \"2025-05-15T00:30:00Z\",\n \"is_all_day\": false,\n \"timezone\": \"America/New_York\",\n \"meeting_type\": \"custom\",\n \"meeting_details\": \"Custom location\",\n \"meeting_link_details\": null,\n \"is_private\": false,\n \"comment\": \"<p class='preserveHtml' class='preserveHtml'>Appointments description</p>\",\n \"is_busy\": true,\n \"user_available_locations\": [],\n \"status_id\": 3,\n \"status\": {\n \"id\": 3,\n \"name\": \"CONFIRMED\",\n \"created_at\": \"2020-07-23T15:55:51.000000Z\",\n \"updated_at\": \"2020-07-23T15:55:51.000000Z\"\n },\n \"parent_id\": null,\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"cancelled_at\": null,\n \"cancellation_reason\": null,\n \"priority\": null,\n \"importance\": null,\n \"category_id\": 622,\n \"category\": {\n \"id\": 622,\n \"tenant_id\": 17673,\n \"source\": \"redtail\",\n \"source_id\": \"4\",\n \"name\": \"Customer Service\",\n \"color\": null,\n \"is_public\": 0,\n \"created_at\": \"2024-03-02T08:15:10.000000Z\",\n \"updated_at\": \"2024-03-02T08:15:10.000000Z\",\n \"deleted_at\": null\n },\n \"appointment_answers\": null,\n \"is_spouse_included\": false,\n \"zoomJoinUrl\": \"\",\n \"spouse\": null,\n \"source\": \"leadcenter\",\n \"source_color\": \"#1f6cc4\",\n \"created_at\": \"2025-05-12T22:44:17.000000Z\",\n \"updated_at\": \"2025-05-12T22:44:30.000000Z\"\n }\n]\n\nCalendar ID
\n","type":"text/plain"},"type":"any","value":"","key":"calendarId"},{"description":{"content":"Appointment ID
\n","type":"text/plain"},"type":"any","value":"","key":"appointmentId"}]}},"response":[{"id":"79965c2b-62c0-4186-9157-597cd1187e3d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/calendars/:calendarId/appointments/:appointmentId/no-show","host":["{{domain}}"],"path":["v1","calendars",":calendarId","appointments",":appointmentId","no-show"],"variable":[{"key":"calendarId","value":"1792","description":"Calendar ID"},{"key":"appointmentId","value":"112213","description":"Appointment ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 22 May 2025 10:26:30 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 112213,\n \"crm_type\": \"crm:appointment\",\n \"title\": \"Test appointment to noshow\",\n \"type\": \"appointment\",\n \"lead_id\": 453932,\n \"lead\": {\n \"id\": 453932,\n \"first_name\": \"Farhan\",\n \"last_name\": \"Ali\",\n \"email\": \"e.alifarhan@gmail.com\",\n \"phone\": \"+91 99616 67781\",\n \"created_at\": \"2025-04-04T12:17:14.000000Z\",\n \"updated_at\": \"2025-04-25T14:38:33.000000Z\"\n },\n \"host_user_calendar_id\": 1792,\n \"host_user_id\": 18325,\n \"host_user\": {\n \"id\": 18325,\n \"name\": \"Farhan Ali\",\n \"first_name\": \"Farhan\",\n \"last_name\": \"Ali\",\n \"admin\": 1,\n \"email\": \"farhan@leadcenter.ai\",\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 1792\n },\n \"creator_id\": 18325,\n \"creator\": {\n \"id\": 18325,\n \"name\": \"Farhan Ali\",\n \"first_name\": \"Farhan\",\n \"last_name\": \"Ali\",\n \"admin\": 1,\n \"email\": \"farhan@leadcenter.ai\",\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 1792\n },\n \"organizers\": [\n {\n \"name\": \"Farhan Ali\",\n \"email\": \"farhan@leadcenter.ai\"\n }\n ],\n \"guests\": [],\n \"location\": null,\n \"calendar_ids\": [\n 1792\n ],\n \"start_time\": \"2025-05-22T11:00:00Z\",\n \"end_time\": \"2025-05-22T11:30:00Z\",\n \"is_all_day\": false,\n \"timezone\": \"Asia/Kolkata\",\n \"meeting_type\": \"virtual\",\n \"meeting_details\": null,\n \"meeting_link_details\": null,\n \"is_private\": false,\n \"comment\": \"\",\n \"is_busy\": true,\n \"user_available_locations\": [],\n \"status_id\": 6,\n \"status\": {\n \"id\": 6,\n \"name\": \"NO-SHOW\",\n \"created_at\": \"2023-05-15T11:47:11.000000Z\",\n \"updated_at\": \"2023-05-15T11:47:11.000000Z\"\n },\n \"parent_id\": null,\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"cancelled_at\": null,\n \"cancellation_reason\": null,\n \"priority\": null,\n \"importance\": null,\n \"category_id\": null,\n \"category\": null,\n \"appointment_answers\": null,\n \"is_spouse_included\": false,\n \"zoomJoinUrl\": \"\",\n \"spouse\": null,\n \"source\": \"leadcenter\",\n \"source_color\": \"#1f6cc4\",\n \"created_at\": \"2025-05-22T10:24:01.000000Z\",\n \"updated_at\": \"2025-05-22T10:26:30.000000Z\"\n}"},{"id":"9f055114-d4b6-4b7a-b71b-92fca4446337","name":"Error","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/calendars/:calendarId/appointments/:appointmentId/no-show","host":["{{domain}}"],"path":["v1","calendars",":calendarId","appointments",":appointmentId","no-show"],"variable":[{"key":"calendarId","value":"","description":"Calendar ID"},{"key":"appointmentId","value":"","description":"Appointment ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 22 May 2025 10:27:30 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Appointment not found\",\n \"errors\": [\n \"The requested appointment could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"f7883f1e-9b1e-40c4-aadd-4cefec46e973"}],"id":"11faad50-bc4c-420b-9922-a56b0bb2a708","_postman_id":"11faad50-bc4c-420b-9922-a56b0bb2a708","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Calendars","id":"387c7ca5-7f42-4d4a-920c-d92ef41a122f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/calendars","description":"Retrieves a list of calendars associated with the current tenant. Each calendar includes configuration details, owner information, availability settings, and optionally assigned locations or linked integrations.
\nGET /v1/calendars
[\n {\n \"id\": 2101,\n \"name\": \"Alex Johnson\",\n \"owner_id\": 1002,\n \"owner\": {\n \"id\": 1002,\n \"name\": \"Alex Johnson\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"admin\": 0,\n \"email\": \"alex.johnson@example.com\",\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2101\n },\n \"pre_bookable_days\": 14,\n \"slot_increment\": 60,\n \"slot_start_time\": \"08:00\",\n \"slot_end_time\": \"17:00\",\n \"virtual_link\": \"\",\n \"is_active\": null,\n \"push_to_provider\": null,\n \"image\": null,\n \"locations\": [],\n \"created_at\": \"2023-10-25T11:27:17Z\",\n \"updated_at\": \"2024-11-14T12:37:20Z\"\n },\n {\n \"id\": 2102,\n \"name\": \"Amanda Ross\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"pre_bookable_days\": 30,\n \"slot_increment\": 120,\n \"slot_start_time\": \"00:00\",\n \"slot_end_time\": \"23:59\",\n \"virtual_link\": \"\",\n \"is_active\": null,\n \"push_to_provider\": \"microsoft\",\n \"image\": {\n \"id\": 65,\n \"calendar_id\": 2102,\n \"name\": \"calendar-demo-image\",\n \"extension\": \"png\",\n \"path\": \"calendar/demo_image_original.png\",\n \"content_type\": \"image/png\",\n \"source_url\": \"/tmp/demo-image\",\n \"size\": 979873,\n \"width\": 1088,\n \"height\": 986,\n \"dominant_color\": \"#322f2f\",\n \"created_at\": \"2024-01-20T19:27:43Z\",\n \"updated_at\": \"2024-01-20T19:27:43Z\"\n },\n \"locations\": [\n {\n \"id\": 3161,\n \"tenant_id\": 5001,\n \"calendar_id\": 2102,\n \"name\": \"Main Office - NYC\",\n \"created_at\": \"2025-02-19T23:12:57Z\",\n \"updated_at\": \"2025-02-19T23:12:57Z\"\n }\n ],\n \"created_at\": \"2023-09-05T22:51:04Z\",\n \"updated_at\": \"2025-05-12T10:27:38Z\"\n },\n {\n \"id\": 2103,\n \"name\": \"Morgan Lee\",\n \"owner_id\": 1003,\n \"owner\": {\n \"id\": 1003,\n \"name\": \"Morgan Lee\",\n \"first_name\": \"Morgan\",\n \"last_name\": \"Lee\",\n \"admin\": 0,\n \"email\": \"morgan.lee@example.com\",\n \"timezone\": \"America/Chicago\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2103\n },\n \"pre_bookable_days\": 14,\n \"slot_increment\": 60,\n \"slot_start_time\": \"08:00\",\n \"slot_end_time\": \"17:00\",\n \"virtual_link\": \"\",\n \"is_active\": null,\n \"push_to_provider\": null,\n \"image\": null,\n \"locations\": [],\n \"created_at\": \"2023-12-07T11:47:30Z\",\n \"updated_at\": \"2023-12-07T11:56:19Z\"\n },\n {\n \"id\": 2104,\n \"name\": \"Jordan Smith\",\n \"owner_id\": 1004,\n \"owner\": {\n \"id\": 1004,\n \"name\": \"Jordan Smith\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Smith\",\n \"admin\": 0,\n \"email\": \"jordan.smith@example.com\",\n \"timezone\": null,\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2104\n },\n \"pre_bookable_days\": 14,\n \"slot_increment\": 60,\n \"slot_start_time\": \"08:00\",\n \"slot_end_time\": \"17:00\",\n \"virtual_link\": null,\n \"is_active\": null,\n \"push_to_provider\": null,\n \"image\": null,\n \"locations\": [],\n \"created_at\": \"2023-12-07T11:55:24Z\",\n \"updated_at\": \"2023-12-07T11:55:24Z\"\n }\n]\n\nThe endpoint retrieves calendar information for the authenticated user.
\nNo request body parameters are required for this endpoint.
\nThe response will be in JSON format and will include the following fields:
\nid (number): The unique identifier of the calendar.
name (string): The name of the calendar.
owner_id (number): The unique identifier of the calendar owner.
owner (object): Information about the calendar owner, including their id, name, first_name, last_name, admin status, email, timezone, phone, last_login, and calendar_id.
pre_bookable_days (number): The number of days in advance that can be booked.
slot_increment (number): The time increment for each slot.
slot_start_time (string): The start time for slots.
slot_end_time (string): The end time for slots.
virtual_link (string): The virtual link associated with the calendar.
is_active (boolean): The status of the calendar.
push_to_provider (string): Information about pushing data to a provider.
image (object): Details about the calendar image, including id, calendar_id, name, extension, path, content_type, source_url, size, width, height, dominant_color, created_at, and updated_at.
locations (array): An array of location objects, each containing id, tenant_id, calendar_id, name, created_at, and updated_at.
created_at (string): The date and time when the calendar was created.
updated_at (string): The date and time when the calendar was last updated.
{\n \"id\": 2102,\n \"name\": \"Amanda Ross\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"pre_bookable_days\": 30,\n \"slot_increment\": 120,\n \"slot_start_time\": \"00:00\",\n \"slot_end_time\": \"23:59\",\n \"virtual_link\": \"\",\n \"is_active\": null,\n \"push_to_provider\": \"microsoft\",\n \"image\": {\n \"id\": 65,\n \"calendar_id\": 2102,\n \"name\": \"calendar-header-img\",\n \"extension\": \"png\",\n \"path\": \"calendar/calendar-header-img_original.png\",\n \"content_type\": \"image/png\",\n \"source_url\": \"/tmp/calendar-header.png\",\n \"size\": 980000,\n \"width\": 1088,\n \"height\": 986,\n \"dominant_color\": \"#2d2d2d\",\n \"created_at\": \"2024-01-20T19:27:43Z\",\n \"updated_at\": \"2024-01-20T19:27:43Z\"\n },\n \"locations\": [\n {\n \"id\": 3161,\n \"tenant_id\": 5001,\n \"calendar_id\": 2102,\n \"name\": \"Downtown Office - NYC\",\n \"created_at\": \"2025-02-19T23:12:57Z\",\n \"updated_at\": \"2025-02-19T23:12:57Z\"\n }\n ],\n \"created_at\": \"2023-09-05T22:51:04Z\",\n \"updated_at\": \"2025-05-12T10:27:38Z\"\n}\n\nThis endpoint retrieves a list of tasks.
\nThe response will be a JSON object with the following schema:
\n{\n \"data\": [\n {\n \"id\": 19852,\n \"type\": \"task\",\n \"title\": \"Follow up with client to confirm appointment.\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"team_id\": null,\n \"team\": null,\n \"lead_id\": 347427,\n \"lead\": {\n \"id\": 347427,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"(312) 555-0123\",\n \"created_at\": \"2024-10-30T11:03:12Z\",\n \"updated_at\": \"2025-03-13T15:58:06Z\"\n },\n \"task_list_id\": null,\n \"task_list\": null,\n \"state_id\": 1,\n \"state\": {\n \"id\": 1,\n \"name\": \"Not Started\",\n \"color\": \"orange\",\n \"icon\": null,\n \"created_at\": \"2020-11-14T07:35:29Z\",\n \"updated_at\": \"2023-12-01T13:31:55Z\"\n },\n \"appointment_id\": null,\n \"priority\": \"none\",\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"recurrence_start_date\": null,\n \"recurrence_summary\": null,\n \"completed_at\": null,\n \"due_at\": \"2024-09-24T13:02:00Z\",\n \"cancelled_at\": null,\n \"created_at\": \"2024-09-17T13:02:30Z\",\n \"updated_at\": \"2025-03-05T11:10:05Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https://api.leadcenter.test/v1/tasks?page=1\",\n \"last\": \"https://api.leadcenter.test/v1/tasks?page=2\",\n \"prev\": null,\n \"next\": \"https://api.leadcenter.test/v1/tasks?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/tasks?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/tasks?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"https://api.leadcenter.test/v1/tasks?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://api.leadcenter.test/v1/tasks\",\n \"per_page\": 20,\n \"to\": 20,\n \"total\": 23\n }\n}\n\nSearch tasks by keyword
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"Filter tasks by owner. (Retrieve Users/owners list from User -> Users)
\n","type":"text/plain"},"key":"owner_id","value":""},{"disabled":true,"description":{"content":"overdue, due-today, recurring
\n","type":"text/plain"},"key":"mode","value":""},{"disabled":true,"description":{"content":"Get tasks related to a specific task list. (Retrieve task lists from Task Lists -> List)
\n","type":"text/plain"},"key":"task_list_id","value":""},{"disabled":true,"description":{"content":"inbox, today, upcoming
\n","type":"text/plain"},"key":"scope","value":""},{"disabled":true,"description":{"content":"Filter tasks related to specific lead
\n","type":"text/plain"},"key":"lead_id","value":""}],"variable":[]}},"response":[{"id":"2d262d52-74b2-403b-8e75-f474941f60da","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{{domain}}/v1/tasks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 11:15:29 GMT"},{"key":"phpdebugbar-id","value":"X8955a69ffab9361a1cb5a457d001e92f"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n\t\"data\": [\n\t\t{\n\t\t\t\"id\": 19852,\n\t\t\t\"type\": \"task\",\n\t\t\t\"title\": \"Follow up with client to confirm appointment.\",\n \"description\": \"Task description\",\n\t\t\t\"owner_id\": 1001,\n\t\t\t\"owner\": {\n\t\t\t\t\"id\": 1001,\n\t\t\t\t\"name\": \"Amanda Ross\",\n\t\t\t\t\"first_name\": \"Amanda\",\n\t\t\t\t\"last_name\": \"Ross\",\n\t\t\t\t\"admin\": 1,\n\t\t\t\t\"email\": \"amanda.ross@example.com\",\n\t\t\t\t\"timezone\": \"America/New_York\",\n\t\t\t\t\"phone\": null,\n\t\t\t\t\"last_login\": null,\n\t\t\t\t\"calendar_id\": 2102\n\t\t\t},\n \"comments\": [],\n\t\t\t\"team_id\": null,\n\t\t\t\"team\": null,\n\t\t\t\"lead_id\": 347427,\n\t\t\t\"lead\": {\n\t\t\t\t\"id\": 347427,\n\t\t\t\t\"first_name\": \"John\",\n\t\t\t\t\"last_name\": \"Doe\",\n\t\t\t\t\"email\": \"john.doe@example.com\",\n\t\t\t\t\"phone\": \"(312) 555-0123\",\n\t\t\t\t\"created_at\": \"2024-10-30T11:03:12Z\",\n\t\t\t\t\"updated_at\": \"2025-03-13T15:58:06Z\"\n\t\t\t},\n\t\t\t\"task_list_id\": null,\n\t\t\t\"task_list\": null,\n\t\t\t\"state_id\": 1,\n\t\t\t\"state\": {\n\t\t\t\t\"id\": 1,\n\t\t\t\t\"name\": \"Not Started\",\n\t\t\t\t\"color\": \"orange\",\n\t\t\t\t\"icon\": null,\n\t\t\t\t\"created_at\": \"2020-11-14T07:35:29Z\",\n\t\t\t\t\"updated_at\": \"2023-12-01T13:31:55Z\"\n\t\t\t},\n\t\t\t\"appointment_id\": null,\n\t\t\t\"priority\": \"none\",\n\t\t\t\"is_recurring\": false,\n\t\t\t\"recurrence_rule\": null,\n\t\t\t\"recurrence_start_date\": null,\n\t\t\t\"recurrence_summary\": null,\n\t\t\t\"completed_at\": null,\n\t\t\t\"due_at\": \"2024-09-24T13:02:00Z\",\n\t\t\t\"cancelled_at\": null,\n\t\t\t\"created_at\": \"2024-09-17T13:02:30Z\",\n\t\t\t\"updated_at\": \"2025-03-05T11:10:05Z\",\n\t\t\t\"deleted_at\": null\n\t\t}\n\t],\n\t\"links\": {\n\t\t\"first\": \"https://api.leadcenter.test/v1/tasks?page=1\",\n\t\t\"last\": \"https://api.leadcenter.test/v1/tasks?page=2\",\n\t\t\"prev\": null,\n\t\t\"next\": \"https://api.leadcenter.test/v1/tasks?page=2\"\n\t},\n\t\"meta\": {\n\t\t\"current_page\": 1,\n\t\t\"from\": 1,\n\t\t\"last_page\": 2,\n\t\t\"links\": [\n\t\t\t{\n\t\t\t\t\"url\": null,\n\t\t\t\t\"label\": \"« Previous\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://api.leadcenter.test/v1/tasks?page=1\",\n\t\t\t\t\"label\": \"1\",\n\t\t\t\t\"active\": true\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://api.leadcenter.test/v1/tasks?page=2\",\n\t\t\t\t\"label\": \"2\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://api.leadcenter.test/v1/tasks?page=2\",\n\t\t\t\t\"label\": \"Next »\",\n\t\t\t\t\"active\": false\n\t\t\t}\n\t\t],\n\t\t\"path\": \"https://api.leadcenter.test/v1/tasks\",\n\t\t\"per_page\": 20,\n\t\t\"to\": 20,\n\t\t\"total\": 23\n\t}\n}"}],"_postman_id":"b4ff0ed4-2572-4a56-a45a-44436c78915b"},{"name":"Get","id":"daddb89d-57b8-4b1d-8b98-e261ee78684f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/tasks/:taskId","description":"This endpoint retrieves details of a specific task identified by the taskId parameter.
\nMethod: GET
\nURL: {{domain}}/v1/tasks/:taskId
The response will be in JSON format with the following structure:
\nid (number): The unique identifier of the task.
type (string): The type of the task.
title (string): The title of the task.
owner_id (number): The unique identifier of the task owner.
owner (object): Details of the task owner including id, name, first name, last name, admin status, email, timezone, phone, last login, and calendar id.
team_id (number): The unique identifier of the team associated with the task.
team (object): Details of the team associated with the task.
lead_id (number): The unique identifier of the lead associated with the task.
lead (object): Details of the lead associated with the task including id, first name, last name, email, phone, created at, and updated at.
task_list_id (number): The unique identifier of the task list associated with the task.
task_list (object): Details of the task list associated with the task.
state_id (number): The unique identifier of the state associated with the task.
state (object): Details of the state associated with the task including id, name, color, icon, created at, and updated at.
appointment_id (number): The unique identifier of the appointment associated with the task.
priority (string): The priority of the task.
is_recurring (boolean): Indicates if the task is recurring.
recurrence_rule (object): Details of the recurrence rule if the task is recurring.
recurrence_start_date (string): The start date of the recurring task.
recurrence_summary (string): Summary of the recurrence rule.
completed_at (string): The date and time when the task was completed.
due_at (string): The due date and time of the task.
cancelled_at (string): The date and time when the task was cancelled.
created_at (string): The date and time when the task was created.
updated_at (string): The date and time when the task was last updated.
deleted_at (string): The date and time when the task was deleted.
{\n \"id\": 19852,\n \"type\": \"task\",\n \"title\": \"Follow up with client to confirm appointment.\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"team_id\": null,\n \"team\": null,\n \"lead_id\": 347427,\n \"lead\": {\n \"id\": 347427,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"(312) 555-0123\",\n \"created_at\": \"2024-10-30T11:03:12Z\",\n \"updated_at\": \"2025-03-13T15:58:06Z\"\n },\n \"task_list_id\": null,\n \"task_list\": null,\n \"state_id\": 1,\n \"state\": {\n \"id\": 1,\n \"name\": \"Not Started\",\n \"color\": \"orange\",\n \"icon\": null,\n \"created_at\": \"2020-11-14T07:35:29Z\",\n \"updated_at\": \"2023-12-01T13:31:55Z\"\n },\n \"appointment_id\": null,\n \"priority\": \"none\",\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"recurrence_start_date\": null,\n \"recurrence_summary\": null,\n \"completed_at\": null,\n \"due_at\": \"2024-09-24T13:02:00Z\",\n \"cancelled_at\": null,\n \"created_at\": \"2024-09-17T13:02:30Z\",\n \"updated_at\": \"2025-03-05T11:10:05Z\",\n \"deleted_at\": null\n}\n\nTask ID
\n","type":"text/plain"},"type":"any","value":"","key":"taskId"}]}},"response":[{"id":"f462b26f-89fe-44f2-ac96-529930fb3603","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/tasks/:taskId","host":["{{domain}}"],"path":["v1","tasks",":taskId"],"variable":[{"key":"taskId","value":"","description":"Task ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 11:24:38 GMT"},{"key":"phpdebugbar-id","value":"X30284d8af9ea2205d1b09c460c6bca3b"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 19852,\n \"type\": \"task\",\n \"title\": \"Follow up with client to confirm appointment.\",\n \"description\": \"Task description\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"comments\": [],\n \"team_id\": null,\n \"team\": null,\n \"lead_id\": 347427,\n \"lead\": {\n \"id\": 347427,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"(312) 555-0123\",\n \"created_at\": \"2024-10-30T11:03:12Z\",\n \"updated_at\": \"2025-03-13T15:58:06Z\"\n },\n \"task_list_id\": null,\n \"task_list\": null,\n \"state_id\": 1,\n \"state\": {\n \"id\": 1,\n \"name\": \"Not Started\",\n \"color\": \"orange\",\n \"icon\": null,\n \"created_at\": \"2020-11-14T07:35:29Z\",\n \"updated_at\": \"2023-12-01T13:31:55Z\"\n },\n \"appointment_id\": null,\n \"priority\": \"none\",\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"recurrence_start_date\": null,\n \"recurrence_summary\": null,\n \"completed_at\": null,\n \"due_at\": \"2024-09-24T13:02:00Z\",\n \"cancelled_at\": null,\n \"created_at\": \"2024-09-17T13:02:30Z\",\n \"updated_at\": \"2025-03-05T11:10:05Z\",\n \"deleted_at\": null\n}"},{"id":"dc9157ef-c2ff-4e3e-98f2-04f73da77673","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{domain}}/v1/tasks/:taskId","host":["{{domain}}"],"path":["v1","tasks",":taskId"],"variable":[{"key":"taskId","value":"","description":"Task ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 11:25:24 GMT"},{"key":"phpdebugbar-id","value":"X6642c532852e81f6cee6564fa0637fa9"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Task not found\",\n \"errors\": [\n \"The requested task could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"daddb89d-57b8-4b1d-8b98-e261ee78684f"},{"name":"Create","id":"6015ee1d-22cb-443d-85ff-e62be63e3c7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Follow up on client proposal\",\n \"owner_id\": 17673,\n \"team_id\": null,\n \"task_list_id\": 16,\n \"state_id\": 1, // 1 = NOT STARTED, 2 = IN PROGRESS, 3 = COMPLETED, 4 = CANCELED\n \"priority\": \"medium\", // Options: none, low, medium, high\n \"due_at\": \"2025-06-01T10:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/tasks","description":"This endpoint is used to create a new task with the provided details.
\ntitle (string, required): The title of the task.
owner_id (integer, required): The ID of the owner of the task.
team_id (integer): The ID of the team to which the task belongs.
task_list_id (integer, required): The ID of the task list to which the task belongs.
state_id (integer, required): The ID representing the state of the task. Options [1 = NOT STARTED, 2 = IN PROGRESS, 3 = COMPLETED, 4 = CANCELED]
priority (string, required): The priority level of the task. Options: [none, low, medium, high]
due_at (string, required): The due date and time of the task.
The response will be in JSON format with the following schema:
\n{\n \"id\": 19852,\n \"type\": \"task\",\n \"title\": \"Follow up with client to confirm appointment.\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"team_id\": null,\n \"team\": null,\n \"lead_id\": 347427,\n \"lead\": {\n \"id\": 347427,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"(312) 555-0123\",\n \"created_at\": \"2024-10-30T11:03:12Z\",\n \"updated_at\": \"2025-03-13T15:58:06Z\"\n },\n \"task_list_id\": 16,\n \"task_list\": {\n \"id\": 16,\n \"name\": \"Task list 2\",\n \"description\": \"\",\n \"order\": 3,\n \"is_private\": false,\n \"created_at\": \"2024-10-31T22:12:45.000000Z\",\n \"updated_at\": \"2024-11-22T11:40:38.000000Z\"\n },\n \"state_id\": 1,\n \"state\": {\n \"id\": 1,\n \"name\": \"Not Started\",\n \"color\": \"orange\",\n \"icon\": null,\n \"created_at\": \"2020-11-14T07:35:29Z\",\n \"updated_at\": \"2023-12-01T13:31:55Z\"\n },\n \"appointment_id\": null,\n \"priority\": \"none\",\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"recurrence_start_date\": null,\n \"recurrence_summary\": null,\n \"completed_at\": null,\n \"due_at\": \"2024-09-24T13:02:00Z\",\n \"cancelled_at\": null,\n \"created_at\": \"2024-09-17T13:02:30Z\",\n \"updated_at\": \"2025-03-05T11:10:05Z\",\n \"deleted_at\": null\n}\n\nThis endpoint allows the user to update a specific task by sending an HTTP PUT request to {{domain}}/v1/tasks/:taskId.
The request should include a raw JSON payload with the following parameters:
\ntitle (string): The updated title of the task.
owner_id (integer): The ID of the owner of the task.
team_id (null or integer): The ID of the team associated with the task.
lead_id (integer): The ID of the lead associated with the task.
task_list_id (integer): The ID of the task list to which the task belongs.
state_id (integer, required): The ID representing the state of the task. Options [1 = NOT STARTED, 2 = IN PROGRESS, 3 = COMPLETED, 4 = CANCELED]
priority (string, required): The priority level of the task. Options: [none, low, medium, high]
due_at (string): The updated due date and time for the task.
{\n \"id\": 20135,\n \"type\": \"task\",\n \"title\": \"[UPDATED] Follow up on client proposal\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"team_id\": null,\n \"team\": null,\n \"lead_id\": 416824,\n \"lead\": {\n \"id\": 416824,\n \"first_name\": \"James\",\n \"last_name\": \"Smith\",\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\"\n },\n \"task_list_id\": 16,\n \"task_list\": {\n \"id\": 16,\n \"name\": \"Clients follow-up\",\n \"description\": \"Contains tasks related to clients follow-up\",\n \"order\": 3,\n \"is_private\": false,\n \"created_at\": \"2024-10-31T22:12:45.000000Z\",\n \"updated_at\": \"2024-11-22T11:40:38.000000Z\"\n },\n \"state_id\": 1,\n \"state\": {\n \"id\": 1,\n \"name\": \"Not Started\",\n \"color\": \"orange\",\n \"icon\": null,\n \"created_at\": \"2020-11-14T07:35:29Z\",\n \"updated_at\": \"2023-12-01T13:31:55Z\"\n },\n \"appointment_id\": null,\n \"priority\": \"none\",\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"recurrence_start_date\": null,\n \"recurrence_summary\": null,\n \"completed_at\": null,\n \"due_at\": \"2024-09-24T13:02:00Z\",\n \"cancelled_at\": null,\n \"created_at\": \"2024-09-17T13:02:30Z\",\n \"updated_at\": \"2025-03-05T11:10:05Z\",\n \"deleted_at\": null\n}\n\nTask ID
\n","type":"text/plain"},"type":"any","value":"","key":"taskId"}]}},"response":[{"id":"0d0bd8d3-f441-4ea8-b1ff-879224459515","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"[UPDATED] Follow up on client proposal\",\n \"owner_id\": 17673,\n \"team_id\": null,\n \"lead_id\": 416824,\n \"task_list_id\": 16,\n \"state_id\": 1, // 1 = NOT STARTED, 2 = IN PROGRESS, 3 = COMPLETED, 4 = CANCELED\n \"priority\": \"high\", // Options: none, low, medium, high\n \"due_at\": \"2025-06-01T10:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/tasks/:taskId","host":["{{domain}}"],"path":["v1","tasks",":taskId"],"variable":[{"key":"taskId","value":"20135","description":"Task ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 12:01:09 GMT"},{"key":"phpdebugbar-id","value":"X4558baaa98f6a8381c5dedb51488bedf"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 20135,\n \"type\": \"task\",\n \"title\": \"[UPDATED] Follow up on client proposal\",\n \"description\": \"Task description\",\n \"owner_id\": 1001,\n \"owner\": {\n \"id\": 1001,\n \"name\": \"Amanda Ross\",\n \"first_name\": \"Amanda\",\n \"last_name\": \"Ross\",\n \"admin\": 1,\n \"email\": \"amanda.ross@example.com\",\n \"timezone\": \"America/New_York\",\n \"phone\": null,\n \"last_login\": null,\n \"calendar_id\": 2102\n },\n \"comments\": [],\n \"team_id\": null,\n \"team\": null,\n \"lead_id\": 416824,\n \"lead\": {\n \"id\": 416824,\n \"first_name\": \"James\",\n \"last_name\": \"Smith\",\n \"email\": \"james.smith@example.com\",\n \"phone\": \"(555) 555-5555\",\n \"created_at\": \"2025-05-07T11:19:05.000000Z\",\n \"updated_at\": \"2025-05-13T10:03:43.000000Z\"\n },\n \"task_list_id\": 101,\n \"task_list\": {\n \"id\": 16,\n \"name\": \"Client Onboarding\",\n\t\t\"description\": \"Tasks related to onboarding new clients.\",\n \"order\": 3,\n \"is_private\": false,\n \"created_at\": \"2024-10-31T22:12:45.000000Z\",\n \"updated_at\": \"2024-11-22T11:40:38.000000Z\"\n },\n \"state_id\": 1,\n \"state\": {\n \"id\": 1,\n \"name\": \"Not Started\",\n \"color\": \"orange\",\n \"icon\": null,\n \"created_at\": \"2020-11-14T07:35:29Z\",\n \"updated_at\": \"2023-12-01T13:31:55Z\"\n },\n \"appointment_id\": null,\n \"priority\": \"none\",\n \"is_recurring\": false,\n \"recurrence_rule\": null,\n \"recurrence_start_date\": null,\n \"recurrence_summary\": null,\n \"completed_at\": null,\n \"due_at\": \"2024-09-24T13:02:00Z\",\n \"cancelled_at\": null,\n \"created_at\": \"2024-09-17T13:02:30Z\",\n \"updated_at\": \"2025-03-05T11:10:05Z\",\n \"deleted_at\": null\n}\n"},{"id":"42884b63-971a-4d04-bab8-e4d9ccf20e56","name":"Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"[UPDATED] Follow up on client proposal\",\n \"owner_id\": 17673,\n \"team_id\": null,\n \"lead_id\": 416824,\n \"task_list_id\": 16,\n \"state_id\": 1, // 1 = NOT STARTED, 2 = IN PROGRESS, 3 = COMPLETED, 4 = CANCELED\n \"priority\": \"high\", // Options: none, low, medium, high\n \"due_at\": \"2025-06-01T10:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/tasks/:taskId","host":["{{domain}}"],"path":["v1","tasks",":taskId"],"variable":[{"key":"taskId","value":"","description":"Task ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 12:05:58 GMT"},{"key":"phpdebugbar-id","value":"Xf600fb6644625bb35323b1a23dedb0ee"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Task not found\",\n \"errors\": [\n \"The requested task could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"8ae44783-bde3-42e0-bec6-80cff882a0e5"},{"name":"Delete","id":"989e96fe-4dff-4d32-84cc-ff96e06fe74a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/tasks/:taskId","description":"This endpoint is used to delete a specific task identified by its taskId.
\nThis request does not require a request body.
\n{\n \"message\": \"Task deleted successfully\"\n}\n\nTask ID
\n","type":"text/plain"},"type":"any","value":"","key":"taskId"}]}},"response":[{"id":"89fd8dcb-7244-4129-9dbc-04d5b44bc588","name":"Success","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/tasks/:taskId","host":["{{domain}}"],"path":["v1","tasks",":taskId"],"variable":[{"key":"taskId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 12:09:09 GMT"},{"key":"phpdebugbar-id","value":"X507ddc327e33be8f29429e67cce6402b"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Task deleted successfully\"\n}"},{"id":"6a55847b-7e3f-40e8-961d-2d24a9169c4b","name":"Error","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{domain}}/v1/tasks/:taskId","host":["{{domain}}"],"path":["v1","tasks",":taskId"],"variable":[{"key":"taskId","value":"","description":"Task ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 13 May 2025 12:09:24 GMT"},{"key":"phpdebugbar-id","value":"Xfc15d2705806b3fd345d32ae91308d17"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Task not found\",\n \"errors\": [\n \"The requested task could not be found\"\n ],\n \"success\": false\n}"}],"_postman_id":"989e96fe-4dff-4d32-84cc-ff96e06fe74a"}],"id":"6be93e8f-f0bc-485a-8e0e-5d0a07a86342","_postman_id":"6be93e8f-f0bc-485a-8e0e-5d0a07a86342","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Task Lists","item":[{"name":"List","id":"f1c876af-3809-431f-8214-2fb0be06e464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{domain}}/v1/task-lists","description":"This endpoint retrieves a list of task lists.
\nThis is a GET request to the endpoint {{domain}}/v1/task-lists.
The response is a JSON array containing objects with the following properties:
\nid (number): The unique identifier for the task list.
name (string): The name of the task list.
description (string): The description of the task list.
order (null): The order of the task list.
is_private (boolean): Indicates if the task list is private.
created_at (null): The timestamp when the task list was created.
updated_at (null): The timestamp when the task list was last updated.
[\n {\n \"id\": 101,\n \"name\": \"Client Onboarding\",\n \"description\": \"Tasks related to onboarding new clients.\",\n \"order\": null,\n \"is_private\": false,\n \"created_at\": null,\n \"updated_at\": null\n },\n {\n \"id\": 102,\n \"name\": \"Follow-up Tasks\",\n \"description\": \"<p>Tasks to follow up with leads after initial contact.</p>\",\n \"order\": null,\n \"is_private\": false,\n \"created_at\": null,\n \"updated_at\": null\n },\n {\n \"id\": 103,\n \"name\": \"Marketing Pipeline\",\n \"description\": \"\",\n \"order\": null,\n \"is_private\": false,\n \"created_at\": null,\n \"updated_at\": null\n },\n {\n \"id\": 104,\n \"name\": \"Internal Workflow\",\n \"description\": \"\",\n \"order\": null,\n \"is_private\": false,\n \"created_at\": null,\n \"updated_at\": null\n }\n]\n\nTasks to follow up with leads after initial contact.
\",\n\t\t\"order\": null,\n\t\t\"is_private\": false,\n\t\t\"created_at\": \"2024-11-22T11:06:11.000000Z\",\n \"updated_at\": \"2025-05-13T12:55:21.000000Z\"\n\t},\n\t{\n\t\t\"id\": 103,\n\t\t\"name\": \"Marketing Pipeline\",\n\t\t\"description\": \"\",\n\t\t\"order\": null,\n\t\t\"is_private\": false,\n\t\t\"created_at\": \"2024-11-22T11:06:11.000000Z\",\n \"updated_at\": \"2025-05-13T12:55:21.000000Z\"\n\t},\n\t{\n\t\t\"id\": 104,\n\t\t\"name\": \"Internal Workflow\",\n\t\t\"description\": \"\",\n\t\t\"order\": null,\n\t\t\"is_private\": false,\n\t\t\"created_at\": \"2024-11-22T11:06:11.000000Z\",\n \"updated_at\": \"2025-05-13T12:55:21.000000Z\"\n\t}\n]"}],"_postman_id":"f1c876af-3809-431f-8214-2fb0be06e464"}],"id":"e7297dc4-9731-40fa-ad14-563d5fa3e82b","_postman_id":"e7297dc4-9731-40fa-ad14-563d5fa3e82b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}},{"name":"Dashboard","item":[{"name":"Index","id":"ef2f02d7-ce41-4fdd-b8e2-8411ea125477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": 1,\n \"appointment_id\": 6058,\n \"title\": \"Hello There\",\n \"body\": \"Hello there mr 1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/v1/notifications/notify","urlObject":{"path":["v1","notifications","notify"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef2f02d7-ce41-4fdd-b8e2-8411ea125477"}],"id":"6b177b77-a20e-4d80-aca4-11db13e16f98","_postman_id":"6b177b77-a20e-4d80-aca4-11db13e16f98","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"40e76ef0-46a5-4edd-aede-229b92d0770d","id":"40e76ef0-46a5-4edd-aede-229b92d0770d","name":"Leadcenter API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"af2ee7e3-3919-453b-b310-788854b52084","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"4d8dfaef-7aa5-44a1-bf6c-e4871fa94155","type":"text/javascript","packages":{},"exec":[""]}}]}