{
  "entity_type": "api_endpoints",
  "base_url": "https://services.leadconnectorhq.com",
  "endpoints": [
    {
      "name": "create_contact",
      "path": "/contacts",
      "method": "POST",
      "description": "Creates a new contact.",
      "required_parameters": {
        "firstName": { "type": "string", "description": "First name of the contact" },
        "lastName": { "type": "string", "description": "Last name of the contact" }
      },
      "optional_parameters": {
        "email": { "type": "string", "description": "Email address of the contact" },
        "phone": { "type": "string", "description": "Phone number of the contact" },
        "dnd": { "type": "boolean", "description": "Do not disturb status" }
      },
      "response_schema": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "dnd": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts {firstName: 'John', lastName: 'Doe', email: 'john.doe@example.com'}"
    },
    {
      "name": "search_contacts",
      "path": "/contacts",
      "method": "GET",
      "description": "Searches for contacts.",
      "required_parameters": {},
      "optional_parameters": {
        "query": { "type": "string", "description": "Search query" },
        "limit": { "type": "integer", "description": "Maximum number of results" },
        "page": { "type": "integer", "description": "Page number" }
      },
      "response_schema": {
        "contacts": [
          {
            "id": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "dnd": "boolean"
          }
        ],
        "total": "integer"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /contacts?query=John&limit=10"
    },
    {
      "name": "get_contact",
      "path": "/contacts/{id}",
      "method": "GET",
      "description": "Retrieves a contact by ID.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" }
      },
      "optional_parameters": {},
      "response_schema": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "dnd": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /contacts/123"
    },
    {
      "name": "update_contact",
      "path": "/contacts/{id}",
      "method": "PUT",
      "description": "Updates a contact by ID.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" }
      },
      "optional_parameters": {
        "firstName": { "type": "string", "description": "First name of the contact" },
        "lastName": { "type": "string", "description": "Last name of the contact" },
        "email": { "type": "string", "description": "Email address of the contact" },
        "phone": { "type": "string", "description": "Phone number of the contact" },
        "dnd": { "type": "boolean", "description": "Do not disturb status" }
      },
      "response_schema": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "dnd": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "PUT /contacts/123 {email: 'new.email@example.com'}"
    },
    {
      "name": "delete_contact",
      "path": "/contacts/{id}",
      "method": "DELETE",
      "description": "Deletes a contact by ID.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "DELETE /contacts/123"
    },
    {
      "name": "add_contact_tags",
      "path": "/contacts/{id}/tags",
      "method": "POST",
      "description": "Adds tags to a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tag names" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts/123/tags {tags: ['VIP', 'Customer']}"
    },
    {
      "name": "remove_contact_tags",
      "path": "/contacts/{id}/tags",
      "method": "DELETE",
      "description": "Removes tags from a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tag names" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "DELETE /contacts/123/tags {tags: ['VIP', 'Customer']}"
    },
    {
      "name": "get_contact_tasks",
      "path": "/contacts/{id}/tasks",
      "method": "GET",
      "description": "Retrieves tasks associated with a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" }
      },
      "optional_parameters": {},
      "response_schema": {
        "tasks": [
          {
            "id": "string",
            "title": "string",
            "description": "string",
            "dueDate": "string"
          }
        ]
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /contacts/123/tasks"
    },
    {
      "name": "create_contact_task",
      "path": "/contacts/{id}/tasks",
      "method": "POST",
      "description": "Creates a new task for a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "title": { "type": "string", "description": "Title of the task" },
        "dueDate": { "type": "string", "description": "Due date of the task (ISO 8601 format)" }
      },
      "optional_parameters": {
        "description": { "type": "string", "description": "Description of the task" }
      },
      "response_schema": {
        "id": "string",
        "title": "string",
        "description": "string",
        "dueDate": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts/123/tasks {title: 'Follow Up', dueDate: '2024-12-31T12:00:00Z'}"
    },
    {
      "name": "update_contact_task",
      "path": "/tasks/{taskId}",
      "method": "PUT",
      "description": "Updates a contact task by ID.",
      "required_parameters": {
        "taskId": { "type": "string", "description": "ID of the task" }
      },
      "optional_parameters": {
        "title": { "type": "string", "description": "Title of the task" },
        "description": { "type": "string", "description": "Description of the task" },
        "dueDate": { "type": "string", "description": "Due date of the task (ISO 8601 format)" }
      },
      "response_schema": {
        "id": "string",
        "title": "string",
        "description": "string",
        "dueDate": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "PUT /tasks/456 {dueDate: '2025-01-15T12:00:00Z'}"
    },
    {
      "name": "delete_contact_task",
      "path": "/tasks/{taskId}",
      "method": "DELETE",
      "description": "Deletes a contact task by ID.",
      "required_parameters": {
        "taskId": { "type": "string", "description": "ID of the task" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "DELETE /tasks/456"
    },
        {
      "name": "get_contact_notes",
      "path": "/contacts/{id}/notes",
      "method": "GET",
      "description": "Retrieves notes associated with a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" }
      },
      "optional_parameters": {},
      "response_schema": {
        "notes": [
          {
            "id": "string",
            "note": "string",
            "createdAt": "string"
          }
        ]
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /contacts/123/notes"
    },
    {
      "name": "create_contact_note",
      "path": "/contacts/{id}/notes",
      "method": "POST",
      "description": "Creates a new note for a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "note": { "type": "string", "description": "Note content" }
      },
      "optional_parameters": {},
      "response_schema": {
        "id": "string",
        "note": "string",
        "createdAt": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts/123/notes {note: 'Important details about the contact'}"
    },
    {
      "name": "update_contact_note",
      "path": "/notes/{noteId}",
      "method": "PUT",
      "description": "Updates a contact note by ID.",
      "required_parameters": {
        "noteId": { "type": "string", "description": "ID of the note" }
      },
      "optional_parameters": {
        "note": { "type": "string", "description": "Note content" }
      },
      "response_schema": {
        "id": "string",
        "note": "string",
        "createdAt": "string"
        },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "PUT /notes/456 {note: 'Updated note content'}"
    },
    {
      "name": "delete_contact_note",
      "path": "/notes/{noteId}",
      "method": "DELETE",
      "description": "Deletes a contact note by ID.",
      "required_parameters": {
        "noteId": { "type": "string", "description": "ID of the note" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "DELETE /notes/456"
    },
        {
      "name": "upsert_contact",
      "path": "/contacts/upsert",
      "method": "POST",
      "description": "Creates or updates a contact based on email or phone.",
      "required_parameters": {},
      "optional_parameters": {
        "email": { "type": "string", "description": "Email address of the contact" },
        "phone": { "type": "string", "description": "Phone number of the contact" },
        "firstName": { "type": "string", "description": "First name of the contact" },
        "lastName": { "type": "string", "description": "Last name of the contact" }
      },
      "response_schema": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "dnd": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts/upsert {email: 'john.doe@example.com', firstName: 'John', lastName: 'Doe'}"
    },
    {
      "name": "get_duplicate_contact",
      "path": "/contacts/duplicate",
      "method": "GET",
      "description": "Finds duplicate contacts based on email or phone.",
      "required_parameters": {},
      "optional_parameters": {
        "email": { "type": "string", "description": "Email address of the contact" },
        "phone": { "type": "string", "description": "Phone number of the contact" }
      },
      "response_schema": {
        "contacts": [
          {
            "id": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "dnd": "boolean"
          }
        ]
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /contacts/duplicate?email=john.doe@example.com"
    },
    {
      "name": "bulk_update_contact_tags",
      "path": "/contacts/bulk/tags",
      "method": "POST",
      "description": "Updates tags for multiple contacts.",
      "required_parameters": {
        "contactIds": { "type": "array", "items": { "type": "string" }, "description": "Array of contact IDs" },
        "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tag names" },
        "action": { "type": "string", "enum": ["add", "remove"], "description": "Action to perform (add or remove)" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts/bulk/tags {contactIds: ['123', '456'], tags: ['VIP'], action: 'add'}"
    },
    {
      "name": "add_contact_to_workflow",
      "path": "/contacts/{id}/workflows",
      "method": "POST",
      "description": "Adds a contact to a workflow.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "workflowId": { "type": "string", "description": "ID of the workflow" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts/123/workflows {workflowId: '789'}"
    },
    {
      "name": "remove_contact_from_workflow",
      "path": "/contacts/{id}/workflows",
      "method": "DELETE",
      "description": "Removes a contact from a workflow.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "workflowId": { "type": "string", "description": "ID of the workflow" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "DELETE /contacts/123/workflows {workflowId: '789'}"
    },
    {
      "name": "add_contact_followers",
      "path": "/contacts/{id}/followers",
      "method": "POST",
      "description": "Adds followers to a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "userIds": { "type": "array", "items": { "type": "string" }, "description": "Array of user IDs" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /contacts/123/followers {userIds: ['user1', 'user2']}"
    },
    {
      "name": "remove_contact_followers",
      "path": "/contacts/{id}/followers",
      "method": "DELETE",
      "description": "Removes followers from a contact.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the contact" },
        "userIds": { "type": "array", "items": { "type": "string" }, "description": "Array of user IDs" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "DELETE /contacts/123/followers {userIds: ['user1', 'user2']}"
    },
    {
      "name": "send_sms",
      "path": "/conversations/sms",
      "method": "POST",
      "description": "Sends an SMS message.",
      "required_parameters": {
        "phone": { "type": "string", "description": "Recipient's phone number" },
        "body": { "type": "string", "description": "Message body" }
      },
      "optional_parameters": {},
      "response_schema": {
        "messageId": "string",
        "status": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations/sms {phone: '+15551234567', body: 'Hello!'}"
    },
    {
      "name": "send_email",
      "path": "/conversations/email",
      "method": "POST",
      "description": "Sends an email message.",
      "required_parameters": {
        "email": { "type": "string", "description": "Recipient's email address" },
        "subject": { "type": "string", "description": "Email subject" },
        "body": { "type": "string", "description": "Email body (HTML)" }
      },
      "optional_parameters": {},
      "response_schema": {
        "messageId": "string",
        "status": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations/email {email: 'john.doe@example.com', subject: 'Important', body: '<p>Hello!</p>'}"
    },
    {
      "name": "search_conversations",
      "path": "/conversations",
      "method": "GET",
      "description": "Searches for conversations.",
      "required_parameters": {},
      "optional_parameters": {
        "contactId": { "type": "string", "description": "Filter by contact ID" },
        "limit": { "type": "integer", "description": "Maximum number of results" },
        "page": { "type": "integer", "description": "Page number" }
      },
      "response_schema": {
        "conversations": [
          {
            "id": "string",
            "contactId": "string",
            "messages": []
          }
        ],
        "total": "integer"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /conversations?contactId=123&limit=10"
    },
    {
      "name": "get_conversation",
      "path": "/conversations/{id}",
      "method": "GET",
      "description": "Retrieves a conversation by ID.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the conversation" }
      },
      "optional_parameters": {},
      "response_schema": {
        "id": "string",
        "contactId": "string",
        "messages": []
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /conversations/123"
    },
    {
      "name": "create_conversation",
      "path": "/conversations",
      "method": "POST",
      "description": "Creates a new conversation.",
      "required_parameters": {
        "contactId": { "type": "string", "description": "ID of the contact" }
      },
      "optional_parameters": {},
      "response_schema": {
        "id": "string",
        "contactId": "string",
        "messages": []
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations {contactId: '123'}"
    },
    {
      "name": "get_message",
      "path": "/conversations/messages/{id}",
      "method": "GET",
      "description": "Retrieves a message by ID.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the message" }
      },
      "optional_parameters": {},
      "response_schema": {
        "id": "string",
        "conversationId": "string",
        "body": "string",
        "type": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /conversations/messages/123"
    },
    {
      "name": "get_email_message",
      "path": "/conversations/emails/{id}",
      "method": "GET",
      "description": "Retrieves an email message by ID.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the email message" }
      },
      "optional_parameters": {},
      "response_schema": {
        "id": "string",
        "conversationId": "string",
        "subject": "string",
        "body": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /conversations/emails/123"
    },
    {
      "name": "upload_message_attachments",
      "path": "/conversations/messages/{id}/attachments",
      "method": "POST",
      "description": "Uploads attachments to a message.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the message" },
        "file": { "type": "file", "description": "File to upload" }
      },
      "optional_parameters": {},
      "response_schema": {
        "attachmentUrls": [
          "string"
        ]
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations/messages/123/attachments (multipart/form-data)"
    },
    {
      "name": "update_message_status",
      "path": "/conversations/messages/{id}/status",
      "method": "PUT",
      "description": "Updates the status of a message.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the message" },
        "status": { "type": "string", "enum": ["read", "unread"], "description": "Message status" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "PUT /conversations/messages/123/status {status: 'read'}"
    },
    {
      "name": "cancel_scheduled_message",
      "path": "/conversations/messages/{id}/cancel",
      "method": "POST",
      "description": "Cancels a scheduled message.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the message" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations/messages/123/cancel"
    },
    {
      "name": "get_message_recording",
      "path": "/conversations/messages/{id}/recording",
      "method": "GET",
      "description": "Retrieves the recording URL of a call message.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the message" }
      },
      "optional_parameters": {},
      "response_schema": {
        "recordingUrl": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /conversations/messages/123/recording"
    },
    {
      "name": "get_message_transcription",
      "path": "/conversations/messages/{id}/transcription",
      "method": "GET",
      "description": "Retrieves the transcription of a call message.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the message" }
      },
      "optional_parameters": {},
      "response_schema": {
        "transcription": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /conversations/messages/123/transcription"
    },
    {
      "name": "download_transcription",
      "path": "/conversations/messages/{id}/transcription/download",
      "method": "GET",
      "description": "Downloads the transcription of a call message.",
      "required_parameters": {
        "id": { "type": "string", "description": "ID of the message" }
      },
      "optional_parameters": {},
      "response_schema": "text/plain",
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "GET /conversations/messages/123/transcription/download"
    },
    {
      "name": "add_inbound_message",
      "path": "/conversations/inbound",
      "method": "POST",
      "description": "Manually logs an inbound message.",
      "required_parameters": {
        "contactId": { "type": "string", "description": "ID of the contact" },
        "body": { "type": "string", "description": "Message body" }
      },
      "optional_parameters": {},
      "response_schema": {
        "messageId": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations/inbound {contactId: '123', body: 'Received message'}"
    },
    {
      "name": "add_outbound_call",
      "path": "/conversations/outbound",
      "method": "POST",
      "description": "Manually logs an outbound call.",
      "required_parameters": {
        "contactId": { "type": "string", "description": "ID of the contact" },
        "duration": { "type": "integer", "description": "Call duration in seconds" }
      },
      "optional_parameters": {
        "notes": { "type": "string", "description": "Call notes" }
      },
      "response_schema": {
        "messageId": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations/outbound {contactId: '123', duration: 60, notes: 'Discussed pricing'}"
    },
    {
      "name": "live_chat_typing",
      "path": "/conversations/livechat/typing",
      "method": "POST",
      "description": "Sends a typing indicator for live chat.",
      "required_parameters": {
        "conversationId": { "type": "string", "description": "ID of the conversation" }
      },
      "optional_parameters": {},
      "response_schema": {
        "success": "boolean"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /conversations/livechat/typing {conversationId: '123'}"
    },
    {
      "name": "create_blog_post",
      "path": "/blogs/posts",
      "method": "POST",
      "description": "Creates a new blog post.",
      "required_parameters": {
        "title": { "type": "string", "description": "Title of the blog post" },
        "content": { "type": "string", "description": "Content of the blog post (HTML)" },
        "blogSiteId": { "type": "string", "description": "ID of the blog site" }
      },
      "optional_parameters": {
        "authorId": { "type": "string", "description": "ID of the author" },
        "categoryId": { "type": "string", "description": "ID of the category" },
        "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tag names" },
        "seoTitle": { "type": "string", "description": "SEO title" },
        "seoDescription": { "type": "string", "description": "SEO description" },
        "slug": { "type": "string", "description": "URL slug" }
      },
      "response_schema": {
        "id": "string",
        "title": "string",
        "content": "string",
        "blogSiteId": "string"
      },
      "rate_limits": {
        "requests_per_minute": 60
      },
      "example_usage": "POST /blogs/posts {title: 'New Post', content: '<p>Hello!</p>', blogSiteId: '123'}"
    },
    {
      "name": "update_blog_post",
      "path": "/blogs/posts/{id}",
      "method": "PUT",
      "description": "Updates a blog post by ID.",
      "required_parameters": {
        "id": { "type