{"info":{"name":"Crisp REST API Reference (V1)","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Website","description":"Manages Crisp websites.","item":[{"name":"Base","description":"Manages websites.","item":[{"name":"Check If Website Exists","description":"Checks if given website exists (by domain).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website"],"variable":[],"query":[{"description":"The website domain to check against","key":"domain","value":""}]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Create Website","description":"Creates a new website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website"],"variable":[],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"name\": \"Acme, Inc.\",\n    \"domain\": \"acme-inc.com\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get A Website","description":"Resolves an existing website information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete A Website","description":"Deletes an existing website.\n\n!! The deletion will be scheduled and not processed immediately, for security reasons. It will be executed after a few days. All website owners will be notified of the ongoing deletion via email, which they can request a cancellation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Abort Website Deletion","description":"Aborts scheduled deletion for an existing website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","expunge"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Conversations","description":"Manages multiple website conversations.","item":[{"name":"⭐ List Conversations","description":"Lists conversations for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"Page number for conversations paging","key":"page_number","value":""}],"query":[{"description":"Page size for conversations paging (between `20` and `50`, defaults to `20`)","key":"per_page","value":""},{"description":"Search query in all conversations (text if type is `text` or `segment`, filter if type is `filter`)","key":"search_query","value":""},{"description":"Search type (either `text`, `segment` or `filter`)","key":"search_type","value":""},{"description":"Search operator if search type is `filter` (`or` or `and` respectful to boolean algebra, defaults to `and` if not set)","key":"search_operator","value":""},{"description":"Whether to include conversations without any message (`1` or `0`, defaults to `0`)","key":"include_empty","value":""},{"description":"Whether to return only conversations categorized under provided inbox identifier (use `all` for all inboxes)","key":"filter_inbox_id","value":""},{"description":"Whether to return only conversations with unread messages (`1` or `0`, defaults to `0`)","key":"filter_unread","value":""},{"description":"Whether to return only conversations that are resolved (`1` or `0`, defaults to `0`)","key":"filter_resolved","value":""},{"description":"Whether to return only conversations that are not resolved (`1` or `0`, defaults to `0`)","key":"filter_not_resolved","value":""},{"description":"Whether to return only conversations where user is mentioned (`1` or `0`, defaults to `0`)","key":"filter_mention","value":""},{"description":"Whether to return only conversations that are assigned to user identifier","key":"filter_assigned","value":""},{"description":"Whether to return only conversations that are not assigned to any user (`1` or `0`, defaults to `0`)","key":"filter_unassigned","value":""},{"description":"When to start relative to conversation update date (date, ISO 8601, eg. `2018-03-01T17:00:00.000Z`)","key":"filter_date_start","value":""},{"description":"When to end relative to conversation update date (date, ISO 8601, eg. `2018-04-01T10:30:00.000Z`)","key":"filter_date_end","value":""},{"description":"Whether to order conversations by date created instead of default order (`1` or `0`, defaults to `0`)","key":"order_date_created","value":""},{"description":"Whether to order conversations by date updated instead of default order (`1` or `0`, defaults to `0`)","key":"order_date_updated","value":""},{"description":"Whether to order conversations by longest date waiting instead of default order, this also filters out non-waiting conversations (`1` or `0`, defaults to `0`)","key":"order_date_waiting","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Suggested Conversation Segments","description":"Lists suggested conversation segments for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations","suggest","segments",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The page number (paging in segment list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Suggested Conversation Segment","description":"Deletes a suggested conversation segment for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations","suggest","segment"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Suggested Conversation Data Keys","description":"Lists suggested conversation data keys for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations","suggest","data",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The page number (paging in data list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Suggested Conversation Data Key","description":"Deletes a suggested conversation data key for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations","suggest","data"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Spam Conversations","description":"Lists spam conversations in website. Those are not conversation entities, but can be converted to conversations if a spam is later accepted as ham.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations","spams",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The page number (paging in spam list)","key":"page_number","value":""}],"query":[{"description":"Filter by spam type (eg. `email`)","key":"filter_type","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Spam Conversation Content","description":"Resolves full content for spam conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations","spam",":spam_id","content"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The spam identifier","key":"spam_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Submit Spam Conversation Decision","description":"Submits decision on spam conversation (this allows to accepts or rejects a spam). If rejected, a spam message will be gone forever. If accepted, it will get transformed into a regular conversation.\n\nThe decision acknowledgement is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `spam:decision`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversations","spam",":spam_id","decision"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The spam identifier","key":"spam_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"action\": \"reject\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Conversation","description":"Manages a single website conversation.","item":[{"name":"⭐ Create A New Conversation","description":"Creates a new conversation.\n\n!! This conversation will not be visible in your Crisp Inbox until a message is sent with an `user` from value.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Conversation Exists","description":"Checks if given conversation session identifier exists.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Get A Conversation","description":"Resolves conversation information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Remove A Conversation","description":"Removes a conversation in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Initiate A Conversation With Existing Session","description":"Initiates a conversation from an existing session.\n\nUsed to initiate a conversation from website visitor list.\n\nThe client acknowledgement is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `session:request:initiated`.\n\n!!! This method shall not be used to create a conversation. Please use [Create a New Conversation](#create-a-new-conversation) instead.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","initiate"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Get Messages In Conversation","description":"Resolves messages in an existing conversation. Returns the last batch of messages if there are many messages in the conversation. Then, messages can be paged up to most recent message using the `timestamp_before` parameter.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","messages"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[{"description":"Returned message batch should end before given timestamp (used for infinite scroll paging)","key":"timestamp_before","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Send A Message In Conversation","description":"Sends a message in an existing conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","message"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"type\": \"text\",\n    \"from\": \"operator\",\n    \"origin\": \"chat\",\n    \"content\": \"Hey there! Need help?\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get A Message In Conversation","description":"Resolves an existing message in an existing conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","message",":fingerprint"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The message fingerprint","key":"fingerprint","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update A Message In Conversation","description":"Edits an existing message in an existing conversation.\n\nThe updated event is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `message:updated`.\n\n!! Note that editing messages is only possible if the conversation is initiated from the Crisp Chatbox. This will not work with integrations such as: Email, Messenger, Telegram, etc.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","message",":fingerprint"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The edited message fingerprint","key":"fingerprint","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"content\": \"Hey there! Need help?\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Remove A Message In Conversation","description":"Removes an existing message in an existing conversation. Used to retract a previously-sent message.\n\nThe updated event is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `message:removed`.\n\n!! Note that retracting messages may not completely remove the message if it was already sent over email, or if the chatbox is not online whilst the message is removed. As well, certain integrations ignore message removals.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","message",":fingerprint"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The removed message fingerprint","key":"fingerprint","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Compose A Message In Conversation","description":"Starts or stop composing a message in an existing conversation. This route is used for MagicType preview.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","compose"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"type\": \"start\",\n    \"from\": \"operator\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Mark Messages As Read In Conversation","description":"Marks messages as read in conversation. Either using given message fingerprints, or all messages.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","read"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"from\": \"operator\",\n    \"origin\": \"urn:crisp.im:slack:0\",\n\n    \"fingerprints\": [\n        5719231201\n    ]\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Mark Conversation As Unread","description":"Marks whole conversation as unread.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","unread"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"from\": \"user\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Mark Messages As Delivered In Conversation","description":"Marks messages as delivered in conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","delivered"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"from\": \"operator\",\n    \"origin\": \"urn:crisp.im:slack:0\",\n\n    \"fingerprints\": [\n        5719231201\n    ]\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Conversation Open State","description":"Updates conversation open state for authenticated operator user. Lets other operators see which conversation people are on at any given moment. This state automatically expires after a while, if not renewed.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","open"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"opened\": true\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Get Conversation Routing Assign","description":"Resolves assigned operator for conversation routing.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","routing"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Assign Conversation Routing","description":"Assigns conversation routing to an operator, or unassign.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","routing"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"assigned\": {\n        \"user_id\": \"a4c32c68-be91-4e29-8a05-976e93abbe3f\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Conversation Inbox","description":"Updates inbox used for conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","inbox"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"inbox_id\": null\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Get Conversation Metas","description":"Resolves conversation meta information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","meta"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Update Conversation Metas","description":"Updates conversation meta information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","meta"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"nickname\": \"John Doe\",\n    \"email\": \"john.doe@acme-inc.com\",\n\n    \"segments\": [\n        \"happy\",\n        \"customer\",\n        \"love\"\n    ],\n\n    \"data\": {\n        \"type\": \"customer\",\n        \"signup\": \"finished\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get An Original Message In Conversation","description":"Resolves an existing original message in an existing conversation. This route is mainly used to retrieve original HTML content and headers for emails.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","original",":original_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The original identifier","key":"original_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Conversation Pages","description":"Lists browsed pages in conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","pages",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The page number (paging in page list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Conversation Events","description":"Lists stacked events in conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","events",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The page number (paging in event list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Conversation Files","description":"Lists files in conversation (extracted from messages).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","files",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The page number (paging in file list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Conversation State","description":"Resolves conversation state (resolved, unresolved or pending).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","state"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Change Conversation State","description":"Updates conversation state (resolved, unresolved or pending).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","state"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"state\": \"unresolved\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Conversation Relations","description":"Resolves conversation relations (related conversations: parents and children, if any).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","relations"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Conversation Participants","description":"Resolves conversation participants (external participants, eg. emails to be set in CC).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","participants"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Conversation Participants","description":"Saves conversation participants (external participants, eg. emails to be set in CC).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","participants"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"participants\": [\n        {\n            \"type\": \"email\",\n            \"target\": \"jane.doe@acme-inc.com\"\n        }\n    ]\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Block Status For Conversation","description":"Resolves conversation block status.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","block"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Block Incoming Messages For Conversation","description":"Blocks further incoming messages from a conversation. Messages from visitor will be silently dropped, but you can still send messages to visitor.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","block"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"blocked\": true\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Verify Status For Conversation","description":"Resolves conversation verify status.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","verify"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Verify Status For Conversation","description":"Updates conversation verify status. When a conversation user is verified, a verified badge shows in the Crisp apps.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","verify"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"verified\": true\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Request Identity Verification For Conversation","description":"Requests a verification of an identity channel for conversation. Verifying a channel automatically marks the whole conversation as verified, showing a verified badge in the Crisp apps.\n\nOnce the user verified ownership of their identity, an acknowledgement will be sent on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `session:update_verify`. The verified identity will appear in `verifications`.\n\nIf requesting an identity verification for a plugin (with identity set to a plugin URN, eg. `urn:crisp.im:whatsapp:0`), then the `identity:verify:request` event will be sent on the [RTM Events channel](/references/rtm-api/v1/). It is the responsibility of the target plugin to react to this identity verification request event, and deliver the provided verification code to the end-user. Other identity verification methods, such as `email` and `phone`, are fully managed by Crisp end-to-end and therefore they do not require a custom implementation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","verify","identity"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"identity\": \"email\",\n    \"method\": \"link\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Redeem Identity Verification Link For Conversation","description":"Redeems a verification link to verify an identity channel for conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","verify","identity","link"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"identity\": \"email\",\n    \"token\": \"709691\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Request Email Transcript For Conversation","description":"Requests an email transcript for a conversation. The transcript is emailed to the authenticated user, or to the indicated email. It contains all conversation history and may be kept for as an external record.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","transcript"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"to\": \"operator\",\n    \"email\": \"valerian@crisp.chat\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Request Chatbox Binding Purge For Conversation","description":"Requests a chatbox binding purge for conversation. The visitor must be online for the purge to be proceeded.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","purge"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Request User Feedback For Conversation","description":"Requests feedback from user for conversation. The visitor must be online for the feedback request to be delivered.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","feedback"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Browsing Sessions For Conversation","description":"Lists available browsing sessions for conversation. A browsing session can be initiated to stream user screen content to operators.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","browsing"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Initiate Browsing Session For Conversation","description":"Initiates browsing session for conversation.\n\nUsed to ask a client to prepare for a streamed browsing session for all open tabs, and request acknowledgement of when the client is ready to accept browsing stream actions (one acknowledgement per tab).\n\nThe client acknowledgement is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `browsing:request:initiated` if initiated, or `browsing:request:rejected` if not initiated.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","browsing"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Send Action To An Existing Browsing Session","description":"Sends an action to an existing browsing session. Used to send stream actions to a browsing session (eg. to start or stop the stream session).\n\nThe client acknowledgement is sent back asynchronously on the streaming channel, using either the event namespace `app:browsing:action:started` or `app:browsing:action:stopped` (depending on the request `action` parameter, if `action` is `start` or `stop`).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","browsing",":browsing_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The browsing session identifier","key":"browsing_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"action\": \"start\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Assist An Existing Browsing Session","description":"Assists an existing browsing session. Used by LiveAssist™ to start or stop an assist session, used by operators to take control on the screen of user browser (mouse move and scroll).\n\nThe client acknowledgement is sent back asynchronously on the streaming channel, using either the event namespace `app:browsing:assist:started` or `app:browsing:assist:stopped` (depending on the request `action` parameter, if `action` is `start` or `stop`). Other actions do not imply real-time feedbacks.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","browsing",":browsing_id","assist"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The browsing session identifier","key":"browsing_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"action\": \"mouse\",\n\n    \"mouse\": {\n        \"x\": 0,\n        \"y\": 784\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Initiate New Call Session For Conversation","description":"Initiates a new audio/video call session for conversation.\n\nUsed to request a client to open a call session (audio + video). The client acknowledgement is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using either the event namespace `call:request:accept` or `call:request:decline`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","call"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"mode\": \"audio\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Ongoing Call Session For Conversation","description":"Gets the ongoing audio/video call session for conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","call"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Abort Ongoing Call Session For Conversation","description":"Aborts the ongoing audio/video call session for conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","call",":call_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The call identifier","key":"call_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Transmit Signaling On Ongoing Call Session","description":"Transmits a signaling payload for the ongoing audio/video call session for conversation.\n\nUsed to emit a signaling payload to the other client, that is also part of the call session. The client signaling payloads are sent back asynchronously on the streaming channel, using either the event namespace `app:call:signaling:sdp` or `app:call:signaling:candidate`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","call",":call_id","signaling"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The call identifier","key":"call_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n  \"type\": \"sdp\",\n  \"payload\": {}\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Deliver Widget Button Action For Conversation","description":"Delivers a button action on plugin widget for conversation, used to perform an action on the plugin, eg. refund a user. A hook will be sent to the plugin widget receiver.\n\nDelivery completion or failure will be acknowledged on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `widget:action:processed`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","widget",":plugin_id","button"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The plugin identifier for widget","key":"plugin_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"section_id\": \"payments\",\n    \"item_id\": \"refund_on_stripe\",\n\n    \"data\": {\n        \"invoice\": \"D-1929-X\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Deliver Widget Data Action For Conversation","description":"Delivers a data action on plugin widget for conversation, used to either fetch or edit a data value from the plugin, eg. fetch a user unpaid balance. A hook will be sent to the plugin widget receiver.\n\nDelivery completion will be acknowledged on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `widget:action:processed`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","widget",":plugin_id","data"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""},{"description":"The plugin identifier for widget","key":"plugin_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"section_id\": \"payments\",\n    \"item_id\": \"unpaid_balance\",\n    \"action\": \"fetch\",\n    \"data\": {}\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Schedule A Reminder For Conversation","description":"Schedules a reminder in the future for conversation, with a note to your future-self. A push notification and an email will be sent, as well as a note in the conversation.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","reminder"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"date\": \"2018-05-29T09:00:00Z\",\n    \"note\": \"Call this customer.\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Report Conversation","description":"Reports a conversation to Crisp and remove it from the inbox. This can be used to move an entire conversation to spams.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","conversation",":session_id","report"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The conversation session identifier","key":"session_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"flag\": \"spam\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"People","description":"Manages website people.","item":[{"name":"Get People Statistics","description":"Resolves the amount of people stored in the CRM.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","stats"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Suggested People Segments","description":"Lists suggested segments for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","suggest","segments",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The page number (paging in segment list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Suggested People Segment","description":"Deletes a suggested segment for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","suggest","segment"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Suggested People Data Keys","description":"Lists suggested data keys for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","suggest","data",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The page number (paging in data list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Suggested People Data Key","description":"Deletes a suggested data key for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","suggest","data"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Suggested People Events","description":"Lists suggested events for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","suggest","events",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The page number (paging in event list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Suggested People Event","description":"Deletes a suggested event for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","suggest","event"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ List People Profiles","description":"Lists people profiles for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","profiles",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"Page number for people paging","key":"page_number","value":""}],"query":[{"description":"Page size for people paging (between `20` and `50`, defaults to `20`)","key":"per_page","value":""},{"description":"Sort on field (based on available search field names, eg. `nickname` and more)","key":"sort_field","value":""},{"description":"Sort order (`ascending` or `descending`)","key":"sort_order","value":""},{"description":"Search operator (`or` or `and` respectful to boolean algebra, defaults to `and` if not set)","key":"search_operator","value":""},{"description":"Search filter (object filter mapped as string)","key":"search_filter","value":""},{"description":"Search text (text for a quick search)","key":"search_text","value":""},{"description":"When to start relative to profile creation date (date, ISO 8601)","key":"filter_date_start","value":""},{"description":"When to end relative to profile creation date (date, ISO 8601)","key":"filter_date_end","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Add New People Profile","description":"Adds a new people profile.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","profile"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"email\": \"valerian@crisp.chat\",\n\n    \"person\": {\n        \"nickname\": \"Valerian Saliou\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Check If People Profile Exists","description":"Checks if given people profile exists.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","profile",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Get People Profile","description":"Resolves people profile.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","profile",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Save People Profile","description":"Saves people profile, and overwrite all previous information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","profile",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"email\": \"valerian@crisp.chat\",\n\n    \"person\": {\n        \"nickname\": \"Valerian Saliou\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Update People Profile","description":"Updates people profile, and save only changed fields on the previous profile revision.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","profile",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"email\": \"valerian@crisp.chat\",\n\n    \"person\": {\n        \"nickname\": \"Valerian Saliou\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"⭐ Remove People Profile","description":"Removes people profile in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","profile",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List People Conversations","description":"Lists conversations linked to people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","conversations",":people_id","list",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""},{"description":"The page number (paging in conversation list)","key":"page_number","value":""}],"query":[{"description":"Whether to return only conversations with unread messages (`1` or `0`, defaults to `0`)","key":"filter_unread","value":""},{"description":"Whether to return only conversations that are resolved (`1` or `0`, defaults to `0`)","key":"filter_resolved","value":""},{"description":"Whether to return only conversations that are not resolved (`1` or `0`, defaults to `0`)","key":"filter_not_resolved","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List People Campaigns","description":"Lists campaigns linked to people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","campaigns",":people_id","list",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""},{"description":"The page number (paging in campaign list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Add A People Event","description":"Stacks an event for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","events",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"text\": \"Added item to basket\",\n\n    \"data\": {\n        \"price\": 10.99,\n        \"currency\": \"USD\"\n    },\n\n    \"color\": \"red\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List People Events","description":"Lists stacked events for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","events",":people_id","list",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""},{"description":"The page number (paging in event list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get People Data","description":"Gets stored data for people.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","data",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save People Data","description":"Saves stored data for people. This replaces any already-set data with the new data keys.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","data",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"data\": {\n        \"type\": \"customer\",\n        \"signup\": \"finished\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update People Data","description":"Updates stored data for people. This merges the new data keys with already-set data.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","data",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"data\": {\n        \"signup\": \"finished\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get People Subscription Status","description":"Resolves subscription status for people (subscribed or unsubscribed).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","subscription",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update People Subscription Status","description":"Updates current subscription status for people (subscribe or unsubscribe).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","subscription",":people_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The people identifier (also allowed: people email)","key":"people_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"email\": true\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Export People Profiles","description":"Exports people profiles. The exported data is sent back to email to the requester user.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","export","profiles"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Import People Profiles","description":"Imports people profiles. The imported data, eg. a CSV file containing user emails and full names is used to populate website user database.\n\nThe import events are sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using either the event namespace `people:import:progress` or `people:import:done`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","people","import","profiles"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"url\": \"https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv\",\n\n    \"mapping\": [\n        {\n            \"column\": 1,\n            \"field\": \"email\"\n        },\n\n        {\n            \"column\": 2,\n            \"field\": \"person.nickname\"\n        }\n    ],\n\n    \"options\": {\n        \"column_separator\": \";\",\n        \"skip_header\": true\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Visitors","description":"Manages multiple website visitors.","item":[{"name":"Count Visitors","description":"Counts visitors currently on website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","visitors","count"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Visitors","description":"Lists visitors currently on website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","visitors","list",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"Page number for visitors paging","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Pinpoint Visitors On A Map","description":"Maps visitors in a geographical area, given a geographical center and a map radius (defaults to whole Earth if none given). Visitors are grouped in geographical points. There is a static number of points per area (the area is composed of sub-divisions of equal size). Only points which contain visitors are returned.\n\nThe map precision increases as the area radius decreases. If there are too many visitors in a given geographical point, an approximate visitors count number will be given.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","visitors","map"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[{"description":"Area center point latitude","key":"center_latitude","value":""},{"description":"Area center point longitude","key":"center_longitude","value":""},{"description":"Area radius (in kilometers)","key":"center_radius","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Session Identifier From Token","description":"Transforms a token to a session identifier, if any session is bound to the token. The token can be bound to a session from the Crisp chatbox.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","visitors","token",":token_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The token identifier","key":"token_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Count Blocked Visitors","description":"Counts all blocked visitors on website, by rule list.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","visitors","blocked"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Count Blocked Visitors In Rule","description":"Counts all blocked visitors in rule list on website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","visitors","blocked",":block_rule"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The block rule (`ip` or `email`)","key":"block_rule","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Clear Blocked Visitors In Rule","description":"Clears all blocked visitors in rule list on website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","visitors","blocked",":block_rule"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The block rule (`ip` or `email`)","key":"block_rule","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Availability","description":"Manages website availability operations.","item":[{"name":"Get Website Availability Status","description":"Resolves the website availability status. This tells whether the chatbox is seen as online or away by visitors.\n\nThe availability status is set to online if at least one operator can be seen as online (given his account availability settings).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","availability","status"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Website Operator Availabilities","description":"Lists the availabilities for website operators. This maps the availability of each operator in the website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","availability","operators"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Operators","description":"Manages multiple website operators.","item":[{"name":"List Website Operators","description":"Lists all operator members of website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operators","list"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Last Active Website Operators","description":"Lists last active website operators, ie. operators who last replied to a visitor message.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operators","active"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Flush Last Active Website Operators","description":"Flushes the list of last active website operators, ie. operators who last replied to a visitor message.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operators","active"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Send Email To Website Operators","description":"Sends an email to target website operators. The email will be delivered to each operator account email address.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operators","email"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"recipient\": \"owners\",\n    \"subject\": \"Plugin limits reached\",\n    \"message\": \"Hi, you've reached the Slack plugin limits. Please contact our support team.\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Operator","description":"Manages a single website operator.","item":[{"name":"Get A Website Operator","description":"Resolves a given website operator.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operator",":user_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The user identifier for operator","key":"user_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Invite A Website Operator","description":"Invites an email to join website as operator. The target email doesn't need to be a valid Crisp account, since Crisp will send an invite email to that email. The receiver is then prompted to click on a link to either join the website with an existing account, or create a new account on the fly.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operator"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"email\": \"julien@crisp.chat\",\n    \"role\": \"member\",\n\n    \"verify\": {\n        \"method\": \"password\",\n        \"secret\": \"MySuperSecurePassword\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Change Operator Membership","description":"Changes the membership of an existing operator. Useful to downgrade or upgrade an operator from/to owner role, or change their title in the team.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operator",":user_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The user identifier for operator","key":"user_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"role\": \"owner\",\n    \"title\": \"CTO\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Unlink Operator From Website","description":"Unlinks given operator from website. Note that the last operator in the website cannot be unlinked.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","operator",":user_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The user identifier for operator","key":"user_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Helpdesk","description":"Manages website helpdesk.","item":[{"name":"Check If Helpdesk Exists","description":"Checks if helpdesk exists for website (ie. if it has been initialized).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk","description":"Resolves helpdesk information for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Initialize Helpdesk","description":"Initializes a new helpdesk for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"name\": \"Valerian Helpdesk\",\n    \"domain_basic\": \"valerian\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Helpdesk","description":"Deletes helpdesk for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Helpdesk Locales","description":"Lists locales for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locales",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"Page number for locales paging","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Add Helpdesk Locale","description":"Adds a locale for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"locale\": \"en\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Helpdesk Locale Exists","description":"Checks if a helpdesk locale exists for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Locale","description":"Resolves a locale for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Helpdesk Locale","description":"Deletes a locale for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Helpdesk Locale Articles","description":"Lists articles for a helpdesk locale in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","articles",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"Page number for articles paging","key":"page_number","value":""}],"query":[{"description":"Whether to order articles by visits instead of default order (`1` or `0`)","key":"order_visits","value":""},{"description":"Search by article title","key":"search_title","value":""},{"description":"Filter by article category identifier (identifier or `none`)","key":"filter_category_id","value":""},{"description":"Filter by article section identifier (identifier or `none`, requires `filter_category_id` to be set as well)","key":"filter_section_id","value":""},{"description":"Filter by article published status (`1` or `0`)","key":"filter_status_published","value":""},{"description":"Filter by article draft status (`1` or `0`)","key":"filter_status_draft","value":""},{"description":"Filter by article visible visibility (`1` or `0`)","key":"filter_visibility_visible","value":""},{"description":"Filter by article hidden visibility (`1` or `0`)","key":"filter_visibility_hidden","value":""},{"description":"When to start relative to article creation date (date, ISO 8601)","key":"filter_date_start","value":""},{"description":"When to end relative to article creation date (date, ISO 8601)","key":"filter_date_end","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Add A New Helpdesk Locale Article","description":"Adds a new locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"title\": \"How to use $crisp JavaScript SDK?\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Helpdesk Locale Article Exists","description":"Checks if a locale article exists for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Locale Article","description":"Resolves a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Helpdesk Locale Article","description":"Saves a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"title\": \"How to use $crisp JavaScript SDK?\",\n    \"description\": null,\n    \"content\": \"Crisp lets you create your customized chatbox easily. **It's easy to setup**.\",\n    \"featured\": false,\n    \"order\": 1\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Helpdesk Locale Article","description":"Updates a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"content\": \"Crisp lets you create your customized chatbox easily. **It's easy to setup**.\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Helpdesk Locale Article","description":"Deletes a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Locale Article Page","description":"Resolves a locale article page information for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","page"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Locale Article Category","description":"Resolves a locale article category for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","category"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Helpdesk Locale Article Category","description":"Updates a locale article category for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","category"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"category_id\": \"00d344a3-8948-45b5-9bc4-82ec249fcd44\",\n    \"section_id\": null\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Helpdesk Locale Article Alternates","description":"Lists alternate locales on a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","alternates"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Helpdesk Locale Article Alternate Exists","description":"Checks if alternate locale exists on a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","alternate",":locale_linked"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""},{"description":"The linked locale code","key":"locale_linked","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Locale Article Alternate","description":"Resolves alternate locale on a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","alternate",":locale_linked"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""},{"description":"The linked locale code","key":"locale_linked","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Helpdesk Locale Article Alternate","description":"Saves alternate locale on a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","alternate",":locale_linked"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""},{"description":"The linked locale code","key":"locale_linked","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"article_id\": \"9dc0e823-56b0-43ca-9ca3-47e25a8eb543\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Helpdesk Locale Article Alternate","description":"Deletes alternate locale on a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","alternate",":locale_linked"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""},{"description":"The linked locale code","key":"locale_linked","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Publish Helpdesk Locale Article","description":"Publishes a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","publish"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Unpublish Helpdesk Locale Article","description":"Unpublishes a locale article for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","article",":article_id","unpublish"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The article identifier","key":"article_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Helpdesk Locale Categories","description":"Lists locale categories for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","categories",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"Page number for categories paging","key":"page_number","value":""}],"query":[{"description":"Search by category name","key":"search_name","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Add Helpdesk Locale Category","description":"Adds a locale category for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"Chatbox\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Helpdesk Locale Category Exists","description":"Checks if a locale category exists for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Locale Category","description":"Resolves a locale category for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Helpdesk Locale Category","description":"Saves a locale category for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"Chatbox\",\n    \"description\": \"Help on how to setup and use the Crisp chatbox.\",\n    \"color\": \"#377FEA\",\n    \"image\": null,\n    \"order\": 1\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Helpdesk Locale Category","description":"Updates a locale category for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"color\": \"#377FEA\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Helpdesk Locale Category","description":"Deletes a locale category for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Helpdesk Locale Sections","description":"Lists locale sections for helpdesk in website and category.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id","sections",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""},{"description":"Page number for sections paging","key":"page_number","value":""}],"query":[{"description":"Search by section name","key":"search_name","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Add Helpdesk Locale Section","description":"Adds a locale section for helpdesk in website and category.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id","section"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"Integrate with our SDKs\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Helpdesk Locale Section Exists","description":"Checks if a locale section exists for helpdesk in website and category.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id","section",":section_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""},{"description":"The section identifier","key":"section_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Locale Section","description":"Resolves a locale section for helpdesk in website and category.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id","section",":section_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""},{"description":"The section identifier","key":"section_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Helpdesk Locale Section","description":"Saves a locale section for helpdesk in website and category.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id","section",":section_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""},{"description":"The section identifier","key":"section_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"Integrate with our SDKs\",\n    \"order\": 1\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Helpdesk Locale Section","description":"Updates a locale section for helpdesk in website and category.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id","section",":section_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""},{"description":"The section identifier","key":"section_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"order\": 3\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Helpdesk Locale Section","description":"Deletes a locale section for helpdesk in website and category.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","category",":category_id","section",":section_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The category identifier","key":"category_id","value":""},{"description":"The section identifier","key":"section_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Map Helpdesk Locale Feedback Ratings","description":"Map locale feedback ratings for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","feedback","ratings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[{"description":"When to start relative to feedback creation date (date, ISO 8601)","key":"filter_date_start","value":""},{"description":"When to end relative to feedback creation date (date, ISO 8601)","key":"filter_date_end","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Helpdesk Locale Feedbacks","description":"Lists locale feedbacks for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","feedback","list",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""},{"description":"The page number (paging in feedbacks list)","key":"page_number","value":""}],"query":[{"description":"When to start relative to feedback creation date (date, ISO 8601)","key":"filter_date_start","value":""},{"description":"When to end relative to feedback creation date (date, ISO 8601)","key":"filter_date_end","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Import External Helpdesk To Locale","description":"Imports a whole external helpdesk to Crisp, as a Crisp Helpdesk. The import crawler pipeline is asynchronous.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","import"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"helpdesk_url\": \"https://docs.acme.com/\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Export Helpdesk Locale Articles","description":"Exports helpdesk articles for locale. The exported data is sent back to email to the requester user.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","locale",":locale","export"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The locale code","key":"locale","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Helpdesk Redirections","description":"Lists redirections for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","redirections",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"Page number for redirections paging","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Add Helpdesk Redirection","description":"Adds a redirection for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","redirection"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"path\": \"/en/article/how-can-i-automatically-set-custom-user-data/\",\n    \"target\": \"/en/article/how-can-i-automatically-set-custom-user-data-1xh7pqk/\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Helpdesk Redirection Exists","description":"Checks if a helpdesk redirection exists for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","redirection",":redirection_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The redirection identifier","key":"redirection_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Redirection","description":"Resolves a redirection for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","redirection",":redirection_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The redirection identifier","key":"redirection_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Helpdesk Redirection","description":"Deletes a redirection for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","redirection",":redirection_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The redirection identifier","key":"redirection_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Settings","description":"Resolves settings for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Helpdesk Settings","description":"Saves settings for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"Valerian Helpdesk\",\n\n    \"appearance\": {\n        \"logos\": {\n            \"header\": null,\n            \"footer\": null\n        },\n\n        \"banner\": null\n    },\n\n    \"behavior\": {\n        \"frequently_read\": true,\n        \"show_category_images\": true,\n        \"show_chatbox\": true,\n        \"ask_feedback\": false,\n        \"locale_picker\": false,\n        \"refer_link\": true,\n        \"forbid_indexing\": false,\n        \"status_health_dead\": true\n    },\n\n    \"include\": {\n        \"html\": null\n    },\n\n    \"access\": {\n        \"password\": null\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resolve Helpdesk Domain","description":"Resolves domain for helpdesk in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","domain"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Request Helpdesk Domain Change","description":"Requests a change in the domain used for helpdesk. The change will be propagated once all setup steps are fulfilled (see the setup route).\n\nThe domain validation result is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using either event namespace `website:validate:domain:valid` or `website:validate:domain:invalid` (if the custom domain was changed and thus requires validation).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","domain"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"basic\": \"valerian\",\n    \"custom\": \"help.valeriansaliou.name\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Generate Helpdesk Domain Setup Flow","description":"Retrieves the domain setup flow for helpdesk. This will return the DNS records required for helpdesk domain setup.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","helpdesk","domain","setup"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[{"description":"Custom domain to use for setup","key":"custom","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Campaigns","description":"Manages multiple website campaigns.","item":[{"name":"List Campaigns","description":"Lists campaigns for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","list",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"Page number for campaigns paging","key":"page_number","value":""}],"query":[{"description":"Search by campaign name","key":"search_name","value":""},{"description":"Filter by campaign tag","key":"filter_tag","value":""},{"description":"Filter by campaign one-shot type (`1` or `0`)","key":"filter_type_one_shot","value":""},{"description":"Filter by campaign automated type (`1` or `0`)","key":"filter_type_automated","value":""},{"description":"Filter by campaign not configured status (`1` or `0`)","key":"filter_status_not_configured","value":""},{"description":"Filter by campaign ready status (`1` or `0`)","key":"filter_status_ready","value":""},{"description":"Filter by campaign paused status (`1` or `0`)","key":"filter_status_paused","value":""},{"description":"Filter by campaign sending status (`1` or `0`)","key":"filter_status_sending","value":""},{"description":"Filter by campaign done status (`1` or `0`)","key":"filter_status_done","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Campaign Tags","description":"Lists campaign tags for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","tags"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Campaign Templates","description":"Lists campaign templates for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","templates",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"Page number for templates paging","key":"page_number","value":""}],"query":[{"description":"Search by template name","key":"search_name","value":""},{"description":"Filter by template static type (`1` or `0`)","key":"filter_type_static","value":""},{"description":"Filter by template custom type (`1` or `0`)","key":"filter_type_custom","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Create A New Campaign Template","description":"Creates a new campaign template.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","template"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"HTML Template\",\n    \"format\": \"html\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Campaign Template Exists","description":"Checks if given campaign template exists.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","template",":template_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The template identifier","key":"template_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get A Campaign Template","description":"Resolves campaign template information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","template",":template_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The template identifier","key":"template_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save A Campaign Template","description":"Saves a campaign template in website, and overwrite previous template information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","template",":template_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The template identifier","key":"template_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"HTML Template\",\n    \"format\": \"html\",\n    \"content\": \"<html><body><a href=\\\"{{url.unsubscribe}}\\\"></a></body></html>\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update A Campaign Template","description":"Updates a campaign template in website, and save only changed fields.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","template",":template_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The template identifier","key":"template_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"content\": \"<html><body><a href=\\\"{{url.unsubscribe}}\\\"></a></body></html>\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Remove A Campaign Template","description":"Removes a campaign template in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaigns","template",":template_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The template identifier","key":"template_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Campaign","description":"Manages a single website campaign.","item":[{"name":"Create A New Campaign","description":"Creates a new campaign.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"type\": \"one-shot\",\n    \"name\": \"Welcome!\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Campaign Exists","description":"Checks if given campaign exists.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get A Campaign","description":"Resolves campaign information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save A Campaign","description":"Saves a campaign in website, and overwrite previous campaign information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"type\": \"one-shot\",\n    \"format\": \"markdown\",\n    \"name\": \"Welcome!\",\n\n    \"sender\": {\n        \"user_id\": \"aa0b64dd-9fb4-4db9-80d6-5a49eb84087b\"\n    },\n\n    \"recipients\": {\n        \"type\": \"all\"\n    },\n\n    \"message\": \"*Hey there*, welcome on Crisp!\",\n\n    \"options\": {\n        \"deliver_to_chatbox\": true,\n        \"deliver_to_email\": true,\n        \"sender_name_website\": false,\n        \"sender_email_reply\": null,\n        \"tracking\": true\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update A Campaign","description":"Updates a campaign in website, and save only changed fields.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"message\": \"*Hey there*, welcome on Crisp folks!\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Remove A Campaign","description":"Removes a campaign in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Dispatch A Campaign","description":"Dispatches a ready campaign.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id","dispatch"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Resume A Campaign","description":"Resumes a paused and dispatched campaign.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id","resume"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Pause A Campaign","description":"Pauses a running and dispatched campaign.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id","pause"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Test A Campaign","description":"Tests a ready campaign.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id","test"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Campaign Recipients","description":"Lists campaigns recipients on a non-dispatched one-shot campaign for website. This can be used to preview the recipients the campaign will get delivered to.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id","recipients",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""},{"description":"Page number for recipients paging","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Campaign Statistics","description":"Lists campaigns statistics by type for website. This can be used to see who opened a sent campaign, clicked on a link or unsubscribed from the campaign.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","campaign",":campaign_id","statistics",":type",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The campaign identifier","key":"campaign_id","value":""},{"description":"The statistics type (either `clicked`, `opened`, `unsubscribed` or `all`)","key":"type","value":""},{"description":"Page number for statistics paging","key":"page_number","value":""}],"query":[{"description":"Page size for statistics paging (between `20` and `100`, defaults to `20`)","key":"per_page","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Analytics","description":"Manages website analytics.","item":[{"name":"Generate Analytics","description":"Generates analytics for given type and metric in website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","analytics","generate"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"metric\": \"visitor_visit\",\n    \"type\": \"total\",\n    \"split_by\": \"country\",\n\n    \"date\": {\n        \"split\": \"all\",\n        \"timezone\": \"Europe/Vienna\",\n        \"to\": \"2024-08-27\",\n        \"from\": \"2023-08-28\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Batch","description":"Proceeds batch operations on website.","item":[{"name":"Batch Resolve Items","description":"Resolves given (or all) items in website (conversations).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","batch","resolve"],"variable":[],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Batch Read Items","description":"Marks given (or all) items as read in website (conversations).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","batch","read"],"variable":[],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Batch Remove Items","description":"Removes given items in website (conversations or people).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","batch","remove"],"variable":[],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"sessions\": [\n        \"session_19e5240f-0a8d-461e-a661-a3123fc6eec9\",\n        \"session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881\"\n    ]\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Inbox","description":"Manages website inboxes.","item":[{"name":"List Website Inboxes","description":"Lists all inboxes for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","inboxes","list",":page_number"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The page number (paging in inbox list)","key":"page_number","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Batch Order Website Inboxes","description":"Changes order for multiple matching inboxes on website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","inboxes","batch","order"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"orders\": [\n        {\n            \"inbox_id\": \"d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31\",\n            \"order\": 1\n        },\n\n        {\n            \"inbox_id\": \"c058abfe-2881-4ff4-8f6a-6eb73e55385e\",\n            \"order\": 2\n        }\n    ]\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Create A New Website Inbox","description":"Creates a new inbox for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","inbox"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"name\": \"VIP\",\n    \"emoji\": \"⭐️\",\n    \"order\": 1,\n\n    \"operators\": [\n        \"86a4fed0-2f5f-4713-a8ff-41d7f3e4a8f8\",\n        \"e5cd7aa6-998f-4b8e-b7c5-3b546af87d15\"\n    ],\n\n    \"operator\": \"and\",\n\n    \"conditions\": [\n        {\n            \"model\": \"session\",\n            \"criterion\": \"segments\",\n            \"operator\": \"eq\",\n\n            \"query\": [\n                \"vip\"\n            ]\n        }\n    ]\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check If Website Inbox Exists","description":"Checks if inbox exists for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","inbox",":inbox_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The inbox identifier","key":"inbox_id","value":""}],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Website Inbox","description":"Resolves inbox for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","inbox",":inbox_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The inbox identifier","key":"inbox_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Website Inbox","description":"Saves inbox for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","inbox",":inbox_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The inbox identifier","key":"inbox_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"name\": \"VIP\",\n    \"emoji\": \"⭐️\",\n    \"order\": 1,\n\n    \"operators\": [\n        \"86a4fed0-2f5f-4713-a8ff-41d7f3e4a8f8\",\n        \"e5cd7aa6-998f-4b8e-b7c5-3b546af87d15\"\n    ],\n\n    \"operator\": \"and\",\n\n    \"conditions\": [\n        {\n            \"model\": \"session\",\n            \"criterion\": \"segments\",\n            \"operator\": \"eq\",\n\n            \"query\": [\n                \"vip\"\n            ]\n        }\n    ]\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Delete Website Inbox","description":"Deletes inbox for website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","inbox",":inbox_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The inbox identifier","key":"inbox_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Settings","description":"Manages the website settings.","item":[{"name":"Get Website Settings","description":"Resolves the current settings for a website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Website Settings","description":"Updates the current settings for a website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"name\": \"Crisp\",\n    \"domain\": \"crisp.chat\",\n    \"logo\": \"https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png\",\n\n    \"audit\": {\n        \"log\": true\n    },\n\n    \"contact\": {\n        \"email\": \"contact@crisp.chat\",\n        \"phone\": \"+33757905447\"\n    },\n\n    \"inbox\": {\n        \"lock_removal\": false,\n        \"force_operator_token\": false,\n        \"locale\": \"\"\n    },\n\n    \"emails\": {\n        \"rating\": true,\n        \"transcript\": true,\n        \"enrich\": true,\n        \"junk_filter\": true\n    },\n\n    \"chatbox\": {\n        \"tile\": \"default\",\n        \"conversations\": true,\n        \"wait_game\": false,\n        \"website_logo\": false,\n        \"last_operator_face\": false,\n        \"ongoing_operator_face\": true,\n        \"activity_metrics\": true,\n        \"operator_privacy\": false,\n        \"visitor_privacy\": false,\n        \"availability_tooltip\": true,\n        \"hide_vacation\": false,\n        \"hide_on_away\": false,\n        \"hide_on_mobile\": false,\n        \"position_reverse\": false,\n        \"email_visitors\": false,\n        \"phone_visitors\": false,\n        \"force_identify\": false,\n        \"ignore_privacy\": false,\n        \"visitor_compose\": false,\n        \"file_transfer\": true,\n        \"audio_record\": true,\n        \"mode_initial\": \"chat\",\n        \"home\": true,\n        \"overlay_search\": true,\n        \"overlay_mode\": false,\n        \"helpdesk_link\": true,\n        \"helpdesk_only\": false,\n        \"helpdesk_navigate\": \"deep\",\n        \"status_health_dead\": true,\n        \"check_domain\": false,\n        \"color_theme\": \"blue\",\n        \"color_mode\": \"auto\",\n        \"layout_theme\": \"default\",\n        \"text_theme\": \"default\",\n        \"welcome_message\": \"default\",\n        \"locale\": \"en\",\n        \"allowed_pages\": [],\n\n        \"blocked_pages\": [\n            \"status/*/\",\n            \"docs.crisp.chat/*\",\n            \"crisp.chat/terms/\",\n            \"https://crisp.chat/privacy/\"\n        ],\n\n        \"blocked_countries\": [\n            \"IT\"\n        ],\n\n        \"blocked_locales\": [\n            \"fa\",\n            \"he\"\n        ],\n\n        \"blocked_ips\": [\n            \"8.8.8.8\",\n            \"2001:0db8:85a3:0000:0000:8a2e:0370:7334\",\n            \"192.168.1.1/24\"\n        ]\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Verify","description":"Manages a single website verify status.","item":[{"name":"Get Verify Settings","description":"Resolves verify settings.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","verify","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Verify Settings","description":"Updates verify settings.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","verify","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"enabled\": true\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Verify Key","description":"Resolves verify key. This key is to be used in the user backend to sign user data (eg. email) with an HMAC-SHA256 function.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","verify","key"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Roll Verify Key","description":"Rolls verify key. This requests a new keypair to be generated. Previous key will be invalidated.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","verify","key"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Connect","description":"Manages website connect information.","item":[{"name":"Get Website Connect Endpoints","description":"Resolves the website endpoints information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["website",":website_id","connect","endpoints"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"website"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]}]},{"name":"Plugin","description":"Manages Crisp plugins.","item":[{"name":"Subscription","description":"Manages website subscription to plugins.","item":[{"name":"List All Active Subscriptions","description":"Lists all active plugin subscriptions on all websites, linked to payment methods owned by the user, or from websites the user is member of.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription"],"variable":[],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Subscriptions For A Website","description":"Lists plugin subscriptions for given website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Subscription Details","description":"Resolves details on a given subscription.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Subscribe Website To Plugin","description":"Subscribes a given website to a given plugin.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"plugin_id\": \"98454664-9f7d-4d95-a9ce-f37356f5e65a\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Unsubscribe Plugin From Website","description":"Unsubscribes a given plugin from a given website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Subscription Settings","description":"Resolves plugin subscription settings. Used to read plugin configuration on a given website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Save Subscription Settings","description":"Saves plugin subscription settings (overwrites existing settings). Used to configure a given plugin on a given website.\n\nSubmit a raw JSON object containing the bare settings object. The object format is plugin-specific, and is enforced by the configuration schema.\n\nThe settings save acknowledgement is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `plugin:settings:saved`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{"raw":"{\n    \"color\": {\n        \"chatbox\": {\n            \"25\": \"#bbbbbb\"\n        }\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Update Subscription Settings","description":"Updates plugin subscription settings (merges with existing settings). Used to configure a given plugin on a given website.\n\nSubmit a raw JSON object containing the bare settings object. The object format is plugin-specific, and is enforced by the configuration schema.\n\nThe settings save acknowledgement is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `plugin:settings:saved`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","settings"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{"raw":"{\n    \"color\": {\n        \"chatbox\": {\n            \"25\": \"#bbbbbb\"\n        }\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Plugin Usage Bills","description":"Acquires all non-settled (ie. open) usage bills for a subscribed plugin.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","bill","usage"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Report Plugin Usage To Bill","description":"Reports a billable usage for a website using a subscribed plugin. This billable usage will be invoiced to the user whenever they get charged for other Crisp subscriptions.\n\n!! Note that once a bill is settled (ie. paid), reporting a new billable usage for a website will open up a new bill. The price per unit will be frozen on this new bill, meaning that you cannot change the price of an existing non-settled bill, only increment its units. If you need to change the price per unit, you will need to wait until the bill gets settled, and then open up a new bill with the new price.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","bill","usage"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{"raw":"{\n    \"name\": \"Paid messages sent\",\n    \"units\": 250,\n    \"price\": 0.10\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Plugin Attest Provenance","description":"Attests for plugin user provenance, using the plugin signature secret. This provenance payload can be provided to the plugin eg. Web configuration UI, so that the plugin can independently authenticate the Crisp user and verify eg. their role in the website. This lets plugins implement some weak ACLs.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","attest","provenance"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Forward Plugin Payload To Channel","description":"Forwards generic payload given generic namespace to plugin channel.\n\nThe generic payload is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `plugin:channel`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","channel"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{"raw":"{\n    \"namespace\": \"bot:step\",\n\n    \"payload\": {\n        \"step\": 1\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Dispatch Plugin Event","description":"Dispatches a generic data event for plugin, for use with Web Hooks.\n\nThe generic data is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `plugin:event`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugins","subscription",":website_id",":plugin_id","event"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"},{"description":"The plugin identifier","key":"plugin_id","value":""}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{"raw":"{\n    \"name\": \"bot-is-running\",\n\n    \"data\": {\n        \"bot\": \"Sales\",\n        \"email\": \"valerian@crisp.chat\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Connect Account","description":"Manages connected plugin account.","item":[{"name":"⭐ Get Connect Account","description":"Resolves the current plugin account information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugin","connect","account"],"variable":[],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Connect Session","description":"Manages connected plugin session.","item":[{"name":"⭐ Check Connect Session Validity","description":"Checks whether the connected plugin session is valid or not.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugin","connect","session"],"variable":[],"query":[]},"method":"HEAD","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Connect Websites","description":"Manages plugin connect websites.","item":[{"name":"⭐ List All Connect Websites","description":"Lists all websites linked to connected plugin.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugin","connect","websites","all",":page_number"],"variable":[{"description":"The page number (paging if many websites)","key":"page_number","value":""}],"query":[{"description":"Restrict to configured plugins only (`1` or `0`)","key":"filter_configured","value":""},{"description":"Whether to include the plan subscription in the listed websites (`1` or `0`, defaults to `0`)","key":"include_plan","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"List Connect Websites Since","description":"Lists the websites linked or unlinked or updated for connected plugin, since given date. This is basically a differential that allows you to either add, remove or update websites in use for the plugin.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugin","connect","websites","since"],"variable":[],"query":[{"description":"Date since when to proceed a differential response (ISO 8601)","key":"date_since","value":""},{"description":"Restrict to configured plugins only (`1` or `0`)","key":"filter_configured","value":""},{"description":"Whether to include the plan subscription in the listed websites (`1` or `0`, defaults to `0`)","key":"include_plan","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]},{"name":"Connect Endpoints","description":"Manages connected plugin endpoints.","item":[{"name":"⭐ Get Connect Endpoints","description":"Resolves the current plugin endpoints information.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plugin","connect","endpoints"],"variable":[],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"plugin"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]}]},{"name":"Plan","description":"Manages Crisp plans.","item":[{"name":"Subscription","description":"Manages website subscription to a plan.","item":[{"name":"List All Active Plan Subscriptions","description":"Lists all active plan subscriptions on all websites, linked to payment methods owned by the user, or from websites the user is member of.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plans","subscription"],"variable":[],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Get Plan Subscription For A Website","description":"Resolves plan subscription for given website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plans","subscription",":website_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Subscribe Website To Plan","description":"Subscribes a given website to a given plan.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plans","subscription",":website_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"plan_id\": \"2ef6667e-e74f-4fa4-9dca-bf52db5cc3e4\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Unsubscribe Plan From Website","description":"Unsubscribes a given plan from a given website.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plans","subscription",":website_id"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Change Bill Period For Website Plan Subscription","description":"Changes how often the website subscription is paid for. The payment method will be debited at selected interval for the due amount.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plans","subscription",":website_id","bill","period"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"period\": \"yearly\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Check Coupon Availability For Website Plan Subscription","description":"Resolves a coupon for a website subscription. This helps check for coupon availability and returns information on the coupon.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plans","subscription",":website_id","coupon"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[{"description":"Coupon code","key":"code","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}},{"name":"Redeem Coupon For Website Plan Subscription","description":"Redeems a coupon for a website subscription. This applies coupon rebates and upgrades immediately to the subscription.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["plans","subscription",":website_id","coupon"],"variable":[{"description":"The website identifier","key":"website_id","value":"{{website_id}}"}],"query":[]},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{"raw":"{\n    \"code\": \"CRISP+AWESOME\"\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]}]},{"name":"Bucket","description":"Manages Crisp buckets, that are used to store uploaded files.","item":[{"name":"URL","description":"Manages bucket URL operations. Used to generate file upload URLs.","item":[{"name":"Generate Bucket URL","description":"Generates a bucket URL. The URL is signed, and lets you upload a file directly to it.\n\nThe signed bucket URL response is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using either the event namespace `bucket:url:avatar:generated`, `bucket:url:upload:generated`, `bucket:url:website:generated`, `bucket:url:helpdesk:generated`, `bucket:url:status:generated`, `bucket:url:campaign:generated` or `bucket:url:processing:generated` (depending on the request `namespace` parameter).","request":{"url":{"host":"https://api.crisp.chat/v1","path":["bucket","url","generate"],"variable":[],"query":[]},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"{{crisp_tier}}"}],"body":{"raw":"{\n    \"namespace\": \"upload\",\n    \"id\": \"a1b2\",\n\n    \"file\": {\n        \"name\": \"Cat.jpg\",\n        \"type\": \"image/jpeg\"\n    },\n\n    \"resource\": {\n        \"type\": \"session\",\n        \"id\": \"session_a752b46a-d359-4605-8d69-7e922cb544a3\"\n    }\n}\n","mode":"raw","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]}]},{"name":"Media","description":"Manages Crisp medias.","item":[{"name":"Animation","description":"Manages media animation operations. Used to look for animations.","item":[{"name":"List Animation Medias","description":"Lists animation medias, given the search query and paging.\n\nThe animation media list is sent back asynchronously on the [RTM Events channel](/references/rtm-api/v1/), using the event namespace `media:animation:listed`.","request":{"url":{"host":"https://api.crisp.chat/v1","path":["media","animation","list",":page_number"],"variable":[{"description":"Page number for animation paging","key":"page_number","value":""}],"query":[{"description":"Page size for animation paging (between `10` and `50`, defaults to `10`)","key":"per_page","value":""},{"description":"Search query (if not set, trending animations are listed)","key":"search_query","value":""},{"description":"List ID (used to stamp response payload)","key":"list_id","value":""}]},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Crisp-Tier","value":"user"}],"body":{},"auth":{"type":"basic","basic":[{"key":"username","value":"{{crisp_token_identifier}}","type":"string"},{"key":"password","value":"{{crisp_token_key}}","type":"string"}]}}}]}]}]}