{"openapi":"3.0.0","info":{"description":"SendPulse multi-channel marketing automation API: bulk email campaigns, mailing lists, templates and senders; transactional SMTP; SMS; CRM (deals, contacts, pipelines); and chatbot messaging across WhatsApp, Telegram, Facebook Messenger, Instagram, Viber, TikTok and live chat.","version":"v1"},"servers":[{"description":"SendPulse multi-channel marketing automation API: bulk email campaigns, mailing lists, templates and senders; transactional SMTP; SMS; CRM (deals, contacts, pipelines); and chatbot messaging across WhatsApp, Telegram, Facebook Messenger, Instagram, Viber, TikTok and live chat.","url":"https://api.apirails.com/sendpulse"}],"paths":{"/addressbooks":{"post":{"tags":["Marketing Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks"},"summary":"Create a mailing list","description":"Create a new mailing list (address book).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bookName":{"type":"string","description":"Mailing list name","required":true}}},"example":{"bookName":""}}}}},"get":{"tags":["Bulk Email Mailing Lists"],"parameters":[{"name":"limit","in":"query","description":"Number of records","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"Offset (first record to be displayed)","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks"},"summary":"Get a list of mailing lists","description":"Retrieve all mailing lists.","security":[{"bearerAuth":[]}]}},"/addressbooks/{id}":{"get":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}"},"summary":"Get mailing list information","description":"Detailed information regarding a specific mailing list.","security":[{"bearerAuth":[]}]},"put":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}"},"summary":"Edit a mailing list","description":"Rename an existing mailing list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true}}},"example":{"name":"My mailing list"}}}}},"delete":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}"},"summary":"Delete a mailing list","description":"Permanently remove a mailing list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/addressbooks/{id}/variables":{"get":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/variables"},"summary":"Get a list of variables for a mailing list","description":"Get variables available on a mailing list.","security":[{"bearerAuth":[]}]}},"/addressbooks/{id}/emails":{"get":{"tags":["Bulk Email Mailing Lists"],"parameters":[{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"active","in":"query","description":"active","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"not_active","in":"query","description":"not_active","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/emails"},"summary":"Get a list of emails from a mailing list","description":"Retrieve contacts from a mailing list.","security":[{"bearerAuth":[]}]},"post":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/emails"},"summary":"Add emails to a mailing list","description":"Add contacts using single or double opt-in.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/emails"},"summary":"Delete emails from a mailing list","description":"Remove specific email addresses.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/addressbooks/{id}/emails/total":{"get":{"tags":["Bulk Email Mailing Lists"],"parameters":[{"name":"active","in":"query","description":"active","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/emails/total"},"summary":"Get the total number of contacts","description":"Returns the total count of emails in a list.","security":[{"bearerAuth":[]}]}},"/addressbooks/{id}/emails/unsubscribe":{"post":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/emails/unsubscribe"},"summary":"Unsubscribe contacts from a mailing list","description":"Moves specified email addresses to the unsubscribed state within a given list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/addressbooks/{id}/emails/variable":{"post":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/emails/variable"},"summary":"Update variables for a contact in a mailing list","description":"Updates custom variable values for a specific email address within a mailing list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"(format: email)","required":true},"variables":{"type":"array","description":"Variables","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"string","description":"Value"}}}}}},"example":{"email":"user@example.com","variables":[]}}}}}},"/addressbooks/{id}/variables/{variableName}/{searchValue}":{"get":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/variables/{variableName}/{searchValue}"},"summary":"Get contacts by variable","description":"Find all contacts matching a specific variable value.","security":[{"bearerAuth":[]}]}},"/addressbooks/{id}/phone":{"put":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/phone"},"summary":"Change a phone number for a contact","description":"Update the 'Phone' variable for a subscriber.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"(format: email)","required":true},"phone":{"type":"string","description":"Phone","required":true}}},"example":{"email":"","phone":""}}}}}},"/addressbooks/{id}/cost":{"get":{"tags":["Bulk Email Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/cost"},"summary":"Get campaign cost","description":"Calculate the cost of sending to this list.","security":[{"bearerAuth":[]}]}},"/campaigns":{"post":{"tags":["Bulk Email Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns"},"summary":"Create a campaign","description":"Create and send or schedule a campaign. One of 'body' or 'template_id' is required. One of 'list_id' or 'segment_id' is required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sender_name":{"type":"string","description":"Sender's name","required":true},"sender_email":{"type":"string","description":"Sender's email address","required":true},"subject":{"type":"string","description":"Email subject","required":true},"body":{"type":"string","description":"HTML code of the template, encoded in Base64. Required if template_id is not provided."},"template_id":{"type":"string","description":"Template ID uploaded or created in the service. Required if body is not provided."},"list_id":{"type":"string","description":"Mailing list ID or array of mailing list IDs. Required if segment_id is not provided. Max 10 IDs."},"segment_id":{"type":"number","description":"Segment ID created in your account."},"is_test":{"type":"boolean","description":"Send a test email to the sender's address specified in sender_email.","enum":[true,false]},"send_date":{"type":"string","description":"Scheduled date and time (Y-m-d H:i:s). Must not be in the past."},"name":{"type":"string","description":"Campaign name."},"use_dynamic_list":{"type":"boolean","description":"Send to contacts added after campaign creation but before sending.","enum":[true,false]},"attachments":{"type":"object","description":"Attached files (max 5). Key is filename, value is content.","properties":{"value":{"type":"string","description":"Free-form object."}}},"attachments_binary":{"type":"object","description":"Attached files (max 5). Key is filename, value is Base64 content.","properties":{"value":{"type":"string","description":"Free-form object."}}},"type":{"type":"string","description":"Create campaign as a draft.","enum":["draft"]},"body_amp":{"type":"string","description":"AMP version of the email, encoded in base64."},"stats":{"type":"object","description":"Enable collection of statistics on opens and clicks.","properties":{"clicks":{"type":"boolean","description":"Track link clicks.","enum":[true,false]},"opens":{"type":"boolean","description":"Track email opens.","enum":[true,false]},"utm_campaign":{"type":"string","description":"Custom UTM tags for Google Analytics."}}}}},"example":{"sender_name":"my_sender_name","sender_email":"my_sender@test.com","subject":"hello customer","body":"SmFja2llIENoYW4=","template_id":"775667","list_id":756589,"segment_id":12345,"is_test":"","send_date":"2016-02-02 23:34:23","name":"my_api_campaign","use_dynamic_list":true,"attachments":{"text.txt":"my content file"},"attachments_binary":{"text.txt":"bXkgY29udGVudCBmaWxlIGluIGJhc2U2NA=="},"type":"draft","body_amp":"bXkgYW1wIGJvZHk=","stats":{"opens":true,"clicks":false,"utm_campaign":"MY_UTM"}}}}}},"get":{"tags":["Bulk Email Campaigns"],"parameters":[{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"status","in":"query","description":"status","required":false,"schema":{"type":"array","example":""}},{"name":"planed","in":"query","description":"planed","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns"},"summary":"Get a list of campaigns","description":"Retrieve history and status of all campaigns.","security":[{"bearerAuth":[]}]}},"/campaigns/{id}":{"get":{"tags":["Bulk Email Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns/{id}"},"summary":"Get campaign information","description":"Get detailed stats for a specific campaign.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Bulk Email Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns/{id}"},"summary":"Edit scheduled campaign","description":"Update a pending campaign.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"subject":{"type":"string","description":"Subject"}}},"example":{"name":"","subject":""}}}}},"delete":{"tags":["Bulk Email Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns/{id}"},"summary":"Cancel a campaign","description":"Stops a pending or processing campaign.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/campaigns/{id}/countries":{"get":{"tags":["Bulk Email Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns/{id}/countries"},"summary":"Get country statistics","description":"Geographic breakdown of email opens.","security":[{"bearerAuth":[]}]}},"/campaigns/{id}/referrals":{"get":{"tags":["Bulk Email Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns/{id}/referrals"},"summary":"Get referrals statistics","description":"Breakdown of link clicks.","security":[{"bearerAuth":[]}]}},"/addressbooks/{id}/campaigns":{"get":{"tags":["Bulk Email Campaigns"],"parameters":[{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/campaigns"},"summary":"Get campaigns by mailing list","description":"Lists all campaigns targeting a specific list.","security":[{"bearerAuth":[]}]}},"/template":{"post":{"tags":["Bulk Email Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/template"},"summary":"Create a template","description":"Uploads HTML to create a reusable template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"body":{"type":"string","description":"HTML encoded in base64","required":true},"lang":{"type":"string","description":"Lang","enum":["en","ru","ua","tr","es","pt"]}}},"example":{"name":"My Template","body":"PGlucHV0IHR5cGU9ImVtYWlsIiBuYW1lPSJlbWFpbCIgcmVxdWlyZWQKb25pbnZhbGlkPSJ0aGlzLnNldEN1c3RvbVZhbGlkaXR5KCfQn9C","lang":"en"}}}}}},"/template/edit/{id}":{"post":{"tags":["Bulk Email Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/template/edit/{id}"},"summary":"Edit a template","description":"Updates existing template HTML.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"HTML version of the email, encoded in base64","required":true},"lang":{"type":"string","description":"Lang","enum":["en","ru","ua","tr","es","pt"]}}},"example":{"body":"PCFET0NUWVBFIGh0bWw+CjxodG1sPgo8a...","lang":""}}}}}},"/template/{template_id}":{"get":{"tags":["Bulk Email Templates"],"parameters":[{"name":"owner","in":"query","description":"owner","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["me","sendpulse"]}}},{"name":"lang","in":"query","description":"lang","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/template/{template_id}"},"summary":"Get information about a template","description":"Retrieves metadata for a template.","security":[{"bearerAuth":[]}]}},"/template/slug/{name_slug}":{"get":{"tags":["Bulk Email Templates"],"parameters":[{"name":"owner","in":"query","description":"owner","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["me","sendpulse"]}}},{"name":"lang","in":"query","description":"lang","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/template/slug/{name_slug}"},"summary":"Get a template by name slug","description":"Retrieves template details using its unique name slug identifier.","security":[{"bearerAuth":[]}]}},"/templates":{"get":{"tags":["Bulk Email Templates"],"parameters":[{"name":"owner","in":"query","description":"owner","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["me","sendpulse"]}}},{"name":"only_active","in":"query","description":"only_active","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"limit","in":"query","description":"Number of records","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"Offset (first record to be displayed)","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/templates"},"summary":"Get a list of templates","description":"Retrieves system or user templates.","security":[{"bearerAuth":[]}]}},"/senders":{"get":{"tags":["Bulk Email Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/senders"},"summary":"Get a list of all senders","description":"Inspects authorized 'From' addresses.","security":[{"bearerAuth":[]}]},"post":{"tags":["Bulk Email Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/senders"},"summary":"Add a sender","description":"Registers a new sender email address.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email","required":true},"name":{"type":"string","description":"Name","required":true}}},"example":{"email":"","name":""}}}}},"delete":{"tags":["Bulk Email Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/senders"},"summary":"Delete a sender","description":"Removes an authorized sender.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email","required":true}}},"example":{"email":""}}}}}},"/senders/{email}/code":{"get":{"tags":["Bulk Email Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/senders/{email}/code"},"summary":"Request activation code","description":"Triggers an activation email.","security":[{"bearerAuth":[]}]},"post":{"tags":["Bulk Email Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/senders/{email}/code"},"summary":"Activate a sender","description":"Verifies the sender using the code.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"code":{"type":"string","description":"Code","required":true}}},"example":{"code":""}}}}}},"/emails/{email}":{"get":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/emails/{email}"},"summary":"Get general info for an email","description":"Finds which address books this email belongs to.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/emails/{email}"},"summary":"Delete email globally","description":"Wipes a subscriber from all lists.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/emails/{email}/details":{"get":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/emails/{email}/details"},"summary":"Get detailed info for an email","description":"Retrieves list names, addition dates, and sources.","security":[{"bearerAuth":[]}]}},"/emails":{"post":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/emails"},"summary":"Get info for multiple emails","description":"Batch check for subscriber statuses.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/emails/{email}/campaigns":{"get":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/emails/{email}/campaigns"},"summary":"Get email stats","description":"Analytics for a specific subscriber.","security":[{"bearerAuth":[]}]}},"/campaigns/{id}/email/{email}":{"get":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/campaigns/{id}/email/{email}"},"summary":"Get info for an email from a campaign","description":"Checks exactly what happened to a specific email in a specific campaign.","security":[{"bearerAuth":[]}]}},"/addressbooks/{id}/emails/{email}":{"get":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/emails/{email}"},"summary":"Get info for an email from a mailing list","description":"Retrieves exact variables and status in one list.","security":[{"bearerAuth":[]}]}},"/emails/campaigns":{"post":{"tags":["Bulk Email Email Address"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/emails/campaigns"},"summary":"Get stats for multiple emails","description":"Batch fetch engagement stats.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/tags":{"get":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags"},"summary":"Get a list of tags","description":"Retrieve all created tags for the account.","security":[{"bearerAuth":[]}]},"post":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags"},"summary":"Create a tag","description":"Create a new tag with the specified name and color.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"color":{"type":"string","description":"Color","required":true}}},"example":{"name":"test3","color":"#f0f4f6"}}}}}},"/tags/{id}":{"put":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags/{id}"},"summary":"Update a tag","description":"Update an existing tag by its ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"color":{"type":"string","description":"Color","required":true}}},"example":{"name":"newName","color":"#f0f4f6"}}}}},"delete":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags/{id}"},"summary":"Delete a tag","description":"Remove a specific tag by its ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/tags/pin/email":{"post":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags/pin/email"},"summary":"Assign tag to email","description":"Assign one or more tags to a specific email address.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email","required":true},"tags":{"type":"array","description":"Tags","required":true,"items":{"type":"number"}}}},"example":{"email":"test@test.com","tags":[11111,22222]}}}}}},"/tags/pin/phone":{"post":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags/pin/phone"},"summary":"Assign tag to phone","description":"Assign one or more tags to a specific phone number.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone":{"type":"string","description":"Phone","required":true},"tags":{"type":"array","description":"Tags","required":true,"items":{"type":"number"}}}},"example":{"phone":"123456789","tags":[11111,22222]}}}}}},"/tags/unpin/email":{"post":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags/unpin/email"},"summary":"Unassign tag from email","description":"Remove one or more tags from a specific email address.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email","required":true},"tags":{"type":"array","description":"Tags","required":true,"items":{"type":"number"}}}},"example":{"email":"test@test.com","tags":[11111,22222]}}}}}},"/tags/unpin/phone":{"post":{"tags":["Bulk Email Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/tags/unpin/phone"},"summary":"Unassign tag from phone","description":"Remove one or more tags from a specific phone number.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone":{"type":"string","description":"Phone","required":true},"tags":{"type":"array","description":"Tags","required":true,"items":{"type":"number"}}}},"example":{"phone":"123456789","tags":[11111,22222]}}}}}},"/blacklist":{"get":{"tags":["Bulk Email Blacklist"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/blacklist"},"summary":"Get blacklist","description":"Retrieve the list of blacklisted email addresses.","security":[{"bearerAuth":[]}]},"post":{"tags":["Bulk Email Blacklist"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/blacklist"},"summary":"Add to blacklist","description":"Add one or more email addresses to the blacklist.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"string","description":"Base64 encoded comma-separated emails.","required":true},"comment":{"type":"string","description":"Comment"}}},"example":{"emails":"dXNlcjFAbWFpbHNlcnZlci5jb20sdXNlcjJAbWFpbHNlcnZlci5jb20sdXNlcjNAbWFpbHNlcnZlci5jb20=","comment":"comment"}}}}},"delete":{"tags":["Bulk Email Blacklist"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/blacklist"},"summary":"Remove from blacklist","description":"Remove email addresses from the account's blacklist.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"string","description":"Base64 encoded comma-separated emails.","required":true}}},"example":{"emails":"dXNlcjFAbWFpbHNlcnZlci5jb20sdXNlcjJAbWFpbHNlcnZlci5jb20sdXNlcjNAbWFpbHNlcnZlci5jb20="}}}}}},"/balance":{"get":{"tags":["Bulk Email Balance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/balance"},"summary":"Get balance","description":"Get overall account balance information.","security":[{"bearerAuth":[]}]}},"/balance/{currency}":{"get":{"tags":["Bulk Email Balance"],"parameters":[{"name":"currency","in":"path","description":"currency","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/balance/{currency}"},"summary":"Get balance by currency","description":"Get account balance for a specific currency.","security":[{"bearerAuth":[]}]}},"/user/balance/detail":{"get":{"tags":["Bulk Email Balance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/user/balance/detail"},"summary":"Get detailed balance","description":"Get deep dive into balance, tariffs, and limits across all services.","security":[{"bearerAuth":[]}]}},"/v2/email-service/webhook":{"get":{"tags":["Bulk Email Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/v2/email-service/webhook"},"summary":"Get webhooks","description":"Retrieve the list of configured email service webhooks.","security":[{"bearerAuth":[]}]},"post":{"tags":["Bulk Email Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/v2/email-service/webhook"},"summary":"Create a webhook","description":"Configure a new webhook to track email events.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"Url","required":true},"actions":{"type":"array","description":"Actions","required":true,"items":{"type":"string"}}}},"example":{"url":"https://site.com/callback","actions":["delivered"]}}}}}},"/v2/email-service/webhook/{id}":{"get":{"tags":["Bulk Email Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/v2/email-service/webhook/{id}"},"summary":"Get webhook by ID","description":"Retrieve details for a specific webhook.","security":[{"bearerAuth":[]}]},"put":{"tags":["Bulk Email Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/v2/email-service/webhook/{id}"},"summary":"Update a webhook","description":"Update the URL for an existing webhook.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"Url","required":true}}},"example":{"url":"https://site.com/callback"}}}}},"delete":{"tags":["Bulk Email Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/bulk-email.yaml","api_endpoint":"https://api.sendpulse.com/v2/email-service/webhook/{id}"},"summary":"Delete a webhook","description":"Remove a webhook configuration.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/chatbots/dialogs":{"get":{"tags":["Chatbots Dialogs"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"search_after","in":"query","description":"The id of last_inbox_message.id element after which elements will be searched","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/chatbots.yaml","api_endpoint":"https://api.sendpulse.com/chatbots/dialogs"},"summary":"Get dialogs list info","description":"Returns information about your dialogs from all channels","security":[{"bearerAuth":[]}]}},"/chatbots/account":{"get":{"tags":["Chatbots Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/chatbots.yaml","api_endpoint":"https://api.sendpulse.com/chatbots/account"},"summary":"Get account info","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/chatbots/bots":{"get":{"tags":["Chatbots Bots"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/chatbots.yaml","api_endpoint":"https://api.sendpulse.com/chatbots/bots"},"summary":"Get a list of connected bots","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/crm/v1/users":{"get":{"tags":["CRM Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/users"},"summary":"Get a list of team members","description":"Get a list of team members","security":[{"bearerAuth":[]}]}},"/crm/v1/pipelines":{"post":{"tags":["CRM Pipelines"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines"},"summary":"Create new pipeline","description":"Create new pipeline with specified settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Pipeline name"},"settings":{"type":"array","description":"Settings","items":{"type":"object","properties":{"name":{"type":"string","description":"Setting name"},"value":{"type":"string","description":"Setting value"}}}}}},"example":{"name":"","settings":[]}}}}},"get":{"tags":["CRM Pipelines"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines"},"summary":"Get a list of pipelines","description":"Returns a list of pipelines with information about each: pipeline ID, pipeline creator, created statuses, and pipeline settings","security":[{"bearerAuth":[]}]}},"/crm/v1/pipelines/{pipelineId}":{"get":{"tags":["CRM Pipelines"],"parameters":[{"name":"pipelineId","in":"path","description":"ID of a pipeline you need to get information about. It can be obtained with the \"Get a list of pipelines\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}"},"summary":"Get information about a pipeline by ID","description":"Returns information about the specified pipeline: pipeline ID, pipeline creator, created statuses, and pipeline settings","security":[{"bearerAuth":[]}]},"put":{"tags":["CRM Pipelines"],"parameters":[{"name":"pipelineId","in":"path","description":"Pipeline ID to be updated.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}"},"summary":"Update information about a pipeline by its ID","description":"Updates information in the specified pipeline","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Pipeline name"},"order":{"type":"number","description":"Field display order"},"settings":{"type":"array","description":"Settings","items":{"type":"object","properties":{"name":{"type":"string","description":"Setting name"},"value":{"type":"string","description":"Setting value"}}}}}},"example":{"name":"","order":"","settings":[]}}}}}},"/crm/v1/pipelines/{pipelineId}/steps":{"post":{"tags":["CRM Pipeline Steps"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/steps"},"summary":"Create a new pipeline step","description":"Create a new pipeline step","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"order":{"type":"number","description":"Order"},"color":{"type":"string","description":"Step color","enum":["#000000","black"]},"addEndHours":{"type":"number","description":"Add number of hours or null","enum":[null,1,2,3,4,5,6,8,9,10]},"notifyIn":{"type":"string","description":"Time notification","enum":["0","15min","30min","1h","2h","3h","6h","12h","24h","2d","3d","4d","5d","6d","7d"]}}},"example":{"name":"","order":"","color":"","addEndHours":"","notifyIn":""}}}}},"get":{"tags":["CRM Pipeline Steps"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/steps"},"summary":"Get pipeline steps","description":"Get pipeline steps","security":[{"bearerAuth":[]}]}},"/crm/v1/pipelines/{pipelineId}/steps/{stepId}":{"put":{"tags":["CRM Pipeline Steps"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}},{"name":"stepId","in":"path","description":"stepId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/steps/{stepId}"},"summary":"Update a pipeline step","description":"Update a pipeline step","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"order":{"type":"number","description":"Order"},"color":{"type":"string","description":"Step color","enum":["#000000","black"]},"addEndHours":{"type":"number","description":"Add number of hours or null","enum":[null,1,2,3,4,5,6,8,9,10]},"notifyIn":{"type":"string","description":"Time notification","enum":["0","15min","30min","1h","2h","3h","6h","12h","24h","2d","3d","4d","5d","6d","7d"]}}},"example":{"name":"","order":"","color":"","addEndHours":"","notifyIn":""}}}}},"delete":{"tags":["CRM Pipeline Steps"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}},{"name":"stepId","in":"path","description":"stepId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/steps/{stepId}"},"summary":"Delete a pipeline step","description":"Delete a pipeline step","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals/get-list":{"post":{"tags":["CRM Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/get-list"},"summary":"Get deals list","description":"\"status\" field values:\n0 = inactive\n1 = active\n2 = fail\n3 = success","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals":{"post":{"tags":["CRM Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals"},"summary":"Create a new deal","description":"Creates a new deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pipelineId":{"type":"number","description":"Pipeline ID where you need to create a deal. It can be obtained with the \"Get a list of pipelines\" method","required":true},"stepId":{"type":"number","description":"Pipeline step ID in which you want to create a deal. It can be obtained with the methods \"Get a list of pipelines\" and \"Get information about a pipeline by ID\"","required":true},"responsibleId":{"type":"number","description":"Team member ID to assign to a deal. It can be obtained with the \"Get a list of team members\" method"},"name":{"type":"string","description":"Deal name. The maximum number of characters is 255"},"price":{"type":"number","description":"Deal amount"},"currency":{"type":"string","description":"Deal currency. Accepts values in the form of UAH, USD, EUR"},"sourceId":{"type":"number","description":"Custom source ID of the deal from an external source"},"contact":{"type":"array","description":"Deal contact","items":{"type":"number"}},"attributes":{"type":"array","description":"Attributes","items":{"type":"string"}},"attachments":{"type":"array","description":"First, the file must be uploaded to the file manager, and then the file can be attached.","items":{"type":"string"}}}},"example":{"pipelineId":"","stepId":"","responsibleId":"","name":"","price":"","currency":"","sourceId":"","contact":[],"attributes":[],"attachments":["/personal/deal/sendPulse_crm_deals.csv"]}}}}}},"/crm/v1/deals/{dealId}":{"get":{"tags":["CRM Deals"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID for which you need to get information. You can get it in the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}"},"summary":"Get information about the deal by ID","description":"Returns information about the specified deal: deal ID, ID of a pipeline where the deal was created, at what stage the deal is now, team member responsible for the deal, deal amount, deal creation source, list of notes and fields","security":[{"bearerAuth":[]}]},"put":{"tags":["CRM Deals"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID to be updated. You can get it in the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}"},"summary":"Update information about a deal by its ID","description":"Updates information in the specified deal. Provided property values will be overwritten","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pipelineId":{"type":"number","description":"Pipeline ID in which the deal is located. It can be obtained with the method \"Get a list of pipelines\"","required":true},"status":{"type":"number","description":"Status","required":true},"stepId":{"type":"number","description":"ID of a pipeline step where you need to place a deal. It can be obtained from the methods \"Get a list of pipelines\" and \"Get information about a pipeline by its ID\"","required":true},"responsibleId":{"type":"number","description":"Team member ID to assign to a deal. It can be obtained with the \"Get a list of team members\" method"},"name":{"type":"string","description":"Deal name","required":true},"price":{"type":"number","description":"Deal amount","required":true},"currency":{"type":"string","description":"Deal currency. Accepts values in the form of UAH, USD, EUR"},"sourceId":{"type":"number","description":"Custom source ID of the deal from an external source"},"order":{"type":"number","description":"Field display order. If empty, the deal will be placed at the top of the list."}}},"example":{"pipelineId":"","status":"","stepId":"","responsibleId":"","name":"","price":"","currency":"","sourceId":"","order":""}}}}},"delete":{"tags":["CRM Deals"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID to delete","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}"},"summary":"Delete a deal by its ID","description":"Deletes the selected deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals/{dealId}/change-pipeline":{"post":{"tags":["CRM Deals"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID to be updated. You can get it in the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/change-pipeline"},"summary":"Change the pipeline of a deal by its ID.","description":"Change the pipeline of a deal by its ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pipelineId":{"type":"number","description":"Pipeline ID to which the deal will be moved. It can be obtained with the method \"Get a list of pipelines\""},"stepId":{"type":"number","description":"ID of a pipeline step where you need to place a deal. It can be obtained from the methods \"Get a list of pipelines\" and \"Get information about a pipeline by its ID\""}}},"example":{"pipelineId":"","stepId":""}}}}}},"/crm/v1/deals/{dealId}/comments":{"get":{"tags":["CRM Deal Notes"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID for which you want to get the list of notes. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/comments"},"summary":"Get a list of deal notes","description":"Returns a list of notes with information about each: ID, author, message and status","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Deal Notes"],"parameters":[{"name":"dealId","in":"path","description":"ID of the deal for which you want to add a note. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/comments"},"summary":"Add a note to a deal","description":"Adds a note to the specified deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"Note message. The maximum number of characters is 65,535","required":true}}},"example":{"message":""}}}}}},"/crm/v1/deals/{dealId}/comments/{commentId}":{"put":{"tags":["CRM Deal Notes"],"parameters":[{"name":"dealId","in":"path","description":"ID of the deal for which you want to update a note. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}},{"name":"commentId","in":"path","description":"ID of the note to be updated. It can be obtained with the \"Get a list of deal notes\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/comments/{commentId}"},"summary":"Update a note to a deal","description":"Updates the selected note in the specified deal. Existing values will be overwritten","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"New note message. The maximum number of characters is 65,535","required":true}}},"example":{"message":""}}}}},"delete":{"tags":["CRM Deal Notes"],"parameters":[{"name":"dealId","in":"path","description":"ID of the deal from which you want to remove a note. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}},{"name":"commentId","in":"path","description":"ID of the note to be removed. It can be obtained with the \"Get a list of deal notes\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/comments/{commentId}"},"summary":"Remove a note from the deal","description":"Removes a note from the specified deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals/{dealId}/contacts":{"get":{"tags":["CRM Deal Contacts"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID for which you want to get the list of contacts. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/contacts"},"summary":"Get a list of contacts in a deal","description":"Returns a list of contacts in the specified deal","security":[{"bearerAuth":[]}]}},"/crm/v1/deals/{dealId}/contacts/{contactId}":{"post":{"tags":["CRM Deal Contacts"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID in which you want to add the contact. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}},{"name":"contactId","in":"path","description":"Contact ID you want to add to the deal. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/contacts/{contactId}"},"summary":"Add a contact to a deal","description":"Adds a previously created contact to the specified deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["CRM Deal Contacts"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID from which you want to remove the contact. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}},{"name":"contactId","in":"path","description":"Contact ID you want to remove from the deal. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/contacts/{contactId}"},"summary":"Delete a contact from a deal","description":"Removes the contact from the specified deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/pipelines/{pipelineId}/attributes":{"get":{"tags":["CRM Deal Attributes"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/attributes"},"summary":"Get deal attributes list","description":"Get deal attributes list","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Deal Attributes"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/attributes"},"summary":"Create a deal attribute","description":"Create a deal attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"type":{"type":"number","description":"0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect","required":true},"mandatory":{"type":"boolean","description":"Mandatory","enum":[true,false]},"options":{"type":"array","description":"Options","items":{"type":"string"}}}},"example":{"name":"","type":"","mandatory":"","options":[]}}}}}},"/crm/v1/pipelines/{pipelineId}/attributes/{attributeId}":{"put":{"tags":["CRM Deal Attributes"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}},{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/attributes/{attributeId}"},"summary":"Update a deal attribute","description":"Update a deal attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"type":{"type":"number","description":"0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect"},"mandatory":{"type":"boolean","description":"Mandatory","enum":[true,false]},"order":{"type":"number","description":"Order","required":true},"status":{"type":"number","description":"0 = Inactive, 1 = Active, 2 = Hidden"},"options":{"type":"array","description":"Options","items":{"type":"string"}}}},"example":{"name":"","type":"","mandatory":"","order":"","status":"","options":[]}}}}},"delete":{"tags":["CRM Deal Attributes"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}},{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/pipelines/{pipelineId}/attributes/{attributeId}"},"summary":"Delete a deal attribute","description":"Delete a deal attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals/{dealId}/attributes":{"get":{"tags":["CRM Deal Attribute Value"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID for which you want to get the fields. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/attributes"},"summary":"Get deal attribute values by ID","description":"Returns a list of attributes with ID, types, and values in the specified deal","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Deal Attribute Value"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID to which you want to add the field. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/attributes"},"summary":"Add a attribute value to deal by deal ID","description":"Adds a attribute with the specified value and ID to the deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attributeId":{"type":"number","description":"Attribute ID you want to add to the deal. It can be obtained with the \"Get a list of deals\" and \"Get information about the deal by ID\" methods","required":true},"value":{"type":"string","description":"Attribute value to be added to the deal. The maximum number of characters is 5500","required":true}}},"example":{"attributeId":"","value":""}}}}}},"/crm/v1/deals/attributes/{pipelineId}":{"get":{"tags":["CRM Deal Attribute Value"],"parameters":[{"name":"pipelineId","in":"path","description":"pipelineId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/attributes/{pipelineId}"},"summary":"List of all deal attribute values by pipeline","description":"List of all deal attribute values by pipeline","security":[{"bearerAuth":[]}]}},"/crm/v1/deals/{dealId}/attributes/{attributeId}":{"put":{"tags":["CRM Deal Attribute Value"],"parameters":[{"name":"dealId","in":"path","description":"The deal ID for which you want to update the attribute. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}},{"name":"attributeId","in":"path","description":"The attribute ID you want update. It can be obtained with the \"Get a list of deals\" and \"Get information about the deal by ID\" methods","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/attributes/{attributeId}"},"summary":"Update the deal attribute value","description":"Updates the deal attribute with the new value. Existing values will be overwritten.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"value":{"type":"string","description":"New attribute value. The maximum number of characters is 5500","required":true}}},"example":{"value":""}}}}},"delete":{"tags":["CRM Deal Attributes"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID from which you want to delete the field. It can be obtained with the \"Get a list of deals\" method","required":true,"schema":{"type":"number","example":""}},{"name":"attributeId","in":"path","description":"Attribute ID you want delete. It can be obtained with the \"Get a list of deals\" and \"Get information about the deal by ID\" methods","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/attributes/{attributeId}"},"summary":"Remove the deal attribute","description":"Removes the attribute from the specified deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/messenger-types":{"get":{"tags":["CRM Messengers Types"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/messenger-types"},"summary":"Get a list of messengers","description":"Returns a list of types of available messengers for contacts","security":[{"bearerAuth":[]}]}},"/crm/v1/payments/all":{"get":{"tags":["CRM Payments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/payments/all"},"summary":"Get a list of payments by user","description":"Get a list of payments by user","security":[{"bearerAuth":[]}]}},"/crm/v1/payments/deals/{dealId}":{"get":{"tags":["CRM Payments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/payments/deals/{dealId}"},"summary":"Get a list of payments by dealId","description":"Get a list of payments by dealId","security":[{"bearerAuth":[]}]}},"/crm/v1/payments/contacts/{contactId}":{"get":{"tags":["CRM Payments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/payments/contacts/{contactId}"},"summary":"Get a list of payments by contactId","description":"Get a list of payments by contactId","security":[{"bearerAuth":[]}]}},"/crm/v1/contacts/get-list":{"post":{"tags":["CRM Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/get-list"},"summary":"Get contacts list","description":"Get contacts list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"Limit"},"offset":{"type":"number","description":"Offset"},"from":{"type":"string","description":"Contact creation date, filter start date. Accepted format YYYY-MM-DD (format: date)"},"to":{"type":"string","description":"Contact creation date, filter end date. Accepted format YYYY-MM-DD (format: date)"},"updateFrom":{"type":"string","description":"Contact updated date, filter start date. Accepted format YYYY-MM-DD (format: date)"},"updateTo":{"type":"string","description":"Contact updated date, filter end date. Accepted format YYYY-MM-DD (format: date)"},"firstName":{"type":"string","description":"Contacts first name you want to search for"},"lastName":{"type":"string","description":"Contacts last name you want to search for"},"responsibleIds":{"type":"array","description":"A list with the ID of users assigned to the contact you want to to search for. It can be obtained with the \"Get a list of team members\" method","items":{"type":"number"}},"sourceType":{"type":"array","description":"Sourcetype","items":{"type":"number"}},"phone":{"type":"string","description":"Phone number of a contact"},"email":{"type":"string","description":"Email"},"tagIds":{"type":"array","description":"Tagids","items":{"type":"number"}},"messengerTypeIds":{"type":"array","description":"Messengertypeids","items":{"type":"number"}},"messengerLogin":{"type":"string","description":"Messengerlogin"},"sortBy":{"type":"object","description":"Sortby","properties":{"direction":{"type":"string","description":"Sorting direction. Possible values: asc — ascending order; desc — descending order.","enum":["asc","desc"]},"fieldName":{"type":"string","description":"Fieldname","enum":["id","created_at","first_name","attributeId","responsible_id"]}}},"attributes":{"type":"array","description":"Filter by attributes only","items":{"type":"object","properties":{"id":{"type":"string","description":"Attribute ID"},"expression":{"type":"string","description":"| Possible values:\n- eq (=) - neq (!=) - gt (>) - gte (>=) - lt (<) - lte (<=) - like - in (check among list of values)."},"value":{"type":"string","description":"Can have string value or array of strings"}}}},"location":{"type":"string","description":"Location"},"fieldValueConditions":{"type":"array","description":"Fieldvalueconditions","items":{"type":"object","properties":{"field":{"type":"string","description":"Field name","enum":["attributes","lastName","phones","emails","messengers","location","tags"]},"expression":{"type":"string","description":"| Possible values:\n- eq (=) - neq (!=) - gt (>) - gte (>=) - lt (<) - lte (<=) - like - in (check among list of values)."},"value":{"type":"string","description":"Can have array or string type"}}}},"ids":{"type":"array","description":"Array of contacts IDs","items":{"type":"number"}}}},"example":{"limit":"","offset":"","from":"","to":"","updateFrom":"","updateTo":"","firstName":"","lastName":"","responsibleIds":[],"sourceType":[],"phone":"","email":"","tagIds":[],"messengerTypeIds":[],"messengerLogin":"","sortBy":{},"attributes":[],"location":"","fieldValueConditions":[],"ids":[]}}}}}},"/crm/v1/contacts/get-list-by-email":{"post":{"tags":["CRM Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/get-list-by-email"},"summary":"Search contacts by email","description":"Returns contacts and the following information about each: the contact ID, the assigned person and the contact information","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email address of a contact"},"isEmailFullSearch":{"type":"boolean","description":"Search for emails that match completely or partially (true/false)","enum":[true,false]}}},"example":{"email":"","isEmailFullSearch":""}}}}}},"/crm/v1/contacts":{"post":{"tags":["CRM Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts"},"summary":"(Deprecated). Use POST /contacts/create instead to create a new contact","description":"[DEPRECATED] Creates a contact with the given properties and returns a copy of the information, including the ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"responsibleId":{"type":"number","description":"Team member ID to assign to a contact. It can be obtained with the \"Get a list of team members\" method","required":true},"firstName":{"type":"string","description":"Contact first name"},"lastName":{"type":"string","description":"Contact last name"},"phones":{"type":"array","description":"List of phone numbers in the international format","items":{"type":"string"}},"emails":{"type":"array","description":"List of email addresses","items":{"type":"string"}},"tags":{"type":"array","description":"List of tag IDs to be added to a contact. It can be obtained with the \"Get a list of contact tags\" method","items":{"type":"number"}},"attributes":{"type":"array","description":"List of fields to add to the contact. Pass in the attributes field array an object with the attributeId and value fields (will create a contact with an already existing attribute) Pass in the attributes field\narray an object with the name, type , value fields (will create a contact with a new attribute\nif there is no such attribute yet or create a contact with an existing attribute if the attribute already exists)'","items":{"type":"string"}},"messengers":{"type":"array","description":"List of messengers to add to a contact","items":{"type":"string"}},"attachments":{"type":"array","description":"First, the file must be uploaded to the file manager, and then the file can be attached.","items":{"type":"string"}}}},"example":{"responsibleId":"","firstName":"","lastName":"","phones":[],"emails":[],"tags":[],"attributes":[],"messengers":[],"attachments":["/personal/deal/sendPulse_crm_deals.csv"]}}}}}},"/crm/v1/contacts/create":{"post":{"tags":["CRM Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/create"},"summary":"Create a new contact","description":"Creates a contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"responsibleId":{"type":"number","description":"Team member ID to assign to a contact. It can be obtained with the \"Get a list of team members\" method","required":true},"firstName":{"type":"string","description":"Contact first name"},"lastName":{"type":"string","description":"Contact last name"},"externalContactId":{"type":"string","description":"External contact ID field for services data - we do not recommend using it to add an ID from third-party systems"}}},"example":{"responsibleId":"","firstName":"","lastName":"","externalContactId":""}}}}}},"/crm/v1/contacts/{contactId}":{"get":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID for which you want to get information. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}"},"summary":"Get information about a contact by ID","description":"Returns the following information on the specified contact: ID, team member responsible for the contact, first and Contacts last name, number of deals of the contact, list of phone numbers and email addresses, and messengers of the contact","security":[{"bearerAuth":[]}]},"put":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID of the contact whose information you want to update. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}"},"summary":"Update information about the contact","description":"Update information about specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"responsibleId":{"type":"number","description":"Team member ID to assign to a contact. It can be obtained with the \"Get a list of team members\" method","required":true},"firstName":{"type":"string","description":"Contact first name"},"lastName":{"type":"string","description":"Contact last name"}}},"example":{"responsibleId":"","firstName":"","lastName":""}}}}},"delete":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID to be removed. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}"},"summary":"Remove contact by ID","description":"Removes the specified contact by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/deals":{"get":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/deals"},"summary":"Get all deals that related to contact","description":"Get all deals that related to contact","security":[{"bearerAuth":[]}]}},"/crm/v1/contacts/{contactId}/comments":{"post":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID to which you want to add a note. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/comments"},"summary":"Add a note to a contact","description":"Adds a note to the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"Note message. The maximum number of characters is 65,535","required":true}}},"example":{"message":""}}}}}},"/crm/v1/contacts/{contactId}/comments/{commentId}":{"put":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID contact for which you want to update the note. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"commentId","in":"path","description":"Note ID you want to update. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/comments/{commentId}"},"summary":"Update contact note","description":"Updates the note of the specified contact. Provided property values will be overwritten.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"New note message. The maximum number of characters is 65,535","required":true}}},"example":{"message":""}}}}},"delete":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID for which you want to remove the note. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"commentId","in":"path","description":"Note ID you want to remove. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/comments/{commentId}"},"summary":"Remove contact note","description":"Removes a note of a specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/phones":{"post":{"tags":["CRM Contact Phone Number"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID to add the phone to. Can be obtained in the \"Get contact list\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/phones"},"summary":"Add a phone number to the contact.","description":"Adds phone numbers to existing contacts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone":{"type":"string","description":"Phone","required":true}}},"example":{"phone":""}}}}}},"/crm/v1/contacts/{contactId}/phones/{phoneId}":{"put":{"tags":["CRM Contact Phone Number"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID for which you want to update the phone number. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"phoneId","in":"path","description":"The phone number ID you want to update. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/phones/{phoneId}"},"summary":"Update the phone number of the contact","description":"Updates the phone number of the specified contact. Provided property values will be overwritten.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone":{"type":"string","description":"New phone number in the international format","required":true}}},"example":{"phone":""}}}}},"delete":{"tags":["CRM Contact Phone Number"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID from which you want to remove the phone number. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"phoneId","in":"path","description":"Phone number ID you want to remove. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/phones/{phoneId}"},"summary":"Delete phone number","description":"Removes the phone number from the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/emails":{"post":{"tags":["CRM Contact Email Addresses"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID to which you want to add the email address. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/emails"},"summary":"Add an email address to the contact","description":"Adds an email address to the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","items":{"type":"object","properties":{"email":{"type":"string","description":"Email address to be added to the contact"},"isMain":{"type":"boolean","description":"Determines whether the email address is the main one","enum":[true,false]}}}}}},"example":{"emails":[]}}}}}},"/crm/v1/contacts/{contactId}/emails/{emailId}":{"put":{"tags":["CRM Contact Email Addresses"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID for which you want to update the email address. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"emailId","in":"path","description":"Email address ID you want to update. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/emails/{emailId}"},"summary":"Update the email address of the contact","description":"Updates the email address of the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"New email address","required":true}}},"example":{"email":""}}}}},"delete":{"tags":["CRM Contact Email Addresses"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID from which you want to remove the email address. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"emailId","in":"path","description":"Email address ID you want to delete. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/emails/{emailId}"},"summary":"Remove the email address from the contact","description":"Removes the email address from the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/messengers":{"post":{"tags":["CRM Contacts Messengers"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID you want to add a mesenger to. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/messengers"},"summary":"Add messenger to contact","description":"Adds a messenger to the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"typeId":{"type":"number","description":"| Messenger type. Possible values: * 1 — Telegram * 2 — Facebook * 4 — Instagram * 5 — WhatsApp * 6 — Viber","required":true},"login":{"type":"string","description":"Contacts login in the specified messenger","required":true},"isMainChatbot":{"type":"boolean","description":"Determine if chatbot messenger is the main one","enum":[true,false]}}},"example":{"typeId":"","login":"","isMainChatbot":""}}}}}},"/crm/v1/contacts/{contactId}/messengers/{messengerId}":{"put":{"tags":["CRM Contacts Messengers"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID for which you want to update messenger information. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"messengerId","in":"path","description":"Messenger ID you want to update. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/messengers/{messengerId}"},"summary":"Update information about messenger of the contact","description":"Updates information about a given messenger for the specified contact. Provided property values will be overwritten.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"typeId":{"type":"number","description":"| Messenger type. Possible values: * 1 — Telegram * 2 — Facebook * 4 — Instagram * 5 — WhatsApp * 6 — Viber","required":true},"login":{"type":"string","description":"Contacts login in the specified messenger","required":true},"isMainChatbot":{"type":"boolean","description":"Determine if chatbot messenger is the main one","enum":[true,false]}}},"example":{"typeId":"","login":"","isMainChatbot":""}}}}},"delete":{"tags":["CRM Contacts Messengers"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID from which you want to remove messenger. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"messengerId","in":"path","description":"Messenger ID you want to remove. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/messengers/{messengerId}"},"summary":"Remove messenger from contact","description":"Removes messenger from a specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contact-tags/{tagId}/contact/{contactId}":{"post":{"tags":["CRM Contact Tags"],"parameters":[{"name":"tagId","in":"path","description":"Tag ID you want to add. It can be obtained with the \"Get a list of contact tags\" method","required":true,"schema":{"type":"number","example":""}},{"name":"contactId","in":"path","description":"Contact ID to which you want to add the tag. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contact-tags/{tagId}/contact/{contactId}"},"summary":"Add a tag to the contact","description":"Adds a tag to the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["CRM Contact Tags"],"parameters":[{"name":"tagId","in":"path","description":"Tag ID you want to remove. It can be obtained with the \"Get a list of contact tags\" method","required":true,"schema":{"type":"number","example":""}},{"name":"contactId","in":"path","description":"Contact ID from which you want to remove the tag. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contact-tags/{tagId}/contact/{contactId}"},"summary":"Delete a tag from a contact","description":"Removes the tag of the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contact-tags":{"get":{"tags":["CRM Contact Tags"],"parameters":[{"name":"name","in":"query","description":"Exact match filter by tag name","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Partial match filter by tag name (LIKE %search%)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contact-tags"},"summary":"Get a list of contact tags","description":"Returns a list of contact tags with the tag ID, tag name, and the number of contacts associated with this tag","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Contact Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contact-tags"},"summary":"Create a tag (CRM Contact Tags)","description":"Creates a tag with the specified name","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Tag name to be created. The maximum number of characters is 64","required":true},"colorText":{"type":"string","description":"Text color"},"colorBackground":{"type":"string","description":"Background color"}}},"example":{"name":"","colorText":"","colorBackground":""}}}}}},"/crm/v1/contact-tags/{tagId}":{"put":{"tags":["CRM Contact Tags"],"parameters":[{"name":"tagId","in":"path","description":"Tag ID you want to update. It can be obtained with the \"Get a list of contact tags\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contact-tags/{tagId}"},"summary":"Update a tag (CRM Contact Tags)","description":"Updates the specified tag with a new name. Provided property values will be overwritten.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"New tag name. The maximum number of characters is 255","required":true},"colorText":{"type":"string","description":"Text color"},"colorBackground":{"type":"string","description":"Background color"}}},"example":{"name":"","colorText":"","colorBackground":""}}}}},"delete":{"tags":["CRM Contact Tags"],"parameters":[{"name":"tagId","in":"path","description":"Tag ID you want to remove. It can be obtained with the \"Get a list of contact tags\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contact-tags/{tagId}"},"summary":"Remove tag","description":"Removes the specified tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/attributes":{"get":{"tags":["CRM Contact Attributes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/attributes"},"summary":"Get contact attributes list","description":"Get contact attributes list","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Contact Attributes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/attributes"},"summary":"Create a contact attribute","description":"Create a contact attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"type":{"type":"number","description":"0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect"},"mandatory":{"type":"boolean","description":"Mandatory","enum":[true,false]},"options":{"type":"array","description":"Options","items":{"type":"string"}}}},"example":{"name":"","type":"","mandatory":"","options":[]}}}}}},"/crm/v1/contacts/attributes/{attributeId}":{"put":{"tags":["CRM Contact Attributes"],"parameters":[{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/attributes/{attributeId}"},"summary":"Update a contact attribute","description":"Update a contact attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"status":{"type":"number","description":"0 = Inactive, 1 = Active, 2 = Hidden"},"type":{"type":"number","description":"0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect"},"mandatory":{"type":"boolean","description":"Mandatory","enum":[true,false]},"contactCardShow":{"type":"boolean","description":"Contactcardshow","enum":[true,false]},"order":{"type":"number","description":"Order","required":true},"options":{"type":"array","description":"Options","items":{"type":"string"}}}},"example":{"name":"","status":"","type":"","mandatory":"","contactCardShow":"","order":"","options":[]}}}}},"delete":{"tags":["CRM Contact Attributes"],"parameters":[{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/attributes/{attributeId}"},"summary":"Delete a contact attribute","description":"Delete a contact attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/attributes":{"get":{"tags":["CRM"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID for which you want to get the list of attributes. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/attributes"},"summary":"Get a list of specified contact attribute values","description":"Returns a list of attributes for the specified contact with information about the contacts ID, title, status, value, and options for each","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID to which you want to add the attribute. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/attributes"},"summary":"Add attribute value to contact","description":"Adds a attribute to the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attributeId":{"type":"number","description":"Attribute ID you want to add to the contact. It can be obtained with the \"Get a list of contacts\" and \"Get information about a contact by ID\" methods","required":true},"value":{"type":"string","description":"The attribute value to add to the contact. The maximum number of characters is 5500","required":true}}},"example":{"attributeId":"","value":""}}}}}},"/crm/v1/contacts/{contactId}/attributes/{attributeId}":{"put":{"tags":["CRM"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID for which you want to update the field. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"attributeId","in":"path","description":"Attribute ID you want to update. It can be obtained with the \"Get a list of contacts\" and \"Get information about a contact by ID\" methods","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/attributes/{attributeId}"},"summary":"Update contact attribute value","description":"Updates the attribute for the specified contact. Provided property values will be overwritten.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"value":{"type":"string","description":"New attribute value. The maximum number of characters is 5500","required":true}}},"example":{"value":""}}}}},"delete":{"tags":["CRM"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID from which you want to remove the attribute. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"attributeId","in":"path","description":"Attribute ID you want to remove. It can be obtained with the \"Get a list of contacts\" and \"Get information about a contact by ID\" methods","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/attributes/{attributeId}"},"summary":"Delete contact attribute value","description":"Delete attribute for specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/attributes/batch":{"post":{"tags":["CRM"],"parameters":[{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/attributes/batch"},"summary":"Batch store contact attributes values","description":"Batch store contact attributes values","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attributesValues":{"type":"array","description":"Attributesvalues","items":{"type":"object","properties":{"attributeId":{"type":"number","description":"Attribute ID"},"value":{"type":"string","description":"Attribute value"}}}}}},"example":{"attributesValues":[]}}}}}},"/crm/v1/boards":{"get":{"tags":["CRM Tasks Boards"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards"},"summary":"Get all boards","description":"Get all boards","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Tasks Boards"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards"},"summary":"Create new board","description":"Creates a new board with the specified properties","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Board name"},"settings":{"type":"array","description":"Settings","items":{"type":"string"}}}},"example":{"name":"","settings":[]}}}}}},"/crm/v1/boards/{boardId}":{"get":{"tags":["CRM Tasks Boards"],"parameters":[{"name":"boardId","in":"path","description":"boardId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards/{boardId}"},"summary":"Get board by ID","description":"Gets a board with all associated settings","security":[{"bearerAuth":[]}]},"put":{"tags":["CRM Tasks Boards"],"parameters":[{"name":"boardId","in":"path","description":"boardId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards/{boardId}"},"summary":"Update board by ID","description":"Updates the board with settings by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"settings":{"type":"array","description":"Settings","items":{"type":"string"}}}},"example":{"name":"","settings":[]}}}}}},"/crm/v1/boards/{boardId}/attributes":{"get":{"tags":["CRM Board Attributes"],"parameters":[{"name":"boardId","in":"path","description":"boardId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards/{boardId}/attributes"},"summary":"Get attribute for board","description":"Get attribute for board","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Board Attributes"],"parameters":[{"name":"boardId","in":"path","description":"boardId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards/{boardId}/attributes"},"summary":"Create attribute for board","description":"Create attribute for board","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Attribute name"},"type":{"type":"number","description":"Attribute type:\n0 -string\n1 - number\n2 - date\n3 - link\n4 - list\n5 - multiList"},"mandatory":{"type":"boolean","description":"Is attribute required","enum":[true,false]},"options":{"type":"array","description":"Attribute options (only for \"list\" and \"multiList\" types)","items":{"type":"string"}}}},"example":{"name":"","type":"","mandatory":"","options":[]}}}}}},"/crm/v1/boards/{boardId}/attributes/{attributeId}":{"put":{"tags":["CRM Board Attributes"],"parameters":[{"name":"boardId","in":"path","description":"boardId","required":true,"schema":{"type":"number","example":""}},{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards/{boardId}/attributes/{attributeId}"},"summary":"Update attribute for board","description":"Update attribute for board","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Attribute name"},"type":{"type":"number","description":"Attribute type:\n0 -string\n1 - number\n2 - date\n3 - link\n4 - list\n5 - multiList"},"mandatory":{"type":"boolean","description":"Is attribute required","enum":[true,false]},"options":{"type":"array","description":"Attribute options (only for \"list\" and \"multiList\" types","items":{"type":"string"}},"order":{"type":"number","description":"Attribute order"},"status":{"type":"number","description":"Status"}}},"example":{"name":"","type":"","mandatory":"","options":[],"order":"","status":""}}}}}},"/crm/v1/boards/{boardId}/steps":{"post":{"tags":["CRM Tasks Steps"],"parameters":[{"name":"boardId","in":"path","description":"boardId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards/{boardId}/steps"},"summary":"Create steps for board","description":"Create steps for board","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Step name"},"color":{"type":"string","description":"Step color"}}},"example":{"name":"","color":""}}}}}},"/crm/v1/boards/{boardId}/steps/{stepId}":{"put":{"tags":["CRM Tasks Steps"],"parameters":[{"name":"boardId","in":"path","description":"boardId","required":true,"schema":{"type":"number","example":""}},{"name":"stepId","in":"path","description":"stepId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/boards/{boardId}/steps/{stepId}"},"summary":"Update steps for board","description":"Updates board step (with order)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Step name"},"color":{"type":"string","description":"Step color"},"order":{"type":"number","description":"Step order"}}},"example":{"name":"","color":"","order":""}}}}}},"/crm/v1/tasks/list":{"post":{"tags":["CRM Tasks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/list"},"summary":"Get tasks","description":"Retrieves a list of tasks based on selected filters","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"boardId":{"type":"number","description":"Boardid"},"stepId":{"type":"array","description":"Array of step IDs","items":{"type":"string"}},"priority":{"type":"number","description":"Priority"},"type":{"type":"number","description":"Type","enum":[1,2,3]},"responsibleId":{"type":"array","description":"Array of responsible users IDs","items":{"type":"string"}},"parentId":{"type":"array","description":"Array of parent task IDs","items":{"type":"string"}},"dealName":{"type":"string","description":"Dealname"},"observers":{"type":"array","description":"Array of users IDs acting as observers","items":{"type":"string"}},"tags":{"type":"array","description":"IDs of tags","items":{"type":"string"}},"tagMatch":{"type":"string","description":"Filter by tags (all - all tags, any - any tag). Default: any","enum":["any","all"]},"attributes":{"type":"array","description":"Attributes","items":{"type":"string"}},"contacts":{"type":"string","description":"Contacts"},"startAtFrom":{"type":"string","description":"Startatfrom"},"startAtTo":{"type":"string","description":"Startatto"},"finishAtFrom":{"type":"string","description":"Finishatfrom"},"finishAtTo":{"type":"string","description":"Finishatto"},"createdAtFrom":{"type":"string","description":"Createdatfrom"},"createdAtTo":{"type":"string","description":"Createdatto"},"updatedAtFrom":{"type":"string","description":"Updatedatfrom"},"updatedAtTo":{"type":"string","description":"Updatedatto"},"sort":{"type":"object","description":"Sort","properties":{"field":{"type":"string","description":"Field"},"direction":{"type":"string","description":"Direction"}}},"status":{"type":"number","description":"Status","enum":[1,2]},"endedAtFrom":{"type":"string","description":"Endedatfrom"},"endedAtTo":{"type":"string","description":"Endedatto"}}},"example":{"name":"","boardId":1,"stepId":[],"priority":"[ 1,2,3 ]","type":"","responsibleId":[],"parentId":[],"dealName":"name","observers":[],"tags":[],"tagMatch":"","attributes":[],"contacts":"name","startAtFrom":"2021-11-25 13:38","startAtTo":"2021-11-25 13:38","finishAtFrom":"2021-11-25 13:38","finishAtTo":"2021-11-25 13:38","createdAtFrom":"2021-11-25 13:38","createdAtTo":"2021-11-25 13:38","updatedAtFrom":"2025-05-03 13:00","updatedAtTo":"2025-05-07 13:00","sort":{},"status":"","endedAtFrom":"2021-11-25 13:38","endedAtTo":"2021-11-25 13:38"}}}}}},"/crm/v1/tasks":{"post":{"tags":["CRM Tasks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks"},"summary":"Create tasks","description":"repeatSetting - has 4 types: 1-daily, 2-weekly, 3-monthly, 4-yearly.\n'endSetting' - has 2 types: byDate(2021-11-25), byCount(1)\n\n1) 'repeatSetting': {'type': 1, 'startDate': '2021-11-25 13:38',\n'endSetting': {'type':'byDate','value': '2021-11-25'},'setting': {'everyDay': 2 }};\n<br> 'everyDay' - 2 (repeat every Tuesday)\n\n2) 'repeatSetting': {'type': 2, 'startDate': '2021-11-25 13:38',\n'endSetting': {'type':'byCount','value': 1},'setting': {'days': [1,4,5], 'everyWeekOfMonth': 3 }};\n'days': [1,4,5], 'everyWeekOfMonth': 3\n<br> (repeat every Monday, Thursday, Friday of every 3rd week of the month)\n\n3) 'repeatSetting': {'type': 3, 'startDate': '2021-11-25 13:38',\n'endSetting': {'type':'byDate','value': '2021-11-25'},\n'setting': {'numberOfMonth': {'everyDay': 31, 'everyMonth':5} }};\n<br> 'numberOfMonth': {'everyDay': 31, 'everyMonth':5 (repeat every 31st day of every 5th month)\n\n4) 'repeatSett","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Task name"},"boardId":{"type":"number","description":"Boardid"},"stepId":{"type":"number","description":"Stepid"},"observers":{"type":"array","description":"Array of users IDs acting as observers","items":{"type":"string"}},"priority":{"type":"number","description":"| Task priority\n* 1 - low * 2 - middle * 3 - high"},"sourceType":{"type":"number","description":"| * 1 - chatbot * 2 - manually * 3 - subscription_form * 4 - landing * 5 - a360 * 6 - payments * 7 - import * 8 - public_api * 9 - education * 10 - integration * 11 - popup * 12 - emailService"},"responsibleId":{"type":"number","description":"Responsible user ID"},"parentId":{"type":"number","description":"Parent task ID"},"description":{"type":"string","description":"Task description"},"alert":{"type":"string","description":"Notify before task expires (when notification is enabled). Allowed values - 0(not selected), 15min, 30min, 1h, 2h, 3h, 6h, 12h, 24h, 2d, 3d, 4d, 5d, 6d, 7d"},"repeat":{"type":"number","description":"Do you need to repeat the task"},"startAt":{"type":"string","description":"(format: Y-m-d H:i)"},"finishAt":{"type":"string","description":"(format: Y-m-d H:i)"},"repeatSetting":{"type":"object","description":"Repeatsetting","properties":{"type":{"type":"number","description":"Repetition frequency\n\n* 1 - daily\n* 2 - weekly\n* 3 - monthly\n* 4 - yearly"},"startDate":{"type":"string","description":"Format - 2021-11-25 13:38 (format: date-time)"},"endSetting":{"type":"object","description":"Endsetting"},"setting":{"type":"object","description":"Setting"}}},"attributes":{"type":"array","description":"Attributes","items":{"type":"string"}},"tags":{"type":"array","description":"IDs of tags","items":{"type":"string"}},"checklists":{"type":"array","description":"Checklists","items":{"type":"object","properties":{"name":{"type":"string","description":"Checklist name"},"items":{"type":"array","description":"Items"}}}},"connections":{"type":"object","description":"Connections","properties":{"dealIds":{"type":"array","description":"Dealids"},"contactIds":{"type":"array","description":"Contactids"},"taskIds":{"type":"array","description":"Taskids"}}},"attachments":{"type":"array","description":"First, the file must be uploaded to the file manager, and then the file can be attached.","items":{"type":"string"}}}},"example":{"name":"","boardId":"","stepId":"","observers":[],"priority":"","sourceType":"","responsibleId":"","parentId":"","description":"","alert":"","repeat":"","startAt":"","finishAt":"","repeatSetting":{},"attributes":[],"tags":"[ 1,2,3 ]","checklists":[],"connections":{},"attachments":["/personal/task/sendPulse_crm_report.csv"]}}}}}},"/crm/v1/tasks-repeat/templates":{"get":{"tags":["CRM Tasks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks-repeat/templates"},"summary":"Get task templates","description":"Get task templates","security":[{"bearerAuth":[]}]}},"/crm/v1/tasks/{taskId}":{"get":{"tags":["CRM Tasks"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}"},"summary":"Get tasks by ID","description":"Get tasks by ID","security":[{"bearerAuth":[]}]},"put":{"tags":["CRM Tasks"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}"},"summary":"Update a task by ID","description":"Update a task by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Task name"},"boardId":{"type":"number","description":"Boardid"},"stepId":{"type":"number","description":"Stepid"},"priority":{"type":"number","description":"| Task priority\n* 1 - low * 2 - middle * 3 - high"},"sourceType":{"type":"number","description":"| * 1 - chatbot * 2 - manually * 3 - subscription_form * 4 - landing * 5 - a360 * 6 - payments * 7 - import * 8 - public_api * 9 - education * 10 - integration * 11 - popup * 12 - emailService"},"responsibleId":{"type":"number","description":"Responsible user ID"},"parentId":{"type":"number","description":"Parent task ID"},"description":{"type":"string","description":"Task description"},"repeat":{"type":"number","description":"Do you need to repeat the task"},"startAt":{"type":"string","description":"(format: Y-m-d H:i)"},"finishAt":{"type":"string","description":"(format: Y-m-d H:i)"},"tags":{"type":"array","description":"IDs of tags","items":{"type":"string"}},"observers":{"type":"array","description":"Array of users IDs acting as observers","items":{"type":"string"}}}},"example":{"name":"","boardId":"","stepId":"","priority":"","sourceType":"","responsibleId":"","parentId":"","description":"","repeat":"","startAt":"","finishAt":"","tags":"[ 1,2,3 ]","observers":"[ 1,2,3 ]"}}}}},"delete":{"tags":["CRM Tasks"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}"},"summary":"Delete task by ID","description":"Delete task by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/tasks/{taskId}/parent":{"post":{"tags":["CRM Tasks"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/parent"},"summary":"Set/unset the parent task","description":"Set/unset the parent task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"parentId":{"type":"number","description":"Parent task ID or null"}}},"example":{"parentId":""}}}}}},"/crm/v1/tasks/{taskId}/steps/{stepId}/order":{"post":{"tags":["CRM Tasks"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}},{"name":"stepId","in":"path","description":"stepId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/steps/{stepId}/order"},"summary":"Change task order","description":"Changes order of a task in the current step or in another. newStepId field is optional","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"order":{"type":"number","description":"Task order in step","required":true},"newStepId":{"type":"number","description":"New step ID"}}},"example":{"order":"","newStepId":""}}}}}},"/crm/v1/tasks/{taskId}/comments":{"post":{"tags":["CRM Task Comments"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/comments"},"summary":"Add comment to task","description":"Add comment to task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"Comment message"}}},"example":{"message":""}}}}}},"/crm/v1/tasks/{taskId}/comments/{commentId}":{"put":{"tags":["CRM Task Comments"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}},{"name":"commentId","in":"path","description":"commentId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/comments/{commentId}"},"summary":"Update comment in task","description":"Update comment in task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"Comment message"}}},"example":{"message":""}}}}}},"/crm/v1/task-tags/{tagId}/task/{taskId}":{"delete":{"tags":["CRM Task Tags"],"parameters":[{"name":"tagId","in":"path","description":"tagId","required":true,"schema":{"type":"number","example":""}},{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-tags/{tagId}/task/{taskId}"},"summary":"Detach tag from a task","description":"Detach tag from a task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/task-tags":{"get":{"tags":["CRM Task Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-tags"},"summary":"Get task tags list","description":"Get task tags list","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Task Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-tags"},"summary":"Create a task tag","description":"Create a task tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Tag name"},"color":{"type":"string","description":"Tag color"}}},"example":{"name":"","color":""}}}}}},"/crm/v1/task-tags/{tagId}":{"put":{"tags":["CRM Task Tags"],"parameters":[{"name":"tagId","in":"path","description":"tagId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-tags/{tagId}"},"summary":"Update a task tag","description":"Update a task tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Tag name"},"color":{"type":"string","description":"Tag color"}}},"example":{"name":"","color":""}}}}},"delete":{"tags":["CRM Task Tags"],"parameters":[{"name":"tagId","in":"path","description":"tagId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-tags/{tagId}"},"summary":"Delete a task tag","description":"Delete a task tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/task-contacts/{taskId}/contact/{contactId}":{"delete":{"tags":["CRM Task Entity"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}},{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-contacts/{taskId}/contact/{contactId}"},"summary":"Detach a contact from a task","description":"Detach a contact from a task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/task-deals/{taskId}/deal/{dealId}":{"delete":{"tags":["CRM Task Entity"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}},{"name":"dealId","in":"path","description":"dealId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-deals/{taskId}/deal/{dealId}"},"summary":"Detach a deal from a task","description":"Detach a deal from a task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/task-to-task/{taskHeadId}/task/{taskId}":{"delete":{"tags":["CRM Task Entity"],"parameters":[{"name":"taskHeadId","in":"path","description":"Parent task ID","required":true,"schema":{"type":"number","example":""}},{"name":"taskId","in":"path","description":"Child task ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/task-to-task/{taskHeadId}/task/{taskId}"},"summary":"Detach task from another task","description":"Detach task from another task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/tasks/{taskId}/entity-attach":{"post":{"tags":["CRM Task Entity"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/entity-attach"},"summary":"Attach entity to task","description":"Attach entity to task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"connections":{"type":"object","description":"Connections","properties":{"dealIds":{"type":"array","description":"Dealids"},"contactIds":{"type":"array","description":"Contactids"},"taskIds":{"type":"array","description":"Taskids"},"subTasksIds":{"type":"array","description":"Subtasksids"}}}}},"example":{"connections":{}}}}}}},"/crm/v1/tasks/{taskId}/checklists/single":{"post":{"tags":["CRM Task Checklist"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/checklists/single"},"summary":"Create checklist without items in task","description":"Create checklist without items in task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Checklist name"}}},"example":{"name":""}}}}}},"/crm/v1/tasks/{taskId}/checklists/{checklistId}/single":{"put":{"tags":["CRM Task Checklist"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}},{"name":"checklistId","in":"path","description":"checklistId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/checklists/{checklistId}/single"},"summary":"Update checklist without items in task","description":"Update checklist without items in task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Checklist name"}}},"example":{"name":""}}}}}},"/crm/v1/tasks/{taskId}/checklists":{"get":{"tags":["CRM Task Checklist"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/checklists"},"summary":"Get checklist list by task","description":"Get checklist list by task","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Task Checklist"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/checklists"},"summary":"Create multiple checklists with items in task","description":"Create multiple checklists with items in task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"checklists":{"type":"array","description":"Checklists","items":{"type":"object","properties":{"name":{"type":"string","description":"Checklist name"},"items":{"type":"array","description":"Items"}}}}}},"example":{"checklists":[]}}}}},"put":{"tags":["CRM Task Checklist"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/checklists"},"summary":"Update multiple checklists with items in task","description":"Update multiple checklists with items in task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"checklists":{"type":"array","description":"Checklists","items":{"type":"object","properties":{"id":{"type":"number","description":"Id"},"name":{"type":"string","description":"Checklist name"},"items":{"type":"array","description":"Items"}}}}}},"example":{"checklists":[]}}}}}},"/crm/v1/tasks/{taskId}/checklists/{checklistId}":{"delete":{"tags":["CRM Task Checklist"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}},{"name":"checklistId","in":"path","description":"checklistId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/checklists/{checklistId}"},"summary":"Delete a checklist from a task","description":"Delete a checklist from a task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/checklists/{checklistId}/items":{"post":{"tags":["CRM Checklist Items"],"parameters":[{"name":"checklistId","in":"path","description":"checklistId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/checklists/{checklistId}/items"},"summary":"Create items for checklist","description":"Create items for checklist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Checklist item name"},"isDone":{"type":"number","description":"Is checklist item done (checked). 0 - no, 1 - yes"}}},"example":{"name":"","isDone":""}}}}}},"/crm/v1/checklists/{checklistId}/items/{itemId}":{"post":{"tags":["CRM Checklist Items"],"parameters":[{"name":"checklistId","in":"path","description":"checklistId","required":true,"schema":{"type":"number","example":""}},{"name":"itemId","in":"path","description":"itemId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/checklists/{checklistId}/items/{itemId}"},"summary":"Change order of item in checklist","description":"Change order of item in checklist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"order":{"type":"number","description":"Order"}}},"example":{"order":""}}}}},"put":{"tags":["CRM Checklist Items"],"parameters":[{"name":"checklistId","in":"path","description":"checklistId","required":true,"schema":{"type":"number","example":""}},{"name":"itemId","in":"path","description":"itemId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/checklists/{checklistId}/items/{itemId}"},"summary":"Update checklist item","description":"Update checklist item","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Checklist item name"},"isDone":{"type":"number","description":"Is checklist item done (checked). 0 - no, 1 - yes"}}},"example":{"name":"","isDone":""}}}}},"delete":{"tags":["CRM Checklist Items"],"parameters":[{"name":"checklistId","in":"path","description":"checklistId","required":true,"schema":{"type":"number","example":""}},{"name":"itemId","in":"path","description":"itemId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/checklists/{checklistId}/items/{itemId}"},"summary":"Delete checklist items","description":"Delete checklist items","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/tasks/{taskId}/attributes":{"post":{"tags":["CRM Task Attributes"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/attributes"},"summary":"Create attribute value","description":"Create attribute value","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attributeId":{"type":"number","description":"ID of attribute"},"value":{"type":"string","description":"Attribute value (string or array)"}}},"example":{"attributeId":"","value":""}}}}}},"/crm/v1/{boardId}/attributes/{attributeId}/values/{valueId}":{"put":{"tags":["CRM Task Attributes"],"parameters":[{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}},{"name":"valueId","in":"path","description":"valueId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/{boardId}/attributes/{attributeId}/values/{valueId}"},"summary":"Update task attribute value","description":"Update task attribute value","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"value":{"type":"string","description":"Attribute value (string or array)"}}},"example":{"value":""}}}}},"delete":{"tags":["CRM Task Attributes"],"parameters":[{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}},{"name":"valueId","in":"path","description":"valueId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/{boardId}/attributes/{attributeId}/values/{valueId}"},"summary":"Delete attribute value from task","description":"Delete attribute value from task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/telephony/calls/get-list":{"post":{"tags":["CRM Telephony"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/telephony/calls/get-list"},"summary":"Get calls","description":"Get calls","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/get-calls":{"post":{"tags":["CRM Telephony"],"parameters":[{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/get-calls"},"summary":"Get calls by contact\"","description":"Get calls by contact\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals/{dealId}/get-calls":{"post":{"tags":["CRM Telephony"],"parameters":[{"name":"dealId","in":"path","description":"dealId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/get-calls"},"summary":"Get calls by deal","description":"Get calls by deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals/{dealId}/attach-call":{"post":{"tags":["CRM Telephony"],"parameters":[{"name":"dealId","in":"path","description":"dealId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/attach-call"},"summary":"Attach call to deal","description":"Attach call to deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callId":{"type":"number","description":"Callid"}}},"example":{"callId":""}}}}}},"/crm/v1/deals/{dealId}/expiration":{"put":{"tags":["CRM Deal Expiration"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/expiration"},"summary":"Update or create deal expiration","description":"Update or create deal expiration","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"date":{"type":"string","description":"Expiration date (format: date)"},"time":{"type":"string","description":"Expiration time (format: time)"},"notifyIn":{"type":"string","description":"Notify before deal expires (when notification is enabled). Allowed values - 0(not selected), 15min, 30min, 1h, 2h, 3h, 6h, 12h, 24h, 2d, 3d, 4d, 5d, 6d, 7d"},"dealAction":{"type":"number","description":"Allowed values 1 - created, 2 - updated"}}},"example":{"date":"","time":"","notifyIn":"","dealAction":""}}}}},"delete":{"tags":["CRM Deal Expiration"],"parameters":[{"name":"dealId","in":"path","description":"Deal ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/expiration"},"summary":"Remove deal expiration","description":"Remove deal expiration","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/{contactId}/edu-payments":{"get":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/edu-payments"},"summary":"Get EDU payments by contact","description":"Get EDU payments by contact","security":[{"bearerAuth":[]}]}},"/crm/v1/contacts/{contactId}/edu-statistic":{"get":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/edu-statistic"},"summary":"Get EDU statistics for a contact","description":"Get EDU statistics for a contact","security":[{"bearerAuth":[]}]}},"/crm/v1/files/upload":{"post":{"tags":["CRM File Manager"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/files/upload"},"summary":"Upload files","description":"Upload files","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"files[]":{"type":"array","description":"Array of file binaries","items":{"type":"string"}}}},"example":{"files[]":[]}}}}}},"/crm/v1/attachments":{"post":{"tags":["CRM Attachments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/attachments"},"summary":"Attach file","description":"First, the file must be uploaded to the file manager, and then the file can be attached.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/attachments/batch":{"post":{"tags":["CRM Attachments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/attachments/batch"},"summary":"Create attachment","description":"First, the file must be uploaded to the file manager, and then the file can be attached.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attachments":{"type":"array","description":"Attachments","items":{"type":"object","properties":{"link":{"type":"string","description":"Link"},"entityId":{"type":"number","description":"Entityid"},"entityType":{"type":"string","description":"Entitytype","enum":["deal","task","contact","dealComment","taskComment","contactComment"]}}}}}},"example":{"attachments":[]}}}}}},"/crm/v1/attachments/{attachmentId}":{"put":{"tags":["CRM Attachments"],"parameters":[{"name":"attachmentId","in":"path","description":"attachmentId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/attachments/{attachmentId}"},"summary":"Update file attachment","description":"First, the file must be uploaded to the file manager, and then the file can be attached.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["CRM Attachments"],"parameters":[{"name":"attachmentId","in":"path","description":"attachmentId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/attachments/{attachmentId}"},"summary":"Delete file attachment","description":"Delete file attachment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/companies/short-data":{"post":{"tags":["CRM Company"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/short-data"},"summary":"Get companies short data","description":"Get companies short data","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"companyName":{"type":"string","description":"Companyname"},"companyIds":{"type":"array","description":"Companyids","items":{"type":"string"}},"email":{"type":"string","description":"Email"},"phone":{"type":"string","description":"Phone"},"responsibleId":{"type":"array","description":"Responsibleid","items":{"type":"string"}},"messengerLogin":{"type":"string","description":"Messengerlogin"},"dateFrom":{"type":"string","description":"Datefrom"},"dateTo":{"type":"string","description":"Dateto"},"limit":{"type":"number","description":"Limit"},"offset":{"type":"number","description":"Offset"},"withoutContacts":{"type":"boolean","description":"Withoutcontacts","enum":[true,false]},"searchString":{"type":"string","description":"If you pass a search string, all other filters will be ignored."},"attributes":{"type":"array","description":"Attributes","items":{"type":"object","properties":{"id":{"type":"number","description":"Id"},"expression":{"type":"string","description":"Expression"}}}},"sortBy":{"type":"object","description":"Sortby","properties":{"attributeId":{"type":"number","description":"Attributeid"},"fieldName":{"type":"string","description":"Fieldname","enum":["name","address","annualBusinessVolume","createdAt"]},"direction":{"type":"string","description":"Direction","enum":["asc","desc"]}}}}},"example":{"companyName":"","companyIds":[],"email":"","phone":"","responsibleId":[],"messengerLogin":"","dateFrom":"","dateTo":"","limit":"","offset":"","withoutContacts":"","searchString":"","attributes":[],"sortBy":{}}}}}}},"/crm/v1/companies/list":{"post":{"tags":["CRM Company"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/list"},"summary":"Get companies","description":"Get companies","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"companyName":{"type":"string","description":"Companyname"},"companyIds":{"type":"array","description":"Companyids","items":{"type":"string"}},"email":{"type":"string","description":"Email"},"phone":{"type":"string","description":"Phone"},"responsibleId":{"type":"array","description":"Responsibleid","items":{"type":"string"}},"messengerLogin":{"type":"string","description":"Messengerlogin"},"dateFrom":{"type":"string","description":"Datefrom"},"dateTo":{"type":"string","description":"Dateto"},"limit":{"type":"number","description":"Limit"},"offset":{"type":"number","description":"Offset"},"withoutContacts":{"type":"boolean","description":"Withoutcontacts","enum":[true,false]},"searchString":{"type":"string","description":"If you pass a search string, all other filters will be ignored."},"attributes":{"type":"array","description":"Attributes","items":{"type":"object","properties":{"id":{"type":"number","description":"Id"},"expression":{"type":"string","description":"Expression"}}}},"sortBy":{"type":"object","description":"Sortby","properties":{"attributeId":{"type":"number","description":"Attributeid"},"fieldName":{"type":"string","description":"Fieldname","enum":["name","address","annualBusinessVolume","createdAt"]},"direction":{"type":"string","description":"Direction","enum":["asc","desc"]}}}}},"example":{"companyName":"","companyIds":[],"email":"","phone":"","responsibleId":[],"messengerLogin":"","dateFrom":"","dateTo":"","limit":"","offset":"","withoutContacts":"","searchString":"","attributes":[],"sortBy":{}}}}}}},"/crm/v1/companies":{"post":{"tags":["CRM Company"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies"},"summary":"Create company","description":"Create company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"companyName":{"type":"string","description":"Companyname"},"responsibleId":{"type":"number","description":"If you do not send the responsible ID, the system will automatically identify the responsible person."},"address":{"type":"string","description":"Address"},"annualBusinessVolume":{"type":"number","description":"Annualbusinessvolume"},"currency":{"type":"string","description":"The parameter is required if you send a annualBusinessVolume parameter"}}},"example":{"companyName":"","responsibleId":"","address":"","annualBusinessVolume":"","currency":""}}}}}},"/crm/v1/companies/{companyId}":{"get":{"tags":["CRM Company"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}"},"summary":"Get company by id","description":"Get company by id","security":[{"bearerAuth":[]}]},"put":{"tags":["CRM Company"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}"},"summary":"Update company","description":"Update company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"companyName":{"type":"string","description":"Companyname"},"responsibleId":{"type":"number","description":"Responsibleid"},"annualBusinessVolume":{"type":"number","description":"Annualbusinessvolume"},"currency":{"type":"string","description":"Currency"}}},"example":{"companyName":"","responsibleId":"","annualBusinessVolume":"","currency":""}}}}},"delete":{"tags":["CRM Company"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}"},"summary":"Delete company","description":"Delete company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/companies/{companyId}/history":{"get":{"tags":["CRM Company History"],"parameters":[{"name":"dateFrom","in":"query","description":"(format: date-time)","required":false,"schema":{"type":"string","example":""}},{"name":"dateTo","in":"query","description":"(format: date-time)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/history"},"summary":"get Company history","description":"get Company history","security":[{"bearerAuth":[]}]}},"/crm/v1/companies/attributes":{"get":{"tags":["CRM Company Attributes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/attributes"},"summary":"Get company attributes list","description":"Get company attributes list","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Company Attributes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/attributes"},"summary":"Create a company attribute","description":"Create a company attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"type":{"type":"number","description":"0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect"},"mandatory":{"type":"boolean","description":"Mandatory","enum":[true,false]},"options":{"type":"array","description":"Options","items":{"type":"string"}}}},"example":{"name":"","type":"","mandatory":"","options":[]}}}}}},"/crm/v1/companies/attributes/{attribute}":{"put":{"tags":["CRM Company Attributes"],"parameters":[{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/attributes/{attribute}"},"summary":"Update a company attribute","description":"Update a company attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name","required":true},"status":{"type":"number","description":"0 = Inactive, 1 = Active, 2 = Hidden"},"type":{"type":"number","description":"0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect"},"mandatory":{"type":"boolean","description":"Mandatory","enum":[true,false]},"order":{"type":"number","description":"Order","required":true},"options":{"type":"array","description":"Options","items":{"type":"string"}}}},"example":{"name":"","status":"","type":"","mandatory":"","order":"","options":[]}}}}},"delete":{"tags":["CRM Company Attributes"],"parameters":[{"name":"attributeId","in":"path","description":"attributeId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/attributes/{attribute}"},"summary":"Delete a company attribute","description":"Delete a company attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/companies/{companyId}/emails":{"get":{"tags":["CRM Emails"],"parameters":[{"name":"entityType","in":"path","description":"entityType","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["company"]}}},{"name":"entityId","in":"path","description":"entityId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/emails"},"summary":"Get emails","description":"Get emails","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Emails"],"parameters":[{"name":"entityType","in":"path","description":"entityType","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["company"]}}},{"name":"entityId","in":"path","description":"entityId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/emails"},"summary":"Create email","description":"Create email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Data","properties":{"isMain":{"type":"boolean","description":"Ismain","enum":[true,false]},"email":{"type":"string","description":"Email"}}}}},"example":{"data":{}}}}}}},"/crm/v1/companies/{companyId}/emails/batch":{"post":{"tags":["CRM Emails"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/emails/batch"},"summary":"Batch create email","description":"Batch create email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","items":{"type":"object","properties":{"email":{"type":"string","description":"Email"},"isMain":{"type":"boolean","description":"Ismain","enum":[true,false]}}}}}},"example":{"emails":[]}}}}}},"/crm/v1/companies/{companyId}/emails/{emailId}":{"put":{"tags":["CRM Emails"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}},{"name":"emailId","in":"path","description":"emailId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/emails/{emailId}"},"summary":"Update email","description":"Update email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Data","properties":{"isMain":{"type":"boolean","description":"Ismain","enum":[true,false]},"email":{"type":"string","description":"Email"}}}}},"example":{"data":{}}}}}},"delete":{"tags":["CRM Emails"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}},{"name":"emailId","in":"path","description":"emailId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/emails/{emailId}"},"summary":"Delete email","description":"Delete email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/companies/{companyId}/phones":{"get":{"tags":["CRM Phones"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/phones"},"summary":"Get phones","description":"Get phones","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Phones"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/phones"},"summary":"Create phone","description":"Create phone","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Data","properties":{"typeId":{"type":"number","description":"Typeid"},"login":{"type":"string","description":"Login"}}}}},"example":{"data":{}}}}}}},"/crm/v1/companies/{companyId}/phones/batch":{"post":{"tags":["CRM Phones"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/phones/batch"},"summary":"Batch create phone","description":"Batch create phone","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phones":{"type":"array","description":"Phones","items":{"type":"object","properties":{"phone":{"type":"string","description":"Phone"},"isMain":{"type":"boolean","description":"Ismain","enum":[true,false]}}}}}},"example":{"phones":[]}}}}}},"/crm/v1/companies/{companyId}/phones/{phoneId}":{"put":{"tags":["CRM Phones"],"parameters":[{"name":"entityType","in":"path","description":"entityType","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["company"]}}},{"name":"entityId","in":"path","description":"entityId","required":true,"schema":{"type":"number","example":""}},{"name":"phoneId","in":"path","description":"phoneId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/phones/{phoneId}"},"summary":"Update phone","description":"Update phone","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Data","properties":{"isMain":{"type":"boolean","description":"Ismain","enum":[true,false]},"phone":{"type":"string","description":"Phone"}}}}},"example":{"data":{}}}}}},"delete":{"tags":["CRM Phones"],"parameters":[{"name":"entityType","in":"path","description":"entityType","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["company"]}}},{"name":"entityId","in":"path","description":"entityId","required":true,"schema":{"type":"number","example":""}},{"name":"phoneId","in":"path","description":"phoneId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/phones/{phoneId}"},"summary":"Delete phone","description":"Delete phone","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/companies/{companyId}/messengers":{"get":{"tags":["CRM Messengers"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/messengers"},"summary":"Get messengers","description":"Get messengers","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Messengers"],"parameters":[{"name":"entityType","in":"path","description":"entityType","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["company"]}}},{"name":"entityId","in":"path","description":"entityId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/messengers"},"summary":"Create messenger","description":"Create messenger","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Data","properties":{"typeId":{"type":"number","description":"Typeid"},"login":{"type":"string","description":"Login"}}}}},"example":{"data":{}}}}}}},"/crm/v1/companies/{companyId}/messengers/batch":{"post":{"tags":["CRM Messengers"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/messengers/batch"},"summary":"Batch create messenger","description":"Batch create messenger","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"messengers":{"type":"array","description":"Messengers","items":{"type":"object","properties":{"typeId":{"type":"number","description":"Typeid"},"login":{"type":"string","description":"Login"},"botId":{"type":"string","description":"Botid"}}}}}},"example":{"messengers":[]}}}}}},"/crm/v1/companies/{companyId}/messengers/{messengerId}":{"put":{"tags":["CRM Messengers"],"parameters":[{"name":"entityType","in":"path","description":"entityType","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["company"]}}},{"name":"entityId","in":"path","description":"entityId","required":true,"schema":{"type":"number","example":""}},{"name":"messengerId","in":"path","description":"messengerId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/messengers/{messengerId}"},"summary":"Update messenger","description":"Update messenger","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Data","properties":{"typeId":{"type":"number","description":"Typeid"},"login":{"type":"string","description":"Login"}}}}},"example":{"data":{}}}}}},"delete":{"tags":["CRM Messengers"],"parameters":[{"name":"entityType","in":"path","description":"entityType","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["company"]}}},{"name":"entityId","in":"path","description":"entityId","required":true,"schema":{"type":"number","example":""}},{"name":"messengerId","in":"path","description":"messengerId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/companies/{companyId}/messengers/{messengerId}"},"summary":"Delete messenger","description":"Delete messenger","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/deals/{dealId}/history":{"get":{"tags":["CRM Deal History"],"parameters":[{"name":"dealId","in":"path","description":"dealId","required":true,"schema":{"type":"number","example":""}},{"name":"fromDate","in":"query","description":"(format: date-time)","required":true,"schema":{"type":"string","example":""}},{"name":"toDate","in":"query","description":"(format: date-time)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/deals/{dealId}/history"},"summary":"Deal history","description":"Get deal history by ID within a date range.","security":[{"bearerAuth":[]}]}},"/crm/v1/contacts/{contactId}/history":{"get":{"tags":["CRM Contact History"],"parameters":[{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}},{"name":"fromDate","in":"query","description":"(format: date-time)","required":true,"schema":{"type":"string","example":""}},{"name":"toDate","in":"query","description":"(format: date-time)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/history"},"summary":"Contact history","description":"Get contact history by ID within a date range.","security":[{"bearerAuth":[]}]}},"/crm/v1/tasks/{taskId}/history":{"get":{"tags":["CRM Task History"],"parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"number","example":""}},{"name":"fromDate","in":"query","description":"(format: date-time)","required":true,"schema":{"type":"string","example":""}},{"name":"toDate","in":"query","description":"(format: date-time)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/tasks/{taskId}/history"},"summary":"Get task history","description":"Get task history by ID within a date range.","security":[{"bearerAuth":[]}]}},"/crm/v1/products/all":{"post":{"tags":["CRM Ecommerce Product"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/all"},"summary":"Get products by filter","description":"Get products by filter","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"categoryId":{"type":"number","description":"Category ID to filter products."},"dateFrom":{"type":"string","description":"Start date for filtering (format: YYYY-MM-DD)."},"dateTo":{"type":"string","description":"End date for filtering (format: YYYY-MM-DD)."},"search":{"type":"string","description":"Text search by product name or code."},"balance":{"type":"object","description":"Filter by product stock balance and unit type.","properties":{"expression":{"type":"string","description":"Comparison operator for balance.","enum":["=",">=","<="]},"type":{"type":"number","description":"Unit type of the product balance.","enum":[1,2,3,4,5,6,7]},"value":{"type":"number","description":"Stock quantity value to compare."}}},"description":{"type":"string","description":"Description for products"},"purchases":{"type":"object","description":"Filter by number of purchases.","properties":{"expression":{"type":"string","description":"Comparison operator for purchases.","enum":["=",">=","<="]},"value":{"type":"number","description":"Number of purchases to compare."}}},"price":{"type":"object","description":"Filter by product price or old price.","properties":{"expression":{"type":"string","description":"Comparison operator for price.","enum":["=",">=","<="]},"currency":{"type":"string","description":"Currency of the price (e.g., USD, EUR)."},"value":{"type":"number","description":"Current price value."},"oldValue":{"type":"number","description":"Previous price value."}}},"visible":{"type":"number","description":"Product visibility status (0 = hidden, 1 = visible).","enum":[0,1]},"typeProduct":{"type":"number","description":"Product type (1 = physical, 2 = digital/service).","enum":[1,2]},"limit":{"type":"number","description":"Maximum number of results to return."},"offset":{"type":"number","description":"Offset for pagination."},"orderBy":{"type":"object","description":"Sorting options.","properties":{"fieldName":{"type":"string","description":"Field to sort by.","enum":["id","balance","price"]},"direction":{"type":"string","description":"Sorting direction (asc or desc).","enum":["asc","desc"]}}},"sections":{"type":"array","description":"Filter by section-specific key-value attributes.","items":{"type":"string"}},"categoryIds":{"type":"array","description":"List of category IDs to include in filter.","items":{"type":"number"}}}},"example":{"categoryId":"","dateFrom":"","dateTo":"","search":"","balance":{},"description":"","purchases":{},"price":{},"visible":"","typeProduct":"","limit":"","offset":"","orderBy":{},"sections":[],"categoryIds":[]}}}}}},"/crm/v1/products/categories/{categoryId}/{productId}":{"get":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"productId","required":true,"schema":{"type":"number","example":""}},{"name":"categoryId","in":"path","description":"categoryId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/categories/{categoryId}/{productId}"},"summary":"Get products by id","description":"Get products by id","security":[{"bearerAuth":[]}]}},"/crm/v1/products/deals":{"post":{"tags":["CRM Ecommerce Product"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/deals"},"summary":"Add product to deal","description":"Add product to deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"productId":{"type":"number","description":"Productid"},"dealId":{"type":"number","description":"Dealid"},"productPriceISO":{"type":"string","description":"Productpriceiso"},"productPriceValue":{"type":"number","description":"Productpricevalue"},"quantity":{"type":"number","description":"Quantity"},"allow_out_of_stock":{"type":"boolean","description":"When true the product is attached even if stock is zero and inventory is not decremented","enum":[true,false]}}},"example":{"productId":"","dealId":"","productPriceISO":"","productPriceValue":"","quantity":"","allow_out_of_stock":""}}}}}},"/crm/v1/products/deals/{dealId}":{"get":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"dealId","in":"path","description":"dealId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/deals/{dealId}"},"summary":"Get products by deal id","description":"Get products by deal id","security":[{"bearerAuth":[]}]}},"/crm/v1/products/deals/{headId}":{"put":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"headId","in":"path","description":"headId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/deals/{headId}"},"summary":"Update quantity or amount products in deal","description":"Update quantity or amount products in deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"quantity":{"type":"number","description":"Product quantity in the deal"},"amount":{"type":"number","description":"Product amount in the deal"}}},"example":{"quantity":"","amount":""}}}}}},"/crm/v1/products/contacts/{contactId}/deals":{"get":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"contactId","in":"path","description":"contactId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/contacts/{contactId}/deals"},"summary":"Get products by contact id","description":"Get products by contact id","security":[{"bearerAuth":[]}]}},"/crm/v1/products/categories/{categoryId}/{productId}/deals/{headId}":{"delete":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"categoryId","in":"path","description":"categoryId","required":true,"schema":{"type":"number","example":""}},{"name":"productId","in":"path","description":"productId","required":true,"schema":{"type":"number","example":""}},{"name":"headId","in":"path","description":"headId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/categories/{categoryId}/{productId}/deals/{headId}"},"summary":"Detach products from deal","description":"Detach products from deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/products/{productId}":{"get":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"productId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/{productId}"},"summary":"Get products by id (CRM Ecommerce Product)","description":"Get products by id","security":[{"bearerAuth":[]}]},"put":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"ID of the product to update","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/{productId}"},"summary":"Update product by id","description":"Update product by id","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Product name"},"description":{"type":"string","description":"Full product description"},"shortDescription":{"type":"string","description":"Short product summary"},"images":{"type":"array","description":"Array of product image URLs","items":{"type":"string"}},"vendorCode":{"type":"string","description":"Vendor or manufacturer code"},"categoryId":{"type":"number","description":"Category ID the product belongs to"},"balance":{"type":"object","description":"Stock balance information","properties":{"type":{"type":"number","description":"Balance type (e.g. available, reserved)"},"value":{"type":"number","description":"Balance quantity"}}},"availability":{"type":"number","description":"Product availability status"},"visible":{"type":"number","description":"Visibility flag (0 - hidden, 1 - visible)"},"seo":{"type":"object","description":"SEO-related metadata","properties":{"name":{"type":"string","description":"SEO title"},"description":{"type":"string","description":"SEO description"},"keys":{"type":"string","description":"SEO keywords"}}},"digitalInfo":{"type":"object","description":"Digital product details","properties":{"productLink":{"type":"string","description":"Direct link to digital product"},"productLinkPreview":{"type":"string","description":"Link to preview of digital product"},"isProductLinkExternal":{"type":"boolean","description":"Is product link external","enum":[true,false]},"isProductLinkPreviewExternal":{"type":"boolean","description":"Is preview link external","enum":[true,false]}}}}},"example":{"name":"","description":"","shortDescription":"","images":[],"vendorCode":"","categoryId":"","balance":{},"availability":"","visible":"","seo":{},"digitalInfo":{}}}}}},"delete":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"ID of the product to delete","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/{productId}"},"summary":"Delete product by id","description":"Delete product by id","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/products/categories/{categoryId}":{"put":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"categoryId","in":"path","description":"categoryId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/categories/{categoryId}"},"summary":"Update users category by id","description":"Update users category by id","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"parentId":{"type":"number","description":"Parentid"},"name":{"type":"string","description":"Name"}}},"example":{"parentId":"","name":""}}}}},"delete":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"categoryId","in":"path","description":"categoryId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/categories/{categoryId}"},"summary":"Delete users category by id","description":"Delete users category by id","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/external/{externalContactId}":{"get":{"tags":["CRM Contacts"],"parameters":[{"name":"externalContactId","in":"path","description":"External contact id from another source system","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/external/{externalContactId}"},"summary":"Get contact exists by external contact Id","description":"Get contact exists by external contact Id","security":[{"bearerAuth":[]}]}},"/crm/v1/products/categories":{"get":{"tags":["CRM Ecommerce Product"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/categories"},"summary":"Get users categories","description":"Get users categories","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Ecommerce Product"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/categories"},"summary":"Store users categories","description":"Store users categories","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"parentId":{"type":"number","description":"ID of parent category. Null for root."},"name":{"type":"string","description":"Name of the category"},"sections":{"type":"array","description":"Sections belonging to the category","items":{"type":"string"}}}},"example":{"parentId":"","name":"","sections":[]}}}}}},"/crm/v1/products/{productId}/prices":{"put":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"ID of the product to update prices for","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/{productId}/prices"},"summary":"Update price in product","description":"Update price in product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"prices":{"type":"array","description":"List of prices for the product","items":{"type":"string"}}}},"example":{"prices":[]}}}}}},"/crm/v1/products/{productId}/sections":{"post":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"ID of the product to update sections for","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/{productId}/sections"},"summary":"Update section in product","description":"Update section in product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sections":{"type":"array","description":"List of sections to update","items":{"type":"string"}}}},"example":{"sections":[]}}}}},"put":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"ID of the product to update sections for","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/{productId}/sections"},"summary":"Update section in product (CRM Ecommerce Product)","description":"Update section in product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sections":{"type":"array","description":"List of sections to update","items":{"type":"string"}}}},"example":{"sections":[]}}}}}},"/crm/v1/products/{productId}/sections/{sectionId}":{"delete":{"tags":["CRM Ecommerce Product"],"parameters":[{"name":"productId","in":"path","description":"ID of the product to delete sections from","required":true,"schema":{"type":"number","example":""}},{"name":"sectionId","in":"path","description":"ID of the section to delete","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products/{productId}/sections/{sectionId}"},"summary":"Delete products section","description":"Delete products section","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/contacts/messenger-external/{messengerContactId}":{"get":{"tags":["CRM Contacts"],"parameters":[{"name":"messengerContactId","in":"path","description":"External contact id from messenger","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/messenger-external/{messengerContactId}"},"summary":"Get contact by messenger contact id","description":"Get contact by messenger contact id","security":[{"bearerAuth":[]}]}},"/crm/v1/contacts/{contactId}/relation/{companyId}":{"post":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID you want to add to the company. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"companyId","in":"path","description":"Company ID you want to add to the contact. It can be obtained with the \"Get a list of company\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/relation/{companyId}"},"summary":"Add contact to a company","description":"Add contact to a company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["CRM Contacts"],"parameters":[{"name":"contactId","in":"path","description":"Contact ID you want to delete from the company. It can be obtained with the \"Get a list of contacts\" method","required":true,"schema":{"type":"number","example":""}},{"name":"companyId","in":"path","description":"Company ID you want to delete from the contact. It can be obtained with the \"Get a list of company\" method","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/contacts/{contactId}/relation/{companyId}"},"summary":"Delete a contact from the company","description":"Delete a contact from the company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/manager-settings/sections":{"get":{"tags":["CRM Managersettings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/manager-settings/sections"},"summary":"Get all sections","description":"Get all sections","security":[{"bearerAuth":[]}]}},"/crm/v1/manager-settings/managers":{"get":{"tags":["CRM Managersettings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/manager-settings/managers"},"summary":"Get all managers","description":"Get all managers","security":[{"bearerAuth":[]}]}},"/crm/v1/manager-settings":{"post":{"tags":["CRM Managersettings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/manager-settings"},"summary":"Create managers from category","description":"Create managers from category","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sectionId":{"type":"number","description":"Sectionid"},"responsibleIds":{"type":"array","description":"Responsibleids","items":{"type":"number"}}}},"example":{"sectionId":"","responsibleIds":[]}}}}}},"/crm/v1/manager-settings/{settingId}":{"put":{"tags":["CRM Managersettings"],"parameters":[{"name":"settingId","in":"path","description":"settingId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/manager-settings/{settingId}"},"summary":"Update managers from category","description":"Update managers from category","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sectionId":{"type":"number","description":"Sectionid"},"responsibleIds":{"type":"array","description":"Responsibleids","items":{"type":"number"}}}},"example":{"sectionId":"","responsibleIds":[]}}}}},"delete":{"tags":["CRM Managersettings"],"parameters":[{"name":"settingId","in":"path","description":"settingId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/manager-settings/{settingId}"},"summary":"Delete managers from category","description":"Delete managers from category","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"responsibleIds":{"type":"array","description":"Responsibleids","items":{"type":"number"}}}},"example":{"responsibleIds":[]}}}}}},"/crm/v1/manager-settings/{sectionId}":{"get":{"tags":["CRM Managersettings"],"parameters":[{"name":"sectionId","in":"path","description":"sectionId","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/manager-settings/{sectionId}"},"summary":"Get managers by section","description":"Get managers by section","security":[{"bearerAuth":[]}]}},"/crm/v1/custom-tab":{"get":{"tags":["CRM Custom Tab"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/custom-tab"},"summary":"Get all users custom tabs","description":"Get all users custom tabs","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Custom Tab"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/custom-tab"},"summary":"Create custom tab","description":"Create custom tab","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name of custom tab"},"entityType":{"type":"number","description":"0 - contact, 1 - pipeline, 2 - board, 3 - company","enum":[0,1,2,3]},"entityId":{"type":"number","description":"Related entity ID. Only for pipelines and boards"}}},"example":{"name":"","entityType":"","entityId":""}}}}}},"/crm/v1/custom-tab/{customTabId}":{"put":{"tags":["CRM Custom Tab"],"parameters":[{"name":"customTabId","in":"path","description":"Custom tab ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/custom-tab/{customTabId}"},"summary":"Update custom tabs","description":"Update custom tabs","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"order":{"type":"number","description":"Custom tab order"},"name":{"type":"string","description":"Custom tab name"},"isVisible":{"type":"boolean","description":"Indicates whether the entity is visible to users","enum":[true,false]},"entityType":{"type":"number","description":"0 - contact, 1 - pipeline, 2 - board, 3 - company","enum":[0,1,2,3]},"entityId":{"type":"number","description":"Related entity ID. Only for pipelines and boards"}}},"example":{"order":"","name":"","isVisible":"","entityType":"","entityId":""}}}}},"delete":{"tags":["CRM Custom Tab"],"parameters":[{"name":"customTabId","in":"path","description":"Custom tab ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/custom-tab/{customTabId}"},"summary":"Delete custom tabs","description":"Delete custom tabs","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"entityType":{"type":"number","description":"0 - contact, 1 - pipeline, 2 - board, 3 - company","enum":[0,1,2,3]},"entityId":{"type":"number","description":"Related entity ID. Only for pipelines and boards"}}},"example":{"entityType":"","entityId":""}}}}}},"/crm/v1/custom-tab/{customTabId}/relation":{"post":{"tags":["CRM Custom Tab"],"parameters":[{"name":"customTabId","in":"path","description":"Custom tab ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/custom-tab/{customTabId}/relation"},"summary":"Add new relation with attribute","description":"Add new relation with attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"entityType":{"type":"number","description":"0 - contact, 1 - pipeline, 2 - board, 3 - company","enum":[0,1,2,3]},"entityId":{"type":"number","description":"Related entity ID. Only for pipelines and boards"},"entityIds":{"type":"array","description":"Related attributes IDs.","items":{"type":"number"}}}},"example":{"entityType":"","entityId":"","entityIds":[]}}}}},"delete":{"tags":["CRM Custom Tab"],"parameters":[{"name":"customTabId","in":"path","description":"Custom tab ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/custom-tab/{customTabId}/relation"},"summary":"Delete relation with attribute","description":"Delete relation with attribute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"entityType":{"type":"number","description":"0 - contact, 1 - pipeline, 2 - board, 3 - company","enum":[0,1,2,3]},"entityId":{"type":"number","description":"Related entity ID. Only for pipelines and boards"},"entityIds":{"type":"array","description":"Related attributes IDs.","items":{"type":"number"}}}},"example":{"entityType":"","entityId":"","entityIds":[]}}}}}},"/crm/v1/products":{"post":{"tags":["CRM Ecommerce Product"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/products"},"summary":"Create a new product","description":"Create a new product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Product name. Max length 255"},"description":{"type":"string","description":"Product description. Max length 10000"},"shortDescription":{"type":"string","description":"Product short description. Max length 10000"},"images":{"type":"array","description":"Product images. Path from File manager service","items":{"type":"string"}},"vendorCode":{"type":"string","description":"Product vendor code. Max length 255"},"type":{"type":"number","description":"Product type . 1 - product, 2 - service, 3 - subscription (expected soon)"},"productType":{"type":"number","description":"Product type. 1 - physical, 2 - digital","enum":[1,2,3]},"categoryId":{"type":"number","description":"Category ID. It can be obtained with the \"Get users categories\" method"},"balance":{"type":"object","description":"Product balance.","properties":{"type":{"type":"number","description":"Product balance type. 1 - piece, 2 - service, 3 - meter, 4 - set, 5 - liter, 6 - kilogram, 7 - package"},"value":{"type":"number","description":"Product balance value. Max 11 digits"},"oldValue":{"type":"number","description":"Product balance value. Max 11 digits"}}},"availability":{"type":"number","description":"Product availability. 1 - available, 2 - unavailable, 3 - expecting","enum":[1,2,3]},"visible":{"type":"number","description":"Product visibility. 0 - not visible, 1 - visible","enum":[0,1]},"digitalInfo":{"type":"object","description":"Product digital info.","properties":{"productLink":{"type":"string","description":"Product link. Max length 255. Path from File manager service"},"productLinkPreview":{"type":"string","description":"Product link preview. Max length 255. Path from File manager service"},"isProductLinkExternal":{"type":"boolean","description":"Flag which indicates whether the product link is external.","enum":[true,false]},"isProductLinkPreviewExternal":{"type":"boolean","description":"Flag which indicates whether the product link preview is external.","enum":[true,false]}}},"seo":{"type":"object","description":"Product SEO info.","properties":{"name":{"type":"string","description":"Product name. Max length 255"},"description":{"type":"string","description":"Product description. Max length 255"},"keys":{"type":"string","description":"Product keys. Max length 255"}}},"prices":{"type":"array","description":"Prices","items":{"type":"string"}},"sections":{"type":"array","description":"Product sections.","items":{"type":"string"}}}},"example":{"name":"","description":"","shortDescription":"","images":[],"vendorCode":"","type":"","productType":"","categoryId":"","balance":{},"availability":"","visible":"","digitalInfo":{},"seo":{},"prices":[],"sections":[]}}}}}},"/crm/v1/payments":{"post":{"tags":["CRM Payments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/payments"},"summary":"Create  payment","description":"Create new manual payment.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dealId":{"type":"number","description":"Deal ID for which you need to create payment."},"contactId":{"type":"number","description":"Contact ID for which you need to create payment."},"description":{"type":"string","description":"Description"},"price":{"type":"number","description":"Payment amount"},"currency":{"type":"string","description":"Payment currency"}}},"example":{"dealId":"","contactId":"","description":"","price":"","currency":""}}}}}},"/crm/v1/payments/{paymentId}/approve":{"post":{"tags":["CRM Payments"],"parameters":[{"name":"paymentId","in":"path","description":"The unique identifier of the manually created payment to approve","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/payments/{paymentId}/approve"},"summary":"Approve manual payment.","description":"Set approval status for manually created payment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/v1/payments/{paymentId}/cancel":{"post":{"tags":["CRM Payments"],"parameters":[{"name":"paymentId","in":"path","description":"The unique identifier of the payment to cancel","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/crm.yaml","api_endpoint":"https://api.sendpulse.com/crm/v1/payments/{paymentId}/cancel"},"summary":"Cancel manual payment","description":"Set payment status to canceled for manually created payment.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/messenger/contacts/get":{"get":{"tags":["Facebook Messenger Contacts"],"parameters":[{"name":"id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/get"},"summary":"Get contact info via a contact ID","description":"Returns information on the selected contact: bot and contact ID, information from Facebook, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/messenger/contacts/getByTag":{"get":{"tags":["Facebook Messenger Contacts"],"parameters":[{"name":"tag","in":"query","description":"created contact’s tag to search by","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/getByTag"},"summary":"Get a list of contacts by tag","description":"Returns a list of contacts by tag for the specified bot","security":[{"bearerAuth":[]}]}},"/messenger/contacts/getByVariable":{"get":{"tags":["Facebook Messenger Contacts"],"parameters":[{"name":"variable_id","in":"query","description":"Contact's variable ID","required":false,"schema":{"type":"string","example":""}},{"name":"variable_name","in":"query","description":"Сontact variable name to search by","required":false,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_value","in":"query","description":"Contact's variable value","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/getByVariable"},"summary":"Get a list of contacts by variable","description":"Returns a list of contacts by variable identifier or variable name for the specified bot","security":[{"bearerAuth":[]}]}},"/messenger/contacts/sendText":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/sendText"},"summary":"Send a text message to a contact","description":"Sends a text message to the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"message_type":{"type":"string","description":"Message Type","required":true,"enum":["MESSAGE_TAG","RESPONSE"]},"message_tag":{"type":"string","description":"Message Tag"},"text":{"type":"string","description":"Message text to send, maximum characters -, may include emoji","required":true}}},"example":{"contact_id":"","message_type":"RESPONSE","message_tag":"","text":""}}}}}},"/messenger/contacts/send":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/send"},"summary":"Send message to a contact","description":"Sends message to the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"message":{"type":"object","description":"Message","required":true,"properties":{"type":{"type":"string","description":"Type","enum":["UPDATE","RESPONSE","MESSAGE_TAG"]},"tag":{"type":"string","description":"Tag","enum":["HUMAN_AGENT","CUSTOMER_FEEDBACK"]},"content_type":{"type":"string","description":"Type of data sent","enum":["message","media_img","media_file","template"]},"text":{"type":"string","description":"The parameter is required if the `content_type` parameter is equal to `message`"},"img":{"type":"string","description":"The parameter is required if the `content_type` parameter is equal to `media_img`"},"file":{"type":"string","description":"The parameter is required if the `content_type` parameter is equal to `media_file`"},"data":{"type":"object","description":"The paramater is required if the `content_type` paramater is equal to `template`"}}}}},"example":{"contact_id":"","message":{}}}}}}},"/messenger/contacts/sendTyping":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/sendTyping"},"summary":"Send typing indicator","description":"Initiate typing indicator for the specified contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"The unique identifier of the contact to whom the typing indicator will be sent.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/contacts/setVariable":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/setVariable"},"summary":"Assign a variable to contact","description":"Adds or updates the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"variables":{"type":"array","description":"api.paths.contacts.setVariable.parameters.variables","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","variables":[]}}}}}},"/messenger/contacts/deleteVariable":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/deleteVariable"},"summary":"Delete a variable the selected contact","description":"Delete the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact."},"variable_id":{"type":"string","description":"The ID of the created variable can be obtained via other methods"},"variable_name":{"type":"string","description":"Name of the variable"}}},"example":{"contact_id":"","variable_id":"","variable_name":""}}}}}},"/messenger/contacts/mark-read":{"put":{"tags":["Facebook Messenger Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact’s ID for set unread count as 0","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/mark-read"},"summary":"Mark messages as read","description":"Mark contact all messages as read (set unread count 0)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/messenger/contacts/mark-unread":{"put":{"tags":["Facebook Messenger Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose last message will be marked as unread.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/mark-unread"},"summary":"Mark a chat with the contact as unread","description":"Marks the last message of a specific contact as unread.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/messenger/contacts/setTag":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/setTag"},"summary":"Assign a tag to a contact","description":"Assigns tags to the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","tags":[]}}}}}},"/messenger/contacts/deleteTag":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/deleteTag"},"summary":"Remove a tag from a contact","description":"Removes the tag for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tag":{"type":"string","description":"Tag, you want to remove","required":true}}},"example":{"contact_id":"","tag":""}}}}}},"/messenger/contacts/disable":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/disable"},"summary":"Disable contact","description":"Disables a contact in your audience list. Campaigns and autoflows will not be sent to this contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/contacts/enable":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/enable"},"summary":"Enable contact","description":"Enables a contact in your audience list. Campaigns and autoflows resume","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/contacts/delete":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/delete"},"summary":"Delete contact","description":"Removes a contact from the audience and subscribers list. The contact can be added back only by subscribing to the bot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/contacts/getPauseAutomation":{"get":{"tags":["Facebook Messenger Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/getPauseAutomation"},"summary":"Get remaining time for automation pause","description":"Returns the time remaining until autoflows are stopped for this contact","security":[{"bearerAuth":[]}]}},"/messenger/contacts/setPauseAutomation":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/setPauseAutomation"},"summary":"Pause autoflows for a contact","description":"Pauses autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"minutes":{"type":"number","description":"Minutes","required":true}}},"example":{"contact_id":"","minutes":60}}}}}},"/messenger/contacts/deletePauseAutomation":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/deletePauseAutomation"},"summary":"Resume autoflows for a contact","description":"Resumes autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/contacts/notes":{"get":{"tags":["Facebook Messenger Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/notes"},"summary":"Get a list of contact's operator notes","description":"Returns a list of existing operator notes by contact","security":[{"bearerAuth":[]}]}},"/messenger/contacts/createNote":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/createNote"},"summary":"Send operator note","description":"Sends operator note about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true}}},"example":{"contact_id":"","bot_id":"","text":""}}}}}},"/messenger/contacts/updateNote":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/updateNote"},"summary":"Update operator note","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","text":"","note_id":""}}}}}},"/messenger/contacts/deleteNote":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/deleteNote"},"summary":"Update operator note (Facebook Messenger Contacts)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","note_id":""}}}}}},"/messenger/contacts/operators/assign":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/operators/assign"},"summary":"Assign a responsible for the chat.","description":"Sets the specified operator as responsible for the chat. You can find the operator's ID in the https://login.sendpulse.com/settings/#users section.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"operator_id":{"type":"number","description":"The ID of the operator to assign","required":true}}},"example":{"contact_id":"","operator_id":""}}}}}},"/messenger/contacts/operators/unAssign":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/operators/unAssign"},"summary":"Unassign responsible operators for the chat.","description":"Removes any assigned operator for the chat.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/contacts/openChat":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/openChat"},"summary":"Open chat for a contact","description":"Increase the chat priority by marking it as open","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/contacts/closeChat":{"post":{"tags":["Facebook Messenger Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/contacts/closeChat"},"summary":"Close chat for a contact","description":"Close the chat and lower the priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/messenger/chats":{"get":{"tags":["Facebook Messenger Chats"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"size","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/chats"},"summary":"Get a list of chats","description":"Returns a list of chats with subscribers with information about the contact and the last message received from the contact","security":[{"bearerAuth":[]}]}},"/messenger/chats/messages":{"get":{"tags":["Facebook Messenger Chats"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/chats/messages"},"summary":"Get a list of messages","description":"Returns a list of all messages in correspondence with the specified subscriber","security":[{"bearerAuth":[]}]}},"/messenger/flows":{"get":{"tags":["Facebook Messenger Flows"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/flows"},"summary":"Get a list of flows","description":"Returns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date","security":[{"bearerAuth":[]}]}},"/messenger/flows/run":{"post":{"tags":["Facebook Messenger Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/flows/run"},"summary":"Run the flow by its identifier","description":"Launches the selected flow for the selected contact. Additional data can be passed to the \"external_data\" field and used once in the selected chain, where variables will be inserted in the \"Message\" element as a JSON path, for example {{$['tracking_number']}}.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"flow_id":{"type":"string","description":"Flow ID to be launched. Can be obtained with the method of obtaining the list of flows","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","flow_id":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/messenger/flows/runByTrigger":{"post":{"tags":["Facebook Messenger Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/flows/runByTrigger"},"summary":"Run a flow by trigger keywords","description":"Launches a flow with the trigger keyword for the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"trigger_keyword":{"type":"string","description":"trigger keyword","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","trigger_keyword":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/messenger/triggers":{"get":{"tags":["Facebook Messenger Triggers"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/triggers"},"summary":"Get a list of triggers","description":"Returns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date","security":[{"bearerAuth":[]}]}},"/messenger/variables":{"get":{"tags":["Facebook Messenger Variables"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/variables"},"summary":"Get a list of variables","description":"Returns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date","security":[{"bearerAuth":[]}]}},"/messenger/campaigns/send":{"post":{"tags":["Facebook Messenger Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/campaigns/send"},"summary":"Send campaign","description":"Sends a text campaign to all subscribers of the specified bot","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"Campaign title","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"message_tag":{"type":"string","description":"Message Tag"},"message_notification_type":{"type":"string","description":"Message Notification Type"},"send_at":{"type":"string","description":"Specify the date and time in the format Y-m-d H:i if you need to schedule the campaign, if you do not specify this parameter, the campaign will be sent immediately"},"filter":{"type":"object","description":"Filter for campaign sending","properties":{"type":{"type":"string","description":"Filter type (and/or)"},"expressions":{"type":"array","description":"Filter expressions"}}},"messages":{"type":"string","description":"Messages","required":true}}},"example":{"title":"","bot_id":"","message_tag":"","message_notification_type":"","send_at":"","filter":{},"messages":""}}}}}},"/messenger/bots":{"get":{"tags":["Facebook Messenger Bots"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/bots"},"summary":"Get a list of connected bots (Facebook Messenger Bots)","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/messenger/bots/statistics":{"get":{"tags":["Facebook Messenger Bots"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/bots/statistics"},"summary":"Get general statistics info by bot","description":"Returns general statistics info by bot","security":[{"bearerAuth":[]}]}},"/messenger/account":{"get":{"tags":["Facebook Messenger Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/account"},"summary":"Get account info (Facebook Messenger Account)","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/messenger/tags":{"get":{"tags":["Facebook Messenger Tags"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/facebook.yaml","api_endpoint":"https://api.sendpulse.com/messenger/tags"},"summary":"Get a list of tags (Facebook Messenger Tags)","description":"Returns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date","security":[{"bearerAuth":[]}]}},"/instagram/contacts/get":{"get":{"tags":["Instagram Contacts"],"parameters":[{"name":"id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/get"},"summary":"Get contact info via a contact ID (Instagram Contacts)","description":"Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/instagram/contacts/getByTag":{"get":{"tags":["Instagram Contacts"],"parameters":[{"name":"tag","in":"query","description":"Created contact’s tag to search by","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/getByTag"},"summary":"Get a list of contacts by tag (Instagram Contacts)","description":"Returns a list of contacts by tag for the specified bot","security":[{"bearerAuth":[]}]}},"/instagram/contacts/getByVariable":{"get":{"tags":["Instagram Contacts"],"parameters":[{"name":"variable_id","in":"query","description":"Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_name","in":"query","description":"Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.","required":false,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_value","in":"query","description":"Contact's variable value","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/getByVariable"},"summary":"Get contacts by variable (Instagram Contacts)","description":"Returns contacts by variable identifier or variable name for the specified bot","security":[{"bearerAuth":[]}]}},"/instagram/contacts/send":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/send"},"summary":"Send a message to a contact","description":"Sends a text message, image, or a file to the contact with the specified contact ID.  To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","items":{"type":"object","properties":{"value":{"type":"string","description":"Free-form object."}}}}}},"example":{"contact_id":"","messages":[]}}}}}},"/instagram/contacts/setVariable":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/setVariable"},"summary":"Assign a variable to contact (Instagram Contacts)","description":"Adds or updates the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"variables":{"type":"array","description":"api.paths.contacts.setVariable.parameters.variables","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","variables":[]}}}}}},"/instagram/contacts/deleteVariable":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/deleteVariable"},"summary":"Delete a variable the selected contact (Instagram Contacts)","description":"Delete the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact."},"variable_id":{"type":"string","description":"The ID of the created variable can be obtained via other methods"},"variable_name":{"type":"string","description":"Name of the variable"}}},"example":{"contact_id":"","variable_id":"","variable_name":""}}}}}},"/instagram/contacts/setTag":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/setTag"},"summary":"Assign a tag to contact","description":"Assigns tags to the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","tags":[]}}}}}},"/instagram/contacts/deleteTag":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/deleteTag"},"summary":"Remove a tag from a contact (Instagram Contacts)","description":"Removes the tag for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tag":{"type":"string","description":"Tag, you want to remove","required":true}}},"example":{"contact_id":"","tag":""}}}}}},"/instagram/contacts/disable":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/disable"},"summary":"Disable contact (Instagram Contacts)","description":"Disables a contact in your audience list. Campaigns and autoflows will not be sent to this contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/instagram/contacts/enable":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/enable"},"summary":"Enable contact (Instagram Contacts)","description":"Enables a contact in the audience list and contact start receiving campaings and autoflows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/instagram/contacts/delete":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/delete"},"summary":"Delete contact (Instagram Contacts)","description":"Removes a contact from the audience and subscribers list. The contact can be added back only by subscribing to the bot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/instagram/contacts/getPauseAutomation":{"get":{"tags":["Instagram Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/getPauseAutomation"},"summary":"Get remaining time for automation pause (Instagram Contacts)","description":"Returns the time remaining until autoflows are stopped for this contact","security":[{"bearerAuth":[]}]}},"/instagram/contacts/setPauseAutomation":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/setPauseAutomation"},"summary":"Pause autoflows for a contact (Instagram Contacts)","description":"Pauses autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"minutes":{"type":"number","description":"Minutes","required":true}}},"example":{"contact_id":"","minutes":60}}}}}},"/instagram/contacts/deletePauseAutomation":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/deletePauseAutomation"},"summary":"Resume autoflows for a contact (Instagram Contacts)","description":"Resumes autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/instagram/contacts/notes":{"get":{"tags":["Instagram Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/notes"},"summary":"Get a list of contact's operator notes (Instagram Contacts)","description":"Returns a list of existing operator notes by contact","security":[{"bearerAuth":[]}]}},"/instagram/contacts/createNote":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/createNote"},"summary":"Send operator note (Instagram Contacts)","description":"Sends operator note about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true}}},"example":{"contact_id":"","bot_id":"","text":""}}}}}},"/instagram/contacts/updateNote":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/updateNote"},"summary":"Update operator note (Instagram Contacts)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","text":"","note_id":""}}}}}},"/instagram/contacts/deleteNote":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/deleteNote"},"summary":"Update operator note (Instagram Contacts 5)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","note_id":""}}}}}},"/instagram/contacts/operators/assign":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/operators/assign"},"summary":"Assign a responsible for the chat. (Instagram Contacts)","description":"Sets the specified operator as responsible for the chat. You can find the operator's ID in the https://login.sendpulse.com/settings/#users section.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"operator_id":{"type":"number","description":"The ID of the operator to assign","required":true}}},"example":{"contact_id":"","operator_id":""}}}}}},"/instagram/contacts/operators/unAssign":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/operators/unAssign"},"summary":"Unassign responsible operators for the chat. (Instagram Contacts)","description":"Removes any assigned operator for the chat.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/instagram/contacts/mark-read":{"put":{"tags":["Instagram Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact’s ID for set unread count as 0","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/mark-read"},"summary":"Mark messages as read (Instagram Contacts)","description":"Mark contact all messages as read (set unread count 0)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/instagram/contacts/mark-unread":{"put":{"tags":["Instagram Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose last message will be marked as unread.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/mark-unread"},"summary":"Mark a chat with the contact as unread (Instagram Contacts)","description":"Marks the last message of a specific contact as unread.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/instagram/contacts/openChat":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/openChat"},"summary":"Open chat for a contact (Instagram Contacts)","description":"Increase the chat priority by marking it as open","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/instagram/contacts/closeChat":{"post":{"tags":["Instagram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/contacts/closeChat"},"summary":"Close chat for a contact (Instagram Contacts)","description":"Close the chat and lower the priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/instagram/flows":{"get":{"tags":["Instagram Flows"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/flows"},"summary":"Get a list of flows (Instagram Flows)","description":"Returns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date","security":[{"bearerAuth":[]}]}},"/instagram/flows/run":{"post":{"tags":["Instagram Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/flows/run"},"summary":"Run a flow by its ID","description":"Launches the selected flow for the selected contact. Additional data can be passed to the \"external_data\" field and used once in the selected chain, where variables will be inserted in the \"Message\" element as a JSON path, for example {{$['tracking_number']}}.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"flow_id":{"type":"string","description":"Flow ID to be launched. Can be obtained with the method of obtaining the list of flows","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","flow_id":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/instagram/flows/runByTrigger":{"post":{"tags":["Instagram Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/flows/runByTrigger"},"summary":"Run a flow by trigger keywords (Instagram Flows)","description":"Launches a flow with the trigger keyword for the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"trigger_keyword":{"type":"string","description":"Keyword (command) that launch the flow","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","trigger_keyword":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/instagram/triggers":{"get":{"tags":["Instagram Triggers"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/triggers"},"summary":"Get a list of triggers (Instagram Triggers)","description":"Returns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date","security":[{"bearerAuth":[]}]}},"/instagram/bots":{"get":{"tags":["Instagram Bots"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/bots"},"summary":"Get a list of connected bots (Instagram Bots)","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/instagram/bots/statistics":{"get":{"tags":["Instagram Bots"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/bots/statistics"},"summary":"Get general statistics info by bot (Instagram Bots)","description":"Returns general statistics info by bot","security":[{"bearerAuth":[]}]}},"/instagram/chats":{"get":{"tags":["Instagram Chats"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"size","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/chats"},"summary":"Get a list of chats (Instagram Chats)","description":"Returns a list of chats with subscribers with information about the contact and the last message received from the contact","security":[{"bearerAuth":[]}]}},"/instagram/chats/messages":{"get":{"tags":["Instagram Chats"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"search_after","in":"query","description":"The id of element after which elements will be searched","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/chats/messages"},"summary":"Get a list of messages (Instagram Chats)","description":"Returns a list of all messages in correspondence with the specified subscriber","security":[{"bearerAuth":[]}]}},"/instagram/variables":{"get":{"tags":["Instagram Variables"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/variables"},"summary":"Get a list of variables (Instagram Variables)","description":"Returns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date","security":[{"bearerAuth":[]}]}},"/instagram/campaigns/send":{"post":{"tags":["Instagram Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/campaigns/send"},"summary":"Send campaign (Instagram Campaigns)","description":"Sends a campaign to all of a bot's subscribers that were active within the last 24 hours. You can send a campaign with text, an image, or a file. To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"Campaign title","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"send_at":{"type":"string","description":"Specify the date and time in the format Y-m-d H:i if you need to schedule the campaign, if you do not specify this parameter, the campaign will be sent immediately"},"filter":{"type":"object","description":"Filter for campaign sending","properties":{"type":{"type":"string","description":"Filter type (and/or)"},"expressions":{"type":"array","description":"Filter expressions"}}},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"Free-form object."}}}}}},"example":{"title":"","bot_id":"","send_at":"Y-m-d H:i","filter":{},"messages":[]}}}}}},"/instagram/tags":{"get":{"tags":["Instagram Tags"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/tags"},"summary":"Get a list of tags (Instagram Tags)","description":"Returns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date","security":[{"bearerAuth":[]}]}},"/instagram/account":{"get":{"tags":["Instagram Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/instagram.yaml","api_endpoint":"https://api.sendpulse.com/instagram/account"},"summary":"Get account info (Instagram Account)","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/live-chat/account":{"get":{"tags":["Live Chat Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/account"},"summary":"Get account info (Live Chat Account)","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/live-chat/bots":{"get":{"tags":["Live Chat Bots"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/bots"},"summary":"Get a list of connected bots (Live Chat Bots)","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/live-chat/bots/statistics":{"get":{"tags":["Live Chat Bots"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/bots/statistics"},"summary":"Get general statistics info by bot (Live Chat Bots)","description":"Returns general statistics info by bot","security":[{"bearerAuth":[]}]}},"/live-chat/contacts/get":{"get":{"tags":["Live Chat Contacts"],"parameters":[{"name":"id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/get"},"summary":"Get contact info via a contact ID (Live Chat Contacts)","description":"Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/live-chat/contacts/getByTag":{"get":{"tags":["Live Chat Contacts"],"parameters":[{"name":"tag","in":"query","description":"Created contact’s tag to search by","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/getByTag"},"summary":"Get a list of contacts by tag (Live Chat Contacts)","description":"Returns a list of contacts by tag for the specified bot","security":[{"bearerAuth":[]}]}},"/live-chat/contacts/getByVariable":{"get":{"tags":["Live Chat Contacts"],"parameters":[{"name":"variable_id","in":"query","description":"Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_name","in":"query","description":"Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.","required":false,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_value","in":"query","description":"Contact's variable value","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/getByVariable"},"summary":"Get contacts by variable (Live Chat Contacts)","description":"Returns contacts by variable identifier or variable name for the specified bot","security":[{"bearerAuth":[]}]}},"/live-chat/contacts/send":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/send"},"summary":"Send a message to a contact (Live Chat Contacts)","description":"Sends a text message, image, or a file to the contact with the specified contact ID.  To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","items":{"type":"object","properties":{"value":{"type":"string","description":"Free-form object."}}}}}},"example":{"contact_id":"","messages":[]}}}}}},"/live-chat/contacts/setVariable":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/setVariable"},"summary":"Assign a variable to contact (Live Chat Contacts)","description":"Adds or updates the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"variables":{"type":"array","description":"api.paths.contacts.setVariable.parameters.variables","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","variables":[]}}}}}},"/live-chat/contacts/deleteVariable":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/deleteVariable"},"summary":"Delete a variable the selected contact (Live Chat Contacts)","description":"Delete the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact."},"variable_id":{"type":"string","description":"The ID of the created variable can be obtained via other methods"},"variable_name":{"type":"string","description":"Name of the variable"}}},"example":{"contact_id":"","variable_id":"","variable_name":""}}}}}},"/live-chat/contacts/setTag":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/setTag"},"summary":"Assign a tag to contact (Live Chat Contacts)","description":"Assigns tags to the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","tags":[]}}}}}},"/live-chat/contacts/deleteTag":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/deleteTag"},"summary":"Remove a tag from a contact (Live Chat Contacts)","description":"Removes the tag for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tag":{"type":"string","description":"Tag, you want to remove","required":true}}},"example":{"contact_id":"","tag":""}}}}}},"/live-chat/contacts/disable":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/disable"},"summary":"Disable contact (Live Chat Contacts)","description":"Disables a contact in your audience list. Campaigns and autoflows will not be sent to this contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/live-chat/contacts/enable":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/enable"},"summary":"Enable contact (Live Chat Contacts)","description":"Enables a contact in the audience list and contact start receiving campaings and autoflows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/live-chat/contacts/delete":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/delete"},"summary":"Delete contact (Live Chat Contacts)","description":"Removes a contact from the audience and subscribers list. The contact can be added back only by subscribing to the bot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/live-chat/contacts/getPauseAutomation":{"get":{"tags":["Live Chat Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/getPauseAutomation"},"summary":"Get remaining time for automation pause (Live Chat Contacts)","description":"Returns the time remaining until autoflows are stopped for this contact","security":[{"bearerAuth":[]}]}},"/live-chat/contacts/setPauseAutomation":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/setPauseAutomation"},"summary":"Pause autoflows for a contact (Live Chat Contacts)","description":"Pauses autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"minutes":{"type":"number","description":"Minutes","required":true}}},"example":{"contact_id":"","minutes":60}}}}}},"/live-chat/contacts/deletePauseAutomation":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/deletePauseAutomation"},"summary":"Resume autoflows for a contact (Live Chat Contacts)","description":"Resumes autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/live-chat/contacts/notes":{"get":{"tags":["Live Chat Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/notes"},"summary":"Get a list of contact's operator notes (Live Chat Contacts)","description":"Returns a list of existing operator notes by contact","security":[{"bearerAuth":[]}]}},"/live-chat/contacts/createNote":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/createNote"},"summary":"Send operator note (Live Chat Contacts)","description":"Sends operator note about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true}}},"example":{"contact_id":"","bot_id":"","text":""}}}}}},"/live-chat/contacts/updateNote":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/updateNote"},"summary":"Update operator note (Live Chat Contacts)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","text":"","note_id":""}}}}}},"/live-chat/contacts/deleteNote":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/deleteNote"},"summary":"Update operator note (Live Chat Contacts 7)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","note_id":""}}}}}},"/live-chat/contacts/operators/assign":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/operators/assign"},"summary":"Assign a responsible for the chat. (Live Chat Contacts)","description":"Sets the specified operator as responsible for the chat. You can find the operator's ID in the https://login.sendpulse.com/settings/#users section.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"operator_id":{"type":"number","description":"The ID of the operator to assign","required":true}}},"example":{"contact_id":"","operator_id":""}}}}}},"/live-chat/contacts/operators/unAssign":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/operators/unAssign"},"summary":"Unassign responsible operators for the chat. (Live Chat Contacts)","description":"Removes any assigned operator for the chat.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/live-chat/contacts/setName":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/setName"},"summary":"Set the contact's name","description":"Updates the display name of the specified contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"The unique identifier of the contact. You can obtain this via a contact search by certain criteria or retrieve it from the address bar of the contact’s chat window in your account.","required":true},"name":{"type":"string","description":"The new name to assign to the contact.","required":true}}},"example":{"contact_id":"","name":""}}}}}},"/live-chat/contacts/mark-read":{"put":{"tags":["Live Chat Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact’s ID for set unread count as 0","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/mark-read"},"summary":"Mark messages as read (Live Chat Contacts)","description":"Mark contact all messages as read (set unread count 0)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/live-chat/contacts/mark-unread":{"put":{"tags":["Live Chat Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose last message will be marked as unread.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/mark-unread"},"summary":"Mark a chat with the contact as unread (Live Chat Contacts)","description":"Marks the last message of a specific contact as unread.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/live-chat/contacts/openChat":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/openChat"},"summary":"Open chat for a contact (Live Chat Contacts)","description":"Increase the chat priority by marking it as open","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/live-chat/contacts/closeChat":{"post":{"tags":["Live Chat Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/contacts/closeChat"},"summary":"Close chat for a contact (Live Chat Contacts)","description":"Close the chat and lower the priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/live-chat/chats":{"get":{"tags":["Live Chat Chats"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"size","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/chats"},"summary":"Get a list of chats (Live Chat Chats)","description":"Returns a list of chats with subscribers with information about the contact and the last message received from the contact","security":[{"bearerAuth":[]}]}},"/live-chat/chats/messages":{"get":{"tags":["Live Chat Chats"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"search_after","in":"query","description":"The id of element after which elements will be searched","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/chats/messages"},"summary":"Get a list of messages (Live Chat Chats)","description":"Returns a list of all messages in correspondence with the specified subscriber","security":[{"bearerAuth":[]}]}},"/live-chat/variables":{"get":{"tags":["Live Chat Variables"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/variables"},"summary":"Get a list of variables (Live Chat Variables)","description":"Returns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date","security":[{"bearerAuth":[]}]}},"/live-chat/triggers":{"get":{"tags":["Live Chat Triggers"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/triggers"},"summary":"Get a list of triggers (Live Chat Triggers)","description":"Returns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date","security":[{"bearerAuth":[]}]}},"/live-chat/flows":{"get":{"tags":["Live Chat Flows"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/flows"},"summary":"Get a list of flows (Live Chat Flows)","description":"Returns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date","security":[{"bearerAuth":[]}]}},"/live-chat/flows/run":{"post":{"tags":["Live Chat Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/flows/run"},"summary":"Run a flow by its ID (Live Chat Flows)","description":"Launches the selected flow for the selected contact. Additional data can be passed to the \"external_data\" field and used once in the selected chain, where variables will be inserted in the \"Message\" element as a JSON path, for example {{$['tracking_number']}}.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"flow_id":{"type":"string","description":"Flow ID to be launched. Can be obtained with the method of obtaining the list of flows","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","flow_id":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/live-chat/flows/runByTrigger":{"post":{"tags":["Live Chat Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/flows/runByTrigger"},"summary":"Run a flow by trigger keywords (Live Chat Flows)","description":"Launches a flow with the trigger keyword for the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"trigger_keyword":{"type":"string","description":"Keyword (command) that launch the flow","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","trigger_keyword":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/live-chat/tags":{"get":{"tags":["Live Chat Tags"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/live-chat.yaml","api_endpoint":"https://api.sendpulse.com/live-chat/tags"},"summary":"Get a list of tags (Live Chat Tags)","description":"Returns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date","security":[{"bearerAuth":[]}]}},"/sms/numbers":{"post":{"tags":["SMS Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/numbers"},"summary":"Add phone numbers to a mailing list","description":"Add phone numbers to a mailing list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"addressBookId":{"type":"number","description":"Addressbookid","required":true},"phones":{"type":"array","description":"Phones","required":true,"items":{"type":"string"}}}},"example":{"addressBookId":"","phones":[]}}}}},"put":{"tags":["SMS Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/numbers"},"summary":"Update variables for multiple phone numbers","description":"Update variables for multiple phone numbers","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"addressBookId":{"type":"number","description":"Addressbookid","required":true},"phones":{"type":"array","description":"Phones","required":true,"items":{"type":"string"}},"variables":{"type":"array","description":"Variables","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"type":{"type":"string","description":"Type","enum":["string","number","date"]},"value":{"type":"string","description":"Value"}}}}}},"example":{"addressBookId":"","phones":[],"variables":[]}}}}},"delete":{"tags":["SMS Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/numbers"},"summary":"Remove phone numbers from a mailing list","description":"Remove phone numbers from a mailing list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"addressBookId":{"type":"number","description":"Addressbookid","required":true},"phones":{"type":"array","description":"Phones","required":true,"items":{"type":"string"}}}},"example":{"addressBookId":"","phones":[]}}}}}},"/sms/numbers/variables":{"post":{"tags":["SMS Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/numbers/variables"},"summary":"Add phone numbers with complex variables","description":"Add phone numbers with complex variables","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"addressBookId":{"type":"number","description":"Addressbookid","required":true},"phones":{"type":"object","description":"Phones","required":true,"properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"addressBookId":"","phones":{}}}}}}},"/addressbooks/{id}/phones/variable":{"post":{"tags":["SMS Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/addressbooks/{id}/phones/variable"},"summary":"Change variables for a single phone contact","description":"Change variables for a single phone contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone":{"type":"string","description":"Phone","required":true},"variables":{"type":"array","description":"Variables","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"string","description":"Value"}}}}}},"example":{"phone":"","variables":[]}}}}}},"/sms/numbers/info/{addressBookId}/{phoneNumber}":{"get":{"tags":["SMS Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/numbers/info/{addressBookId}/{phoneNumber}"},"summary":"Get information for a specific phone number","description":"Get information for a specific phone number","security":[{"bearerAuth":[]}]}},"/sms/black_list":{"post":{"tags":["SMS Compliance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/black_list"},"summary":"Add phone numbers to the blacklist","description":"Add phone numbers to the blacklist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phones":{"type":"array","description":"Phones","required":true,"items":{"type":"string"}},"description":{"type":"string","description":"Description","required":true}}},"example":{"phones":[],"description":""}}}}},"delete":{"tags":["SMS Compliance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/black_list"},"summary":"Remove a phone number from the blacklist","description":"Remove a phone number from the blacklist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phones":{"type":"array","description":"Phones","required":true,"items":{"type":"string"}}}},"example":{"phones":[]}}}}},"get":{"tags":["SMS Compliance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/black_list"},"summary":"Get a list of contacts in the blacklist","description":"Get a list of contacts in the blacklist","security":[{"bearerAuth":[]}]}},"/sms/campaigns":{"post":{"tags":["SMS Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/campaigns"},"summary":"Create a campaign for a mailing list","description":"Create a campaign for a mailing list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sender":{"type":"string","description":"Sender","required":true},"addressBookId":{"type":"number","description":"Addressbookid","required":true},"body":{"type":"string","description":"Body","required":true},"route":{"type":"object","description":"e.g. {'UA':'national'}","properties":{"value":{"type":"string","description":"Free-form object."}}},"date":{"type":"string","description":"(format: date-time)"},"emulate":{"type":"boolean","description":"Emulate","enum":[true,false]},"use_dynamic_list":{"type":"boolean","description":"Use Dynamic List","enum":[true,false]},"stat_link_tracking":{"type":"boolean","description":"Stat Link Tracking","enum":[true,false]},"stat_link_need_protocol":{"type":"boolean","description":"Stat Link Need Protocol","enum":[true,false]}}},"example":{"sender":"","addressBookId":"","body":"","route":{},"date":"","emulate":"","use_dynamic_list":"","stat_link_tracking":"","stat_link_need_protocol":""}}}}},"delete":{"tags":["SMS Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/campaigns"},"summary":"Delete a campaign","description":"Delete a campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"Id","required":true}}},"example":{"id":""}}}}}},"/sms/send":{"post":{"tags":["SMS Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/send"},"summary":"Create a campaign for a list of phone numbers","description":"Create a campaign for a list of phone numbers","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sender":{"type":"string","description":"Sender","required":true},"phones":{"type":"array","description":"Phones","required":true,"items":{"type":"string"}},"body":{"type":"string","description":"Body","required":true},"date":{"type":"string","description":"Date"},"route":{"type":"object","description":"Route","properties":{"value":{"type":"string","description":"Free-form object."}}},"emulate":{"type":"boolean","description":"Emulate","enum":[true,false]},"stat_link_tracking":{"type":"boolean","description":"Stat Link Tracking","enum":[true,false]},"stat_link_need_protocol":{"type":"boolean","description":"Stat Link Need Protocol","enum":[true,false]}}},"example":{"sender":"","phones":[],"body":"","date":"","route":{},"emulate":"","stat_link_tracking":"","stat_link_need_protocol":""}}}}}},"/sms/campaigns/list":{"get":{"tags":["SMS Campaigns"],"parameters":[{"name":"dateFrom","in":"query","description":"dateFrom","required":false,"schema":{"type":"string","example":""}},{"name":"dateTo","in":"query","description":"dateTo","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/campaigns/list"},"summary":"Get a list of campaigns by date","description":"Get a list of campaigns by date","security":[{"bearerAuth":[]}]}},"/sms/campaigns/info/{id}":{"get":{"tags":["SMS Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/campaigns/info/{id}"},"summary":"Get campaign information (SMS Campaigns)","description":"Get campaign information","security":[{"bearerAuth":[]}]}},"/sms/campaigns/cancel/{id}":{"put":{"tags":["SMS Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/campaigns/cancel/{id}"},"summary":"Cancel a campaign before sending has started","description":"Cancel a campaign before sending has started","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sms/campaigns/cost":{"get":{"tags":["SMS Campaigns"],"parameters":[{"name":"addressBookId","in":"query","description":"addressBookId","required":false,"schema":{"type":"number","example":""}},{"name":"phones","in":"query","description":"phones","required":false,"schema":{"type":"array","example":""}},{"name":"body","in":"query","description":"body","required":true,"schema":{"type":"string","example":""}},{"name":"sender","in":"query","description":"sender","required":true,"schema":{"type":"string","example":""}},{"name":"route","in":"query","description":"route","required":false,"schema":{"type":"object","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/campaigns/cost"},"summary":"Calculate the cost of a campaign","description":"Calculate the cost of a campaign","security":[{"bearerAuth":[]}]}},"/sms/senders":{"get":{"tags":["SMS Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/sms.yaml","api_endpoint":"https://api.sendpulse.com/sms/senders"},"summary":"Get list of sender IDs","description":"Get list of sender IDs","security":[{"bearerAuth":[]}]}},"/smtp/emails":{"post":{"tags":["SMTP Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/emails"},"summary":"Send an email","description":"Send an email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"object","description":"Email","required":true,"properties":{"html":{"type":"string","description":"HTML version of an email, encoded in Base64"},"text":{"type":"string","description":"Text version of the email"},"template":{"type":"object","description":"Template"},"auto_plain_text":{"type":"boolean","description":"Auto Plain Text","enum":[true,false]},"subject":{"type":"string","description":"Subject"},"from":{"type":"object","description":"From"},"to":{"type":"array","description":"To"},"reply_to":{"type":"object","description":"Reply To"},"cc":{"type":"array","description":"Cc"},"bcc":{"type":"array","description":"Bcc"},"attachments":{"type":"object","description":"Filename to content mapping"},"attachments_binary":{"type":"object","description":"Filename to Base64 content mapping"}}}}},"example":{"email":{}}}}}},"get":{"tags":["SMTP Emails"],"parameters":[{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}},{"name":"from","in":"query","description":"(format: date)","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"(format: date)","required":false,"schema":{"type":"string","example":""}},{"name":"sender","in":"query","description":"sender","required":false,"schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"recipient","required":false,"schema":{"type":"string","example":""}},{"name":"country","in":"query","description":"country","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/emails"},"summary":"Get a list of emails","description":"Get a list of emails","security":[{"bearerAuth":[]}]}},"/smtp/emails/total":{"get":{"tags":["SMTP Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/emails/total"},"summary":"Get total amount of sent emails","description":"Get total amount of sent emails","security":[{"bearerAuth":[]}]}},"/smtp/emails/{id}":{"get":{"tags":["SMTP Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/emails/{id}"},"summary":"Get information about a specific email","description":"Get information about a specific email","security":[{"bearerAuth":[]}]}},"/smtp/emails/info":{"post":{"tags":["SMTP Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/emails/info"},"summary":"Get information for a list of emails","description":"Get information for a list of emails","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/smtp/bounces/day":{"get":{"tags":["SMTP Bounces"],"parameters":[{"name":"date","in":"query","description":"(format: date)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/bounces/day"},"summary":"Get information about bounces for a 24-hour period","description":"Get information about bounces for a 24-hour period","security":[{"bearerAuth":[]}]}},"/smtp/bounces/day/total":{"get":{"tags":["SMTP Bounces"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/bounces/day/total"},"summary":"Get total number of bounces","description":"Get total number of bounces","security":[{"bearerAuth":[]}]}},"/smtp/unsubscribe":{"post":{"tags":["SMTP Unsubscribe"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/unsubscribe"},"summary":"Unsubscribe a recipient","description":"Unsubscribe a recipient","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["SMTP Unsubscribe"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/unsubscribe"},"summary":"Remove an email from the unsubscribed list","description":"Remove an email from the unsubscribed list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["SMTP Unsubscribe"],"parameters":[{"name":"date","in":"query","description":"(format: date)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/unsubscribe"},"summary":"Get a list of unsubscribed users","description":"Get a list of unsubscribed users","security":[{"bearerAuth":[]}]}},"/smtp/unsubscribe/search":{"get":{"tags":["SMTP Unsubscribe"],"parameters":[{"name":"email","in":"query","description":"email","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/unsubscribe/search"},"summary":"Get information about a contact's subscription status","description":"Get information about a contact's subscription status","security":[{"bearerAuth":[]}]}},"/smtp/resubscribe":{"post":{"tags":["SMTP Unsubscribe"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/resubscribe"},"summary":"Resubscribe a recipient","description":"Resubscribe a recipient","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email","required":true},"sender":{"type":"string","description":"Sender","required":true},"lang":{"type":"string","description":"Lang","enum":["ru","en","ua","tr","es","pt"]}}},"example":{"email":"","sender":"","lang":""}}}}}},"/smtp/ips":{"get":{"tags":["SMTP Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/ips"},"summary":"Get a list of sender’s IP addresses","description":"Get a list of sender’s IP addresses","security":[{"bearerAuth":[]}]}},"/smtp/senders":{"get":{"tags":["SMTP Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/smtp/senders"},"summary":"Get a list of sender’s email addresses","description":"Get a list of sender’s email addresses","security":[{"bearerAuth":[]}]}},"/v2/email-service/smtp/sender_domains":{"get":{"tags":["SMTP Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/v2/email-service/smtp/sender_domains"},"summary":"Get a list of allowed domains","description":"Get a list of allowed domains","security":[{"bearerAuth":[]}]}},"/v2/email-service/smtp/sender_domains/{domain}":{"post":{"tags":["SMTP Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/smtp.yaml","api_endpoint":"https://api.sendpulse.com/v2/email-service/smtp/sender_domains/{domain}"},"summary":"Add a domain","description":"Add a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/telegram/contacts/get":{"get":{"tags":["Telegram Contacts"],"parameters":[{"name":"id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/get"},"summary":"Get contact info via a contact ID (Telegram Contacts)","description":"Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/telegram/contacts/getByTag":{"get":{"tags":["Telegram Contacts"],"parameters":[{"name":"tag","in":"query","description":"Created contact’s tag to search by","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/getByTag"},"summary":"Get a list of contacts by tag (Telegram Contacts)","description":"Returns a list of contacts by tag for the specified bot","security":[{"bearerAuth":[]}]}},"/telegram/contacts/getByVariable":{"get":{"tags":["Telegram Contacts"],"parameters":[{"name":"variable_id","in":"query","description":"Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_name","in":"query","description":"Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.","required":false,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_value","in":"query","description":"Contact's variable value","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/getByVariable"},"summary":"Get contacts by variable (Telegram Contacts)","description":"Returns contacts by variable identifier or variable name for the specified bot","security":[{"bearerAuth":[]}]}},"/telegram/contacts/getByTelegramId":{"get":{"tags":["Telegram Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot identifier","required":true,"schema":{"type":"string","example":""}},{"name":"telegram_id","in":"query","description":"Telegram ID of the user or chat","required":true,"schema":{"type":"number","example":""}},{"name":"business_connection_id","in":"query","description":"Telegram business connection identifier (optional)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/getByTelegramId"},"summary":"Get contact by Telegram ID","description":"Returns a bot contact by Telegram ID.","security":[{"bearerAuth":[]}]}},"/telegram/contacts/mark-read":{"put":{"tags":["Telegram Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact’s ID for set unread count as 0","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/mark-read"},"summary":"Mark messages as read (Telegram Contacts)","description":"Mark contact all messages as read (set unread count 0)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/telegram/contacts/mark-unread":{"put":{"tags":["Telegram Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose last message will be marked as unread.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/mark-unread"},"summary":"Mark a chat with the contact as unread (Telegram Contacts)","description":"Marks the last message of a specific contact as unread.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/telegram/contacts/send":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/send"},"summary":"Send a message to a contact (Telegram Contacts)","description":"Sends a text message, image, or a file to the contact with the specified contact ID.  To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"message":{"type":"object","description":"Message","required":true,"properties":{"type":{"type":"string","description":"Type","enum":["text","audio","photo","document","video","carousel","action"]},"text":{"type":"string","description":"Text"},"audio":{"type":"string","description":"URL to file"},"voice":{"type":"string","description":"The voice you want to send. Includes the URL to the voice and caption. Should be audio/ogg and less than 1MB or will be send as general audio"},"photo":{"type":"string","description":"URL to file"},"document":{"type":"string","description":"URL to file"},"video":{"type":"string","description":"URL to file"},"caption":{"type":"string","description":"Caption"},"parse_mode":{"type":"string","description":"Html text"},"reply_markup":{"type":"object","description":"The buttons of the message"},"carousel":{"type":"array","description":"An array of carousel items"},"message_effect_id":{"type":"string","description":"Message Effect Id"}}}}},"example":{"contact_id":"","message":{}}}}}}},"/telegram/contacts/sendText":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/sendText"},"summary":"Sends a text message to the specified contact","description":"Sends a text message to the specified contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"The content of the text message. You can add text with emoji of up to 1024 unicode characters.","required":true}}},"example":{"contact_id":"","text":""}}}}}},"/telegram/contacts/react":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/react"},"summary":"React to a message","description":"Send a reaction (e.g. an emoji) to a specific message of a contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"The ID of the contact.","required":true},"message_id":{"type":"string","description":"The ID of the message to react to.","required":true},"reaction":{"type":"object","description":"Object with reaction details.","required":true,"properties":{"type":{"type":"string","description":"Type of reaction (for example, \"emoji\").","enum":["emoji"]},"emoji":{"type":"string","description":"The emoji character to use as reaction."}}}}},"example":{"contact_id":"","message_id":"","reaction":{}}}}}}},"/telegram/contacts/setVariable":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/setVariable"},"summary":"Assign a variable to contact (Telegram Contacts)","description":"Adds or updates the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"variables":{"type":"array","description":"api.paths.contacts.setVariable.parameters.variables","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","variables":[]}}}}}},"/telegram/contacts/deleteVariable":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/deleteVariable"},"summary":"Delete a variable the selected contact (Telegram Contacts)","description":"Delete the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact."},"variable_id":{"type":"string","description":"The ID of the created variable can be obtained via other methods"},"variable_name":{"type":"string","description":"Name of the variable"}}},"example":{"contact_id":"","variable_id":"","variable_name":""}}}}}},"/telegram/contacts/setTag":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/setTag"},"summary":"Assign a tag to contact (Telegram Contacts)","description":"Assigns tags to the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","tags":[]}}}}}},"/telegram/contacts/deleteTag":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/deleteTag"},"summary":"Remove a tag from a contact (Telegram Contacts)","description":"Removes the tag for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tag":{"type":"string","description":"Tag, you want to remove","required":true}}},"example":{"contact_id":"","tag":""}}}}}},"/telegram/contacts/disable":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/disable"},"summary":"Disable contact (Telegram Contacts)","description":"Disables a contact in your audience list. Campaigns and autoflows will not be sent to this contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/telegram/contacts/enable":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/enable"},"summary":"Enable contact (Telegram Contacts)","description":"Enables a contact in the audience list and contact start receiving campaings and autoflows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/telegram/contacts/delete":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/delete"},"summary":"Delete contact (Telegram Contacts)","description":"Removes a contact from the audience and subscribers list. The contact can be added back only by subscribing to the bot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/telegram/contacts/getPauseAutomation":{"get":{"tags":["Telegram Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/getPauseAutomation"},"summary":"Get remaining time for automation pause (Telegram Contacts)","description":"Returns the time remaining until autoflows are stopped for this contact","security":[{"bearerAuth":[]}]}},"/telegram/contacts/setPauseAutomation":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/setPauseAutomation"},"summary":"Pause autoflows for a contact (Telegram Contacts)","description":"Pauses autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"minutes":{"type":"number","description":"Minutes","required":true}}},"example":{"contact_id":"","minutes":60}}}}}},"/telegram/contacts/deletePauseAutomation":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/deletePauseAutomation"},"summary":"Resume autoflows for a contact (Telegram Contacts)","description":"Resumes autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/telegram/contacts/notes":{"get":{"tags":["Telegram Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/notes"},"summary":"Get a list of contact's operator notes (Telegram Contacts)","description":"Returns a list of existing operator notes by contact","security":[{"bearerAuth":[]}]}},"/telegram/contacts/createNote":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/createNote"},"summary":"Send operator note (Telegram Contacts)","description":"Sends operator note about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true}}},"example":{"contact_id":"","bot_id":"","text":""}}}}}},"/telegram/contacts/updateNote":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/updateNote"},"summary":"Update operator note (Telegram Contacts)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","text":"","note_id":""}}}}}},"/telegram/contacts/deleteNote":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/deleteNote"},"summary":"Update operator note (Telegram Contacts 9)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","note_id":""}}}}}},"/telegram/contacts/operators/assign":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/operators/assign"},"summary":"Assign a responsible for the chat. (Telegram Contacts)","description":"Sets the specified operator as responsible for the chat. You can find the operator's ID in the https://login.sendpulse.com/settings/#users section.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"operator_id":{"type":"number","description":"The ID of the operator to assign","required":true}}},"example":{"contact_id":"","operator_id":""}}}}}},"/telegram/contacts/operators/unAssign":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/operators/unAssign"},"summary":"Unassign responsible operators for the chat. (Telegram Contacts)","description":"Removes any assigned operator for the chat.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/telegram/contacts/openChat":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/openChat"},"summary":"Open chat for a contact (Telegram Contacts)","description":"Increase the chat priority by marking it as open","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/telegram/contacts/closeChat":{"post":{"tags":["Telegram Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/contacts/closeChat"},"summary":"Close chat for a contact (Telegram Contacts)","description":"Close the chat and lower the priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/telegram/flows":{"get":{"tags":["Telegram Flows"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/flows"},"summary":"Get a list of flows (Telegram Flows)","description":"Returns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date","security":[{"bearerAuth":[]}]}},"/telegram/flows/run":{"post":{"tags":["Telegram Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/flows/run"},"summary":"Run a flow by its ID (Telegram Flows)","description":"Launches the selected flow for the selected contact. Additional data can be passed to the \"external_data\" field and used once in the selected chain, where variables will be inserted in the \"Message\" element as a JSON path, for example {{$['tracking_number']}}.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"flow_id":{"type":"string","description":"Flow ID to be launched. Can be obtained with the method of obtaining the list of flows","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","flow_id":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/telegram/flows/runByTrigger":{"post":{"tags":["Telegram Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/flows/runByTrigger"},"summary":"Run a flow by trigger keywords (Telegram Flows)","description":"Launches a flow with the trigger keyword for the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"trigger_keyword":{"type":"string","description":"Keyword (command) that launch the flow","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","trigger_keyword":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/telegram/triggers":{"get":{"tags":["Telegram Triggers"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/triggers"},"summary":"Get a list of triggers (Telegram Triggers)","description":"Returns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date","security":[{"bearerAuth":[]}]}},"/telegram/bots":{"get":{"tags":["Telegram Bots"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/bots"},"summary":"Get a list of connected bots (Telegram Bots)","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/telegram/bots/statistics":{"get":{"tags":["Telegram Bots"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/bots/statistics"},"summary":"Get general statistics info by bot (Telegram Bots)","description":"Returns general statistics info by bot","security":[{"bearerAuth":[]}]}},"/telegram/chats":{"get":{"tags":["Telegram Chats"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"size","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/chats"},"summary":"Get a list of chats (Telegram Chats)","description":"Returns a list of chats with subscribers with information about the contact and the last message received from the contact","security":[{"bearerAuth":[]}]}},"/telegram/chats/messages":{"get":{"tags":["Telegram Chats"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"search_after","in":"query","description":"The id of element after which elements will be searched","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/chats/messages"},"summary":"Get a list of messages (Telegram Chats)","description":"Returns a list of all messages in correspondence with the specified subscriber","security":[{"bearerAuth":[]}]}},"/telegram/variables":{"get":{"tags":["Telegram Variables"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/variables"},"summary":"Get a list of variables (Telegram Variables)","description":"Returns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date","security":[{"bearerAuth":[]}]}},"/telegram/campaigns/send":{"post":{"tags":["Telegram Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/campaigns/send"},"summary":"Send campaign (Telegram Campaigns)","description":"Sends a campaign to all of a bot's subscribers. You can send a campaign with text, an image, or a file. To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"Campaign title","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"send_at":{"type":"string","description":"Specify the date and time in the format Y-m-d H:i if you need to schedule the campaign, if you do not specify this parameter, the campaign will be sent immediately"},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"Campaign type, can have the values \"text,\" \"image,\" or \"document\"","enum":["text"]},"filter":{"type":"object","description":"Filter for campaign sending"},"message":{"type":"object","description":"Message"}}}}}},"example":{"title":"","bot_id":"","send_at":"","messages":[]}}}}}},"/telegram/account":{"get":{"tags":["Telegram Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/account"},"summary":"Get account info (Telegram Account)","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/telegram/tags":{"get":{"tags":["Telegram Tags"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/telegram.yaml","api_endpoint":"https://api.sendpulse.com/telegram/tags"},"summary":"Get a list of tags (Telegram Tags)","description":"Returns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date","security":[{"bearerAuth":[]}]}},"/tiktok/contacts/get":{"get":{"tags":["TikTok Contacts"],"parameters":[{"name":"id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/get"},"summary":"Get contact info via a contact ID (TikTok Contacts)","description":"Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/tiktok/contacts/getByTag":{"get":{"tags":["TikTok Contacts"],"parameters":[{"name":"tag","in":"query","description":"Created contact’s tag to search by","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/getByTag"},"summary":"Get a list of contacts by tag (TikTok Contacts)","description":"Returns a list of contacts by tag for the specified bot","security":[{"bearerAuth":[]}]}},"/tiktok/contacts/getByVariable":{"get":{"tags":["TikTok Contacts"],"parameters":[{"name":"variable_id","in":"query","description":"Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_name","in":"query","description":"Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.","required":false,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_value","in":"query","description":"Contact's variable value","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/getByVariable"},"summary":"Get contacts by variable (TikTok Contacts)","description":"Returns contacts by variable identifier or variable name for the specified bot","security":[{"bearerAuth":[]}]}},"/tiktok/contacts/send":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/send"},"summary":"Send a message to a contact (TikTok Contacts)","description":"Sends a text message, image, or a file to the contact with the specified contact ID.  To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","items":{"type":"object","properties":{"value":{"type":"string","description":"Free-form object."}}}}}},"example":{"contact_id":"","messages":[]}}}}}},"/tiktok/contacts/setVariable":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/setVariable"},"summary":"Assign a variable to contact (TikTok Contacts)","description":"Adds or updates the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"variables":{"type":"array","description":"api.paths.contacts.setVariable.parameters.variables","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","variables":[]}}}}}},"/tiktok/contacts/deleteVariable":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/deleteVariable"},"summary":"Delete a variable the selected contact (TikTok Contacts)","description":"Delete the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact."},"variable_id":{"type":"string","description":"The ID of the created variable can be obtained via other methods"},"variable_name":{"type":"string","description":"Name of the variable"}}},"example":{"contact_id":"","variable_id":"","variable_name":""}}}}}},"/tiktok/contacts/setTag":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/setTag"},"summary":"Assign a tag to contact (TikTok Contacts)","description":"Assigns tags to the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","tags":[]}}}}}},"/tiktok/contacts/deleteTag":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/deleteTag"},"summary":"Remove a tag from a contact (TikTok Contacts)","description":"Removes the tag for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tag":{"type":"string","description":"Tag, you want to remove","required":true}}},"example":{"contact_id":"","tag":""}}}}}},"/tiktok/contacts/disable":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/disable"},"summary":"Disable contact (TikTok Contacts)","description":"Disables a contact in your audience list. Campaigns and autoflows will not be sent to this contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/tiktok/contacts/enable":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/enable"},"summary":"Enable contact (TikTok Contacts)","description":"Enables a contact in the audience list and contact start receiving campaings and autoflows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/tiktok/contacts/delete":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/delete"},"summary":"Delete contact (TikTok Contacts)","description":"Removes a contact from the audience and subscribers list. The contact can be added back only by subscribing to the bot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/tiktok/contacts/getPauseAutomation":{"get":{"tags":["TikTok Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/getPauseAutomation"},"summary":"Get remaining time for automation pause (TikTok Contacts)","description":"Returns the time remaining until autoflows are stopped for this contact","security":[{"bearerAuth":[]}]}},"/tiktok/contacts/setPauseAutomation":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/setPauseAutomation"},"summary":"Pause autoflows for a contact (TikTok Contacts)","description":"Pauses autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"minutes":{"type":"number","description":"Minutes","required":true}}},"example":{"contact_id":"","minutes":60}}}}}},"/tiktok/contacts/deletePauseAutomation":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/deletePauseAutomation"},"summary":"Resume autoflows for a contact (TikTok Contacts)","description":"Resumes autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/tiktok/contacts/notes":{"get":{"tags":["TikTok Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/notes"},"summary":"Get a list of contact's operator notes (TikTok Contacts)","description":"Returns a list of existing operator notes by contact","security":[{"bearerAuth":[]}]}},"/tiktok/contacts/createNote":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/createNote"},"summary":"Send operator note (TikTok Contacts)","description":"Sends operator note about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true}}},"example":{"contact_id":"","bot_id":"","text":""}}}}}},"/tiktok/contacts/updateNote":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/updateNote"},"summary":"Update operator note (TikTok Contacts)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","text":"","note_id":""}}}}}},"/tiktok/contacts/deleteNote":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/deleteNote"},"summary":"Update operator note (TikTok Contacts 11)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","note_id":""}}}}}},"/tiktok/contacts/operators/assign":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/operators/assign"},"summary":"Assign a responsible for the chat. (TikTok Contacts)","description":"Sets the specified operator as responsible for the chat. You can find the operator's ID in the https://login.sendpulse.com/settings/#users section.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"operator_id":{"type":"number","description":"The ID of the operator to assign","required":true}}},"example":{"contact_id":"","operator_id":""}}}}}},"/tiktok/contacts/operators/unAssign":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/operators/unAssign"},"summary":"Unassign responsible operators for the chat. (TikTok Contacts)","description":"Removes any assigned operator for the chat.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/tiktok/contacts/mark-read":{"put":{"tags":["TikTok Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact’s ID for set unread count as 0","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/mark-read"},"summary":"Mark messages as read (TikTok Contacts)","description":"Mark contact all messages as read (set unread count 0)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/tiktok/contacts/mark-unread":{"put":{"tags":["TikTok Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose last message will be marked as unread.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/mark-unread"},"summary":"Mark a chat with the contact as unread (TikTok Contacts)","description":"Marks the last message of a specific contact as unread.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/tiktok/contacts/openChat":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/openChat"},"summary":"Open chat for a contact (TikTok Contacts)","description":"Increase the chat priority by marking it as open","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/tiktok/contacts/closeChat":{"post":{"tags":["TikTok Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/contacts/closeChat"},"summary":"Close chat for a contact (TikTok Contacts)","description":"Close the chat and lower the priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/tiktok/flows":{"get":{"tags":["TikTok Flows"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/flows"},"summary":"Get a list of flows (TikTok Flows)","description":"Returns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date","security":[{"bearerAuth":[]}]}},"/tiktok/flows/run":{"post":{"tags":["TikTok Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/flows/run"},"summary":"Run a flow by its ID (TikTok Flows)","description":"Launches the selected flow for the selected contact. Additional data can be passed to the \"external_data\" field and used once in the selected chain, where variables will be inserted in the \"Message\" element as a JSON path, for example {{$['tracking_number']}}.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"flow_id":{"type":"string","description":"Flow ID to be launched. Can be obtained with the method of obtaining the list of flows","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","flow_id":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/tiktok/flows/runByTrigger":{"post":{"tags":["TikTok Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/flows/runByTrigger"},"summary":"Run a flow by trigger keywords (TikTok Flows)","description":"Launches a flow with the trigger keyword for the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"trigger_keyword":{"type":"string","description":"Keyword (command) that launch the flow","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","trigger_keyword":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/tiktok/triggers":{"get":{"tags":["TikTok Triggers"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/triggers"},"summary":"Get a list of triggers (TikTok Triggers)","description":"Returns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date","security":[{"bearerAuth":[]}]}},"/tiktok/bots":{"get":{"tags":["TikTok Bots"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/bots"},"summary":"Get a list of connected bots (TikTok Bots)","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/tiktok/bots/statistics":{"get":{"tags":["TikTok Bots"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/bots/statistics"},"summary":"Get general statistics info by bot (TikTok Bots)","description":"Returns general statistics info by bot","security":[{"bearerAuth":[]}]}},"/tiktok/chats":{"get":{"tags":["TikTok Chats"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"size","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/chats"},"summary":"Get a list of chats (TikTok Chats)","description":"Returns a list of chats with subscribers with information about the contact and the last message received from the contact","security":[{"bearerAuth":[]}]}},"/tiktok/chats/messages":{"get":{"tags":["TikTok Chats"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"search_after","in":"query","description":"The id of element after which elements will be searched","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/chats/messages"},"summary":"Get a list of messages (TikTok Chats)","description":"Returns a list of all messages in correspondence with the specified subscriber","security":[{"bearerAuth":[]}]}},"/tiktok/variables":{"get":{"tags":["TikTok Variables"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/variables"},"summary":"Get a list of variables (TikTok Variables)","description":"Returns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date","security":[{"bearerAuth":[]}]}},"/tiktok/campaigns/send":{"post":{"tags":["TikTok Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/campaigns/send"},"summary":"Send campaign (TikTok Campaigns)","description":"Sends a campaign to all of a bot's subscribers. You can send a campaign with text, an image, or a file. To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"Campaign title","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"send_at":{"type":"string","description":"Specify the date and time in the format Y-m-d H:i if you need to schedule the campaign, if you do not specify this parameter, the campaign will be sent immediately"},"filter":{"type":"object","description":"Filter for campaign sending","properties":{"type":{"type":"string","description":"Filter type (and/or)"},"expressions":{"type":"array","description":"Filter expressions"}}},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"Free-form object."}}}}}},"example":{"title":"","bot_id":"","send_at":"Y-m-d H:i","filter":{},"messages":[]}}}}}},"/tiktok/tags":{"get":{"tags":["TikTok Tags"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/tags"},"summary":"Get a list of tags (TikTok Tags)","description":"Returns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date","security":[{"bearerAuth":[]}]}},"/tiktok/account":{"get":{"tags":["TikTok Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/tiktok.yaml","api_endpoint":"https://api.sendpulse.com/tiktok/account"},"summary":"Get account info (TikTok Account)","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/viber/chatbots/contacts/get":{"get":{"tags":["Viber Contacts"],"parameters":[{"name":"id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/get"},"summary":"Get contact info via a contact ID (Viber Contacts)","description":"Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/viber/chatbots/contacts/getByTag":{"get":{"tags":["Viber Contacts"],"parameters":[{"name":"tag","in":"query","description":"Created contact’s tag to search by","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/getByTag"},"summary":"Get a list of contacts by tag (Viber Contacts)","description":"Returns a list of contacts by tag for the specified bot","security":[{"bearerAuth":[]}]}},"/viber/chatbots/contacts/getByVariable":{"get":{"tags":["Viber Contacts"],"parameters":[{"name":"variable_id","in":"query","description":"Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_name","in":"query","description":"Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.","required":false,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_value","in":"query","description":"Contact's variable value","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/getByVariable"},"summary":"Get contacts by variable (Viber Contacts)","description":"Returns contacts by variable identifier or variable name for the specified bot","security":[{"bearerAuth":[]}]}},"/viber/chatbots/contacts/send":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/send"},"summary":"Send a message to a contact (Viber Contacts)","description":"Sends a text message, image, or a file to the contact with the specified contact ID.  To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","items":{"type":"object","properties":{"value":{"type":"string","description":"Free-form object."}}}}}},"example":{"contact_id":"","messages":[]}}}}}},"/viber/chatbots/contacts/setVariable":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/setVariable"},"summary":"Assign a variable to contact (Viber Contacts)","description":"Adds or updates the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"variables":{"type":"array","description":"api.paths.contacts.setVariable.parameters.variables","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","variables":[]}}}}}},"/viber/chatbots/contacts/deleteVariable":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/deleteVariable"},"summary":"Delete a variable the selected contact (Viber Contacts)","description":"Delete the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact."},"variable_id":{"type":"string","description":"The ID of the created variable can be obtained via other methods"},"variable_name":{"type":"string","description":"Name of the variable"}}},"example":{"contact_id":"","variable_id":"","variable_name":""}}}}}},"/viber/chatbots/contacts/setTag":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/setTag"},"summary":"Assign a tag to contact (Viber Contacts)","description":"Assigns tags to the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","tags":[]}}}}}},"/viber/chatbots/contacts/deleteTag":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/deleteTag"},"summary":"Remove a tag from a contact (Viber Contacts)","description":"Removes the tag for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tag":{"type":"string","description":"Tag, you want to remove","required":true}}},"example":{"contact_id":"","tag":""}}}}}},"/viber/chatbots/contacts/disable":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/disable"},"summary":"Disable contact (Viber Contacts)","description":"Disables a contact in your audience list. Campaigns and autoflows will not be sent to this contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/viber/chatbots/contacts/enable":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/enable"},"summary":"Enable contact (Viber Contacts)","description":"Enables a contact in the audience list and contact start receiving campaings and autoflows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/viber/chatbots/contacts/delete":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/delete"},"summary":"Delete contact (Viber Contacts)","description":"Removes a contact from the audience and subscribers list. The contact can be added back only by subscribing to the bot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/viber/chatbots/contacts/getPauseAutomation":{"get":{"tags":["Viber Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/getPauseAutomation"},"summary":"Get remaining time for automation pause (Viber Contacts)","description":"Returns the time remaining until autoflows are stopped for this contact","security":[{"bearerAuth":[]}]}},"/viber/chatbots/contacts/setPauseAutomation":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/setPauseAutomation"},"summary":"Pause autoflows for a contact (Viber Contacts)","description":"Pauses autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"minutes":{"type":"number","description":"Minutes","required":true}}},"example":{"contact_id":"","minutes":60}}}}}},"/viber/chatbots/contacts/deletePauseAutomation":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/deletePauseAutomation"},"summary":"Resume autoflows for a contact (Viber Contacts)","description":"Resumes autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/viber/chatbots/contacts/notes":{"get":{"tags":["Viber Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/notes"},"summary":"Get a list of contact's operator notes (Viber Contacts)","description":"Returns a list of existing operator notes by contact","security":[{"bearerAuth":[]}]}},"/viber/chatbots/contacts/createNote":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/createNote"},"summary":"Send operator note (Viber Contacts)","description":"Sends operator note about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true}}},"example":{"contact_id":"","bot_id":"","text":""}}}}}},"/viber/chatbots/contacts/updateNote":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/updateNote"},"summary":"Update operator note (Viber Contacts)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","text":"","note_id":""}}}}}},"/viber/chatbots/contacts/deleteNote":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/deleteNote"},"summary":"Update operator note (Viber Contacts 13)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","note_id":""}}}}}},"/viber/chatbots/contacts/operators/assign":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/operators/assign"},"summary":"Assign a responsible for the chat. (Viber Contacts)","description":"Sets the specified operator as responsible for the chat. You can find the operator's ID in the https://login.sendpulse.com/settings/#users section.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"operator_id":{"type":"number","description":"The ID of the operator to assign","required":true}}},"example":{"contact_id":"","operator_id":""}}}}}},"/viber/chatbots/contacts/operators/unAssign":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/operators/unAssign"},"summary":"Unassign responsible operators for the chat. (Viber Contacts)","description":"Removes any assigned operator for the chat.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/viber/chatbots/contacts/mark-read":{"put":{"tags":["Viber Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact’s ID for set unread count as 0","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/mark-read"},"summary":"Mark messages as read (Viber Contacts)","description":"Mark contact all messages as read (set unread count 0)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/viber/chatbots/contacts/mark-unread":{"put":{"tags":["Viber Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose last message will be marked as unread.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/mark-unread"},"summary":"Mark a chat with the contact as unread (Viber Contacts)","description":"Marks the last message of a specific contact as unread.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/viber/chatbots/contacts/openChat":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/openChat"},"summary":"Open chat for a contact (Viber Contacts)","description":"Increase the chat priority by marking it as open","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/viber/chatbots/contacts/closeChat":{"post":{"tags":["Viber Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/contacts/closeChat"},"summary":"Close chat for a contact (Viber Contacts)","description":"Close the chat and lower the priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/viber/chatbots/flows":{"get":{"tags":["Viber Flows"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/flows"},"summary":"Get a list of flows (Viber Flows)","description":"Returns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date","security":[{"bearerAuth":[]}]}},"/viber/chatbots/flows/run":{"post":{"tags":["Viber Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/flows/run"},"summary":"Run a flow by its ID (Viber Flows)","description":"Launches the selected flow for the selected contact. Additional data can be passed to the \"external_data\" field and used once in the selected chain, where variables will be inserted in the \"Message\" element as a JSON path, for example {{$['tracking_number']}}.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"flow_id":{"type":"string","description":"Flow ID to be launched. Can be obtained with the method of obtaining the list of flows","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","flow_id":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/viber/chatbots/flows/runByTrigger":{"post":{"tags":["Viber Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/flows/runByTrigger"},"summary":"Run a flow by trigger keywords (Viber Flows)","description":"Launches a flow with the trigger keyword for the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"trigger_keyword":{"type":"string","description":"Keyword (command) that launch the flow","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","trigger_keyword":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/viber/chatbots/triggers":{"get":{"tags":["Viber Triggers"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/triggers"},"summary":"Get a list of triggers (Viber Triggers)","description":"Returns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date","security":[{"bearerAuth":[]}]}},"/viber/chatbots/bots":{"get":{"tags":["Viber Bots"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/bots"},"summary":"Get a list of connected bots (Viber Bots)","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/viber/chatbots/bots/statistics":{"get":{"tags":["Viber Bots"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/bots/statistics"},"summary":"Get general statistics info by bot (Viber Bots)","description":"Returns general statistics info by bot","security":[{"bearerAuth":[]}]}},"/viber/chatbots/chats":{"get":{"tags":["Viber Chats"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"size","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/chats"},"summary":"Get a list of chats (Viber Chats)","description":"Returns a list of chats with subscribers with information about the contact and the last message received from the contact","security":[{"bearerAuth":[]}]}},"/viber/chatbots/chats/messages":{"get":{"tags":["Viber Chats"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"search_after","in":"query","description":"The id of element after which elements will be searched","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/chats/messages"},"summary":"Get a list of messages (Viber Chats)","description":"Returns a list of all messages in correspondence with the specified subscriber","security":[{"bearerAuth":[]}]}},"/viber/chatbots/variables":{"get":{"tags":["Viber Variables"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/variables"},"summary":"Get a list of variables (Viber Variables)","description":"Returns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date","security":[{"bearerAuth":[]}]}},"/viber/chatbots/campaigns/send":{"post":{"tags":["Viber Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/campaigns/send"},"summary":"Send campaign (Viber Campaigns)","description":"Sends a campaign to all of a bot's subscribers. You can send a campaign with text, an image, or a file. To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"Campaign title","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"send_at":{"type":"string","description":"Specify the date and time in the format Y-m-d H:i if you need to schedule the campaign, if you do not specify this parameter, the campaign will be sent immediately"},"filter":{"type":"object","description":"Filter for campaign sending","properties":{"type":{"type":"string","description":"Filter type (and/or)"},"expressions":{"type":"array","description":"Filter expressions"}}},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"Free-form object."}}}}}},"example":{"title":"","bot_id":"","send_at":"Y-m-d H:i","filter":{},"messages":[]}}}}}},"/viber/chatbots/tags":{"get":{"tags":["Viber Tags"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/tags"},"summary":"Get a list of tags (Viber Tags)","description":"Returns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date","security":[{"bearerAuth":[]}]}},"/viber/chatbots/account":{"get":{"tags":["Viber Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/viber-chatbot.yaml","api_endpoint":"https://api.sendpulse.com/viber/chatbots/account"},"summary":"Get account info (Viber Account)","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/whatsapp/contacts":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts"},"summary":"Create new contact","description":"Creates a new contact in the audience of the selected bot","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone":{"type":"string","description":"Phone number in international format","required":true},"name":{"type":"string","description":"Contact name"},"bot_id":{"type":"string","description":"Bot's ID to which you add a contact","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","items":{"type":"string"}},"variables":{"type":"array","description":"The set of additional parameters differs depending on the included template components and can include variables, an image, or a file.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"value":{"type":"string","description":"Value"}}}}}},"example":{"phone":"","name":"","bot_id":"","tags":[],"variables":[]}}}}}},"/whatsapp/contacts/get":{"get":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/get"},"summary":"Get contact info via a contact ID (WhatsApp Contacts)","description":"Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/whatsapp/contacts/getByPhone":{"get":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"phone","in":"query","description":"Contact's phone number in international format.","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/getByPhone"},"summary":"Get contact info by phone number","description":"Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added","security":[{"bearerAuth":[]}]}},"/whatsapp/contacts/getByTag":{"get":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"tag","in":"query","description":"Created contact’s tag to search by","required":true,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/getByTag"},"summary":"Get a list of contacts by tag (WhatsApp Contacts)","description":"Returns a list of contacts by tag for the specified bot","security":[{"bearerAuth":[]}]}},"/whatsapp/contacts/getByVariable":{"get":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"variable_id","in":"query","description":"Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_name","in":"query","description":"Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.","required":false,"schema":{"type":"string","example":""}},{"name":"bot_id","in":"query","description":"Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":false,"schema":{"type":"string","example":""}},{"name":"variable_value","in":"query","description":"Contact's variable value","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/getByVariable"},"summary":"Get contacts by variable (WhatsApp Contacts)","description":"Returns contacts by variable identifier or variable name for the specified bot","security":[{"bearerAuth":[]}]}},"/whatsapp/contacts/mark-read":{"put":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact’s ID for set unread count as 0","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/mark-read"},"summary":"Mark messages as read (WhatsApp Contacts)","description":"Mark contact all messages as read (set unread count 0)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/contacts/mark-unread":{"put":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose last message will be marked as unread.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/mark-unread"},"summary":"Mark a chat with the contact as unread (WhatsApp Contacts)","description":"Marks the last message of a specific contact as unread.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/contacts/send":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/send"},"summary":"Send a message to a contact (WhatsApp Contacts)","description":"Sends a text message, image, or a file to contact with the specified contact ID. To view an example of the request body, select a message type from the drop-down list. \n\n You can also use the original data structures specified in Meta\\'s documentation https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-messages by specifying the correct 'type' and the corresponding data structure for that type.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"message":{"type":"object","description":"Message to send, specifying the type and content of the campaign","required":true,"properties":{"type":{"type":"string","description":"Message type, can have the values \"text,\" \"image,\" or \"document\"","enum":["text","image","document","audio","interactive","reaction"]},"text":{"type":"object","description":"Text"},"image":{"type":"object","description":"The image you want to send. Includes the URL to the image and caption"},"file":{"type":"object","description":"The file you want to send. Includes the URL to the image and caption"},"audio":{"type":"object","description":"The audio you want to send. Includes the URL to the audio"},"interactive":{"type":"object","description":"The interactive object you want to send. Includes the buttons and text"},"reaction":{"type":"object","description":"Reaction to a message"}}}}},"example":{"contact_id":"","message":{}}}}}}},"/whatsapp/contacts/sendByPhone":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/sendByPhone"},"summary":"Send a free message to a contact by phone number","description":"Sends a message to the active contact with the specified phone number. You can send a text message, an image, or a file. To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bot_id":{"type":"string","description":"Bot ID to whose audience you are sending a message. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"phone":{"type":"string","description":"Contact's phone number in international format.","required":true},"message":{"type":"object","description":"Message to send, specifying the type and content of the campaign","required":true,"properties":{"type":{"type":"string","description":"Message type, can have the values \"text,\" \"image,\" or \"document\"","enum":["text","image","document","audio"]},"text":{"type":"object","description":"Text"},"image":{"type":"object","description":"The image you want to send. Includes the URL to the image and caption"},"file":{"type":"object","description":"The file you want to send. Includes the URL to the image and caption"},"audio":{"type":"object","description":"The audio you want to send. Includes the URL to the audio"},"interactive":{"type":"object","description":"The interactive object you want to send. Includes the buttons and text"}}}}},"example":{"bot_id":"","phone":"380631112233","message":{}}}}}}},"/whatsapp/contacts/sendTemplate":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/sendTemplate"},"summary":"Send a template message to the specified contact","description":"Sends a pre-approved template message to the contact with the specified contact ID. You can send a template with variables, buttons, image, or document headers. To view an example of the request body, select a message template from the drop-down list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"template":{"type":"object","description":"Content of the template. To get a template code in your account, go to the \"Templates\" tab of your bot and, opposite the desired template, click \"Copy code.\" In the opened window, copy the value of the \"template\" parameter.","required":true,"properties":{"name":{"type":"string","description":"Template name"},"language":{"type":"object","description":"Template language"},"components":{"type":"array","description":"The set of additional parameters differs depending on the included template components and can include variables, an image, or a file."}}}}},"example":{"contact_id":"","template":{}}}}}}},"/whatsapp/contacts/sendTemplateByPhone":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/sendTemplateByPhone"},"summary":"Send a template message to a contact by phone number","description":"Sends a pre-approved template message to a new or existing contact with the specified phone number. You can send a template with variables, buttons, image, or document headers. To view an example of the request body, select a message template from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bot_id":{"type":"string","description":"Bot ID to whose audience you are sending a message. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"phone":{"type":"string","description":"Contact's phone number in international format.","required":true},"template":{"type":"object","description":"Content of the template. To get a template code in your account, go to the \"Templates\" tab of your bot and, opposite the desired template, click \"Copy code.\" In the opened window, copy the value of the \"template\" parameter.","required":true,"properties":{"name":{"type":"string","description":"Template name"},"language":{"type":"object","description":"Template language"},"components":{"type":"array","description":"The set of additional parameters differs depending on the included template components and can include variables, an image, or a file."}}}}},"example":{"bot_id":"","phone":"","template":{}}}}}}},"/whatsapp/contacts/sendTyping":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/sendTyping"},"summary":"Send typing indicator (WhatsApp Contacts)","description":"Initiate typing indicator for the specified contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"The unique identifier of the contact to whom the typing indicator will be sent.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/contacts/setVariable":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/setVariable"},"summary":"Assign a variable to contact (WhatsApp Contacts)","description":"Adds or updates the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"variables":{"type":"array","description":"api.paths.contacts.setVariable.parameters.variables","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","variables":[]}}}}}},"/whatsapp/contacts/deleteVariable":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/deleteVariable"},"summary":"Delete a variable the selected contact (WhatsApp Contacts)","description":"Delete the value of a variable for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact."},"variable_id":{"type":"string","description":"The ID of the created variable can be obtained via other methods"},"variable_name":{"type":"string","description":"Name of the variable"}}},"example":{"contact_id":"","variable_id":"","variable_name":""}}}}}},"/whatsapp/contacts/setTag":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/setTag"},"summary":"Assign a tag to contact (WhatsApp Contacts)","description":"Assigns tags to the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tags":{"type":"array","description":"List of tags to assign to the contact","required":true,"items":{"type":"string"}}}},"example":{"contact_id":"","tags":[]}}}}}},"/whatsapp/contacts/deleteTag":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/deleteTag"},"summary":"Remove a tag from a contact (WhatsApp Contacts)","description":"Removes the tag for the selected contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"tag":{"type":"string","description":"Tag, you want to remove","required":true}}},"example":{"contact_id":"","tag":""}}}}}},"/whatsapp/contacts/disable":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/disable"},"summary":"Disable contact (WhatsApp Contacts)","description":"Disables a contact in your audience list. Campaigns and autoflows will not be sent to this contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/contacts/enable":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/enable"},"summary":"Enable contact (WhatsApp Contacts)","description":"Enables a contact in the audience list and contact start receiving campaings and autoflows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/contacts/delete":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/delete"},"summary":"Delete contact (WhatsApp Contacts)","description":"Removes a contact from the audience and subscribers list. The contact can be added back only by subscribing to the bot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/contacts/getPauseAutomation":{"get":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/getPauseAutomation"},"summary":"Get remaining time for automation pause (WhatsApp Contacts)","description":"Returns the time remaining until autoflows are stopped for this contact","security":[{"bearerAuth":[]}]}},"/whatsapp/contacts/setPauseAutomation":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/setPauseAutomation"},"summary":"Pause autoflows for a contact (WhatsApp Contacts)","description":"Pauses autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"minutes":{"type":"number","description":"Minutes","required":true}}},"example":{"contact_id":"","minutes":60}}}}}},"/whatsapp/contacts/deletePauseAutomation":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/deletePauseAutomation"},"summary":"Resume autoflows for a contact (WhatsApp Contacts)","description":"Resumes autoflows for the specified contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/contacts/notes":{"get":{"tags":["WhatsApp Contacts"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/notes"},"summary":"Get a list of contact's operator notes (WhatsApp Contacts)","description":"Returns a list of existing operator notes by contact","security":[{"bearerAuth":[]}]}},"/whatsapp/contacts/createNote":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/createNote"},"summary":"Send operator note (WhatsApp Contacts)","description":"Sends operator note about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true}}},"example":{"contact_id":"","bot_id":"","text":""}}}}}},"/whatsapp/contacts/updateNote":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/updateNote"},"summary":"Update operator note (WhatsApp Contacts)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"text":{"type":"string","description":"Text of note","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","text":"","note_id":""}}}}}},"/whatsapp/contacts/deleteNote":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/deleteNote"},"summary":"Update operator note (WhatsApp Contacts 15)","description":"Updates existing operator notes about contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"note_id":{"type":"string","description":"Note ID.","required":true}}},"example":{"contact_id":"","bot_id":"","note_id":""}}}}}},"/whatsapp/contacts/operators/assign":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/operators/assign"},"summary":"Assign a responsible for the chat. (WhatsApp Contacts)","description":"Sets the specified operator as responsible for the chat. You can find the operator's ID in the https://login.sendpulse.com/settings/#users section.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"operator_id":{"type":"number","description":"The ID of the operator to assign","required":true}}},"example":{"contact_id":"","operator_id":""}}}}}},"/whatsapp/contacts/operators/unAssign":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/operators/unAssign"},"summary":"Unassign responsible operators for the chat. (WhatsApp Contacts)","description":"Removes any assigned operator for the chat.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/contacts/setName":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/setName"},"summary":"Set the contact's name (WhatsApp Contacts)","description":"Updates the display name of the specified contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"The unique identifier of the contact. You can obtain this via a contact search by certain criteria or retrieve it from the address bar of the contact’s chat window in your account.","required":true},"name":{"type":"string","description":"The new name to assign to the contact.","required":true}}},"example":{"contact_id":"","name":""}}}}}},"/whatsapp/contacts/openChat":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/openChat"},"summary":"Open chat for a contact (WhatsApp Contacts)","description":"Increase the chat priority by marking it as open","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/contacts/closeChat":{"post":{"tags":["WhatsApp Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/contacts/closeChat"},"summary":"Close chat for a contact (WhatsApp Contacts)","description":"Close the chat and lower the priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true}}},"example":{"contact_id":""}}}}}},"/whatsapp/flows":{"get":{"tags":["WhatsApp Flows"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/flows"},"summary":"Get a list of flows (WhatsApp Flows)","description":"Returns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date","security":[{"bearerAuth":[]}]}},"/whatsapp/flows/run":{"post":{"tags":["WhatsApp Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/flows/run"},"summary":"Run a flow by its ID (WhatsApp Flows)","description":"Launches the selected flow for the selected contact. Additional data can be passed to the \"external_data\" field and used once in the selected chain, where variables will be inserted in the \"Message\" element as a JSON path, for example {{$['tracking_number']}}.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"flow_id":{"type":"string","description":"Flow ID to be launched. Can be obtained with the method of obtaining the list of flows","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","flow_id":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/whatsapp/flows/runByTrigger":{"post":{"tags":["WhatsApp Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/flows/runByTrigger"},"summary":"Run a flow by trigger keywords (WhatsApp Flows)","description":"Launches a flow with the trigger keyword for the selected contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"trigger_keyword":{"type":"string","description":"Keyword (command) that launch the flow","required":true},"external_data":{"type":"object","description":"Custom variables. You can pass variable values in the request and use them once in the flow you selected. To add variables to the flow, in the Message element, insert the variable names as a JSON path expression {{$['somekey']['nestedkey']}}.","properties":{"value":{"type":"string","description":"Free-form object."}}}}},"example":{"contact_id":"","trigger_keyword":"","external_data":{"tracking_number":"1234-0987-5678-9012"}}}}}}},"/whatsapp/triggers":{"get":{"tags":["WhatsApp Triggers"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/triggers"},"summary":"Get a list of triggers (WhatsApp Triggers)","description":"Returns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date","security":[{"bearerAuth":[]}]}},"/whatsapp/bots":{"get":{"tags":["WhatsApp Bots"],"parameters":[{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/bots"},"summary":"Get a list of connected bots (WhatsApp Bots)","description":"Returns lists of bots with information about each: bot ID, channel information, number of received and unread messages, bot status, and creation date","security":[{"bearerAuth":[]}]}},"/whatsapp/bots/statistics":{"get":{"tags":["WhatsApp Bots"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/bots/statistics"},"summary":"Get general statistics info by bot (WhatsApp Bots)","description":"Returns general statistics info by bot","security":[{"bearerAuth":[]}]}},"/whatsapp/chats":{"get":{"tags":["WhatsApp Chats"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"size","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/chats"},"summary":"Get a list of chats (WhatsApp Chats)","description":"Returns a list of chats with subscribers with information about the contact and the last message received from the contact","security":[{"bearerAuth":[]}]}},"/whatsapp/chats/messages":{"get":{"tags":["WhatsApp Chats"],"parameters":[{"name":"contact_id","in":"query","description":"Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}},{"name":"search_after","in":"query","description":"The id of element after which elements will be searched","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order ASC or DESC","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/chats/messages"},"summary":"Get a list of messages (WhatsApp Chats)","description":"Returns a list of all messages in correspondence with the specified subscriber","security":[{"bearerAuth":[]}]}},"/whatsapp/chats/react":{"put":{"tags":["WhatsApp Chats"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/chats/react"},"summary":"React to a message (WhatsApp Chats)","description":"Send a reaction (e.g. an emoji) to a specific message of a contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message_id":{"type":"string","description":"The ID of the message to react to.","required":true},"reaction":{"type":"string","description":"Unicode escape sequence of the emoji, or the emoji itself, to apply to the user message.","required":true}}},"example":{"message_id":"","reaction":"👍"}}}}}},"/whatsapp/variables":{"get":{"tags":["WhatsApp Variables"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/variables"},"summary":"Get a list of variables (WhatsApp Variables)","description":"Returns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date","security":[{"bearerAuth":[]}]}},"/whatsapp/campaigns/send":{"post":{"tags":["WhatsApp Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/campaigns/send"},"summary":"Send campaign (WhatsApp Campaigns)","description":"Sends a campaign to all of a bot's subscribers that were active within the last 24 hours. You can send a campaign with text, an image, or a file. To view an example of the request body, select a message type from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"Campaign title","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"send_at":{"type":"string","description":"Specify the date and time in the format Y-m-d H:i if you need to schedule the campaign, if you do not specify this parameter, the campaign will be sent immediately"},"filter":{"type":"object","description":"Filter for campaign sending","properties":{"type":{"type":"string","description":"Filter type (and/or)"},"expressions":{"type":"array","description":"Filter expressions"}}},"messages":{"type":"array","description":"Message to send, specifying the type and content of the campaign","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"api.paths.contacts.sendText.parameters.message_type","enum":["text","image","document"]},"text":{"type":"object","description":"Text"},"image":{"type":"object","description":"api.paths.contacts.sendText.parameters.image"},"file":{"type":"object","description":"api.paths.contacts.sendText.parameters.file"}}}}}},"example":{"title":"","bot_id":"","send_at":"Y-m-d H:i","filter":{},"messages":[]}}}}}},"/whatsapp/campaigns/sendTemplate":{"post":{"tags":["WhatsApp Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/campaigns/sendTemplate"},"summary":"Send a campaign by template","description":"Sends a template message to all of a bot's subsribers. You can send a campaign with text, an image, or a file. To view an example of the request body, select a message template from the drop-down list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"Campaign title","required":true},"bot_id":{"type":"string","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true},"send_at":{"type":"string","description":"Specify the date and time in the format Y-m-d H:i if you need to schedule the campaign, if you do not specify this parameter, the campaign will be sent immediately"},"template":{"type":"object","description":"Content of the template. To get a template code in your account, go to the \"Templates\" tab of your bot and, opposite the desired template, click \"Copy code.\" In the opened window, copy the value of the \"template\" parameter.","required":true,"properties":{"name":{"type":"string","description":"Template name"},"language":{"type":"object","description":"Template language"},"components":{"type":"array","description":"The set of additional parameters differs depending on the included template components and can include variables, an image, or a file."}}}}},"example":{"title":"","bot_id":"","send_at":"Y-m-d H:i","template":{}}}}}}},"/whatsapp/account":{"get":{"tags":["WhatsApp Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/account"},"summary":"Get account info (WhatsApp Account)","description":"Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables","security":[{"bearerAuth":[]}]}},"/whatsapp/templates":{"get":{"tags":["WhatsApp Templates"],"parameters":[{"name":"bot_id","in":"query","description":"The bot ID where the templates are located. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/templates"},"summary":"Get a template list","description":"Returns a list of templates with information about each template","security":[{"bearerAuth":[]}]}},"/whatsapp/tags":{"get":{"tags":["WhatsApp Tags"],"parameters":[{"name":"bot_id","in":"query","description":"Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.","required":true,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"The limit of pagination items, that will be returned","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"The offset of pagination items, where starts a current items batch","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.sendpulse.com/.well-known/openapi/whatsapp.yaml","api_endpoint":"https://api.sendpulse.com/whatsapp/tags"},"summary":"Get a list of tags (WhatsApp Tags)","description":"Returns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}