Execute conversation action
curl --request PUT \
--url https://api.withallo.com/v2/api/conversations/{contact_number}/action \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "READ",
"allo_number": "+14155550100"
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/{contact_number}/action"
payload = {
"action": "READ",
"allo_number": "+14155550100"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'READ', allo_number: '+14155550100'})
};
fetch('https://api.withallo.com/v2/api/conversations/{contact_number}/action', 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.withallo.com/v2/api/conversations/{contact_number}/action",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'READ',
'allo_number' => '+14155550100'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/conversations/{contact_number}/action"
payload := strings.NewReader("{\n \"action\": \"READ\",\n \"allo_number\": \"+14155550100\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.withallo.com/v2/api/conversations/{contact_number}/action")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"READ\",\n \"allo_number\": \"+14155550100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/{contact_number}/action")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"READ\",\n \"allo_number\": \"+14155550100\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Conversations
Execute conversation action
Execute an action on a conversation.
PUT
/
v2
/
api
/
conversations
/
{contact_number}
/
action
Execute conversation action
curl --request PUT \
--url https://api.withallo.com/v2/api/conversations/{contact_number}/action \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "READ",
"allo_number": "+14155550100"
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/{contact_number}/action"
payload = {
"action": "READ",
"allo_number": "+14155550100"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'READ', allo_number: '+14155550100'})
};
fetch('https://api.withallo.com/v2/api/conversations/{contact_number}/action', 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.withallo.com/v2/api/conversations/{contact_number}/action",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'READ',
'allo_number' => '+14155550100'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/conversations/{contact_number}/action"
payload := strings.NewReader("{\n \"action\": \"READ\",\n \"allo_number\": \"+14155550100\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.withallo.com/v2/api/conversations/{contact_number}/action")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"READ\",\n \"allo_number\": \"+14155550100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/{contact_number}/action")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"READ\",\n \"allo_number\": \"+14155550100\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Required scope:
CONVERSATIONS_WRITEAvailable actions
| Action | Effect |
|---|---|
READ | Mark the conversation as read |
UNREAD | Mark the conversation as unread |
ARCHIVE | Archive the conversation and mark all items as read |
UNARCHIVE | Unarchive the conversation |
400 error with code INVALID_ACTION.
Idempotency
All actions are idempotent — callingREAD on an already-read conversation is a no-op and returns 200.
This endpoint also supports the Idempotency-Key header. See Idempotency.
Scoping to a line
Omitallo_number to apply the action across all Allo numbers. Provide it to scope the action to a specific line.Authorizations
Path Parameters
The external phone number in E.164 format. URL-encode the + as %2B.
Example:
"+14155551234"
Body
application/json
Response
Action executed successfully
Was this page helpful?
⌘I