Cancel activation wait
Ends a code request that is still WAITING — no body — so the next POST /v1/phone-lines/{id}/activations is accepted at once instead of answering 409 ACTIVATION_IN_PROGRESS until the window closes.
Answers 200 with the request, now TIMED_OUT with failureReason: "canceled_by_customer", sent with Cache-Control: no-store. The line is no longer watched for that request. Like any request that ends without a code, it sends phone_line.code_failed and phone_line.code_received (with code: null) once, with canceled_by_customer.
A call that already arrived is never thrown away. Once the call is captured the request is no longer WAITING, and the cancel answers 409 ACTIVATION_NOT_WAITING — keep polling: its code is being read. The same 409 answers a request that already ended. Nothing changes in either case. {id} must be the line the request belongs to: a line that is not in your workspace answers 404 LINE_NOT_FOUND; a request that is not on that line — or not in your workspace — answers 404 ACTIVATION_NOT_FOUND.
Requires a tenant-scoped key — a number-scoped key (or per-number OAuth grant) gets 403 NUMBER_SCOPE_NOT_ALLOWED. Permission phone_lines:read: with an OAuth / MCP token the user must be an Owner or Admin (403 PERMISSION_DENIED otherwise).
curl --request POST \
--url https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel"
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://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel', 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://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel",
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://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel"
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))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
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{
"activation": {
"id": "cmg5k3a7c0002ac8example4q",
"lineId": "cmg5k2l1n0001pl8example9x",
"status": "TIMED_OUT",
"requestedAt": "2026-10-01T14:10:00.000Z",
"pollDeadline": "2026-10-01T14:15:00.000Z",
"code": null,
"capturedAt": null,
"transcribedAt": null,
"failureReason": "canceled_by_customer",
"hasAudio": false
}
}Authorizations
Your ps_ API key
Path Parameters
The line the request belongs to. A request that is not on this line answers 404 ACTIVATION_NOT_FOUND.
The code request id (activation.id, returned by POST /v1/phone-lines/{id}/activations).
Response
Wait cancelled — the request is now TIMED_OUT with canceled_by_customer. Sent with Cache-Control: no-store.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel"
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://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel', 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://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel",
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://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel"
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))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
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{
"activation": {
"id": "cmg5k3a7c0002ac8example4q",
"lineId": "cmg5k2l1n0001pl8example9x",
"status": "TIMED_OUT",
"requestedAt": "2026-10-01T14:10:00.000Z",
"pollDeadline": "2026-10-01T14:15:00.000Z",
"code": null,
"capturedAt": null,
"transcribedAt": null,
"failureReason": "canceled_by_customer",
"hasAudio": false
}
}