{
  "opencollection": "1.0.0",
  "info": {
    "name": "Chatwoot Account AgentBots Contacts API",
    "version": "1.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Contacts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Contacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The attribute by which list should be sorted"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page parameter"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number"
        },
        {
          "info": {
            "name": "Create Contact",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Create a new Contact"
        },
        {
          "info": {
            "name": "Show Contact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/:id",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the contact"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Get a contact belonging to the account using ID"
        },
        {
          "info": {
            "name": "Update Contact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/:id",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the contact"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Update a contact belonging to the account using ID"
        },
        {
          "info": {
            "name": "Delete Contact",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/:id",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the contact"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Delete a contact belonging to the account using ID"
        },
        {
          "info": {
            "name": "Contact Conversations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/:id/conversations",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the contact"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Get conversations associated with that contact"
        },
        {
          "info": {
            "name": "Search Contacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/search",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Search using contact `name`, `identifier`, `email` or `phone number`"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The attribute by which list should be sorted"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page parameter"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number"
        },
        {
          "info": {
            "name": "Contact Filter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/filter",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Filter contacts with custom filter options and pagination"
        },
        {
          "info": {
            "name": "Create contact inbox",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/:id/contact_inboxes",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the contact"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Create a contact inbox record for an inbox"
        },
        {
          "info": {
            "name": "Get Contactable Inboxes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/contacts/:id/contactable_inboxes",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the contact"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Get List of contactable Inboxes"
        },
        {
          "info": {
            "name": "Merge Contacts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/actions/contact_merge",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_access_token",
              "value": "{{api_access_token}}",
              "placement": "header"
            }
          },
          "docs": "Merge two contacts into a single contact. The base contact remains and receives all\ndata from the mergee contact. After the merge, the mergee contact is permanently deleted.\n\nThis action is irreversible. All conversations, labels, and custom attributes from the\nmergee contact will be moved to the base contact.\n"
        }
      ]
    }
  ],
  "bundled": true
}