Webchat

Disable webchat auto-conversion

Stops a webchat session from automatically converting into a lead. Use it once your own team has taken the visitor over, for example after a webchat transfer, so Apten doesn’t follow up by SMS or call.

If the session has already converted, nothing changes and the response returns the lead’s ID as leadId. Use Turn off a lead to stop Apten for that lead instead.

A visitor can still ask to be contacted from the chat itself; this only stops the automatic conversion after inactivity.

POST

webchat

sessions

{sessionId}

disableAutoConversion

cURL

curl --request POST \
  --url https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "Auto-conversion disabled.",
  "converted": false,
  "leadId": null
}

Authorizations

x-api-key

string

header

required

Path Parameters

sessionId

string

required

The ID of the webchat session, as sent in webchat webhook events (data.sessionId).

Response

Auto-conversion is disabled, or the session had already converted.

message

string

converted

boolean

true if the session had already converted into a lead, in which case nothing was changed.

leadId

string | null

The ID of the lead the session converted into, or null if it has not converted.

cURL

curl --request POST \
  --url https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.attent.app/v1/webchat/sessions/{sessionId}/disableAutoConversion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "Auto-conversion disabled.",
  "converted": false,
  "leadId": null
}

API Reference

Leads

Calls

Webchat

Tags

Usage

Do Not Contact

Disable webchat auto-conversion

Authorizations

Path Parameters

Response