Cancel operation

curl --request POST \
  --url https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/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://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "cancellable": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "operationId": "<string>",
  "projectId": "<string>",
  "resourceType": "<string>",
  "state": "pending",
  "type": "resource.provision",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "detail": {},
  "endedAt": "2026-01-01T00:00:00.000Z",
  "error": {
    "code": "<string>",
    "detail": "<string>"
  },
  "reason": "charge_refused",
  "resourceId": "<string>",
  "startedAt": "2026-01-01T00:00:00.000Z"
}

{
  "code": "NOT_AUTHENTICATED",
  "status": 401,
  "title": "Not Authenticated",
  "type": "https://photon.codes/docs/problems/not-authenticated"
}

{
  "code": "FORBIDDEN",
  "status": 403,
  "title": "Forbidden",
  "type": "https://photon.codes/docs/problems/forbidden"
}

{
  "code": "OPERATION_NOT_FOUND",
  "status": 404,
  "title": "Operation Not Found",
  "type": "https://photon.codes/docs/problems/operation-not-found"
}

{
  "code": "OPERATION_NOT_CANCELLABLE",
  "status": 409,
  "title": "Operation Not Cancellable",
  "type": "https://photon.codes/docs/problems/operation-not-cancellable"
}

{
  "code": "VALIDATION_FAILED",
  "issues": [
    {
      "code": "invalid_type",
      "location": "json",
      "message": "Expected a string.",
      "path": "/name"
    }
  ],
  "status": 422,
  "title": "Request Validation Failed",
  "type": "https://photon.codes/docs/problems/validation-failed"
}

{
  "code": "RATE_LIMITED",
  "status": 429,
  "title": "Too Many Requests",
  "type": "https://photon.codes/docs/problems/rate-limited"
}

{
  "code": "INTERNAL_ERROR",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://photon.codes/docs/problems/internal-error"
}

{
  "code": "UPSTREAM_FAILURE",
  "status": 502,
  "title": "Upstream Service Failure",
  "type": "https://photon.codes/docs/problems/upstream-failure"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "status": 503,
  "title": "Upstream Service Unavailable",
  "type": "https://photon.codes/docs/problems/upstream-unavailable"
}

{
  "code": "REQUEST_TIMEOUT",
  "status": 504,
  "title": "Request Timeout",
  "type": "https://photon.codes/docs/problems/request-timeout"
}

Operations

Cancel operation

Withdraws a provision that has not been fulfilled yet. This is an operations action rather than a DELETE, because there is nothing to delete: no resource exists until the work commits. Whether it is accepted depends on the resource type — a dedicated iMessage line may sit waiting on inventory for hours and withdrawing costs nothing, while an SMS number is cancellable during inventory waiting and answers 409 once the workflow commits to its first provider order. Campaign assignment and detachment operations cannot be cancelled in any state. Wait for completion before requesting another change; that new change is not a guaranteed rollback. The output-only cancellable field is a snapshot; the cancellation transaction always checks the current phase under a row lock. A cancel that loses the race against the work finishing also answers 409: the resource exists and is billed for, so what you want then is to release it. Nothing is charged for a cancelled provision — billing runs after the work, so there is never anything to refund. Requires the platforms:write permission bound to the project resource in the path.

POST

projects

{id}

platforms

operations

{operationId}

cancel

Cancel operation

curl --request POST \
  --url https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/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://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.photon.codes/v1/projects/{id}/platforms/operations/{operationId}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "cancellable": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "operationId": "<string>",
  "projectId": "<string>",
  "resourceType": "<string>",
  "state": "pending",
  "type": "resource.provision",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "detail": {},
  "endedAt": "2026-01-01T00:00:00.000Z",
  "error": {
    "code": "<string>",
    "detail": "<string>"
  },
  "reason": "charge_refused",
  "resourceId": "<string>",
  "startedAt": "2026-01-01T00:00:00.000Z"
}

{
  "code": "NOT_AUTHENTICATED",
  "status": 401,
  "title": "Not Authenticated",
  "type": "https://photon.codes/docs/problems/not-authenticated"
}

{
  "code": "FORBIDDEN",
  "status": 403,
  "title": "Forbidden",
  "type": "https://photon.codes/docs/problems/forbidden"
}

{
  "code": "OPERATION_NOT_FOUND",
  "status": 404,
  "title": "Operation Not Found",
  "type": "https://photon.codes/docs/problems/operation-not-found"
}

{
  "code": "OPERATION_NOT_CANCELLABLE",
  "status": 409,
  "title": "Operation Not Cancellable",
  "type": "https://photon.codes/docs/problems/operation-not-cancellable"
}

{
  "code": "VALIDATION_FAILED",
  "issues": [
    {
      "code": "invalid_type",
      "location": "json",
      "message": "Expected a string.",
      "path": "/name"
    }
  ],
  "status": 422,
  "title": "Request Validation Failed",
  "type": "https://photon.codes/docs/problems/validation-failed"
}

{
  "code": "RATE_LIMITED",
  "status": 429,
  "title": "Too Many Requests",
  "type": "https://photon.codes/docs/problems/rate-limited"
}

{
  "code": "INTERNAL_ERROR",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://photon.codes/docs/problems/internal-error"
}

{
  "code": "UPSTREAM_FAILURE",
  "status": 502,
  "title": "Upstream Service Failure",
  "type": "https://photon.codes/docs/problems/upstream-failure"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "status": 503,
  "title": "Upstream Service Unavailable",
  "type": "https://photon.codes/docs/problems/upstream-unavailable"
}

{
  "code": "REQUEST_TIMEOUT",
  "status": 504,
  "title": "Request Timeout",
  "type": "https://photon.codes/docs/problems/request-timeout"
}

Authorizations

Authorization

string

header

required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Path Parameters

string

required

operationId

string

required

Response

The cancelled operation.

cancellable

boolean

required

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2026-01-01T00:00:00.000Z"

operationId

string

required

projectId

string

required

resourceType

string

required

state

enum<string>

required

Available options:

pending,

running,

succeeded,

failed,

cancelled

type

enum<string>

required

Available options:

resource.provision,

resource.release,

whatsapp.account.disconnect,

sms.campaign.assign,

sms.campaign.unassign

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2026-01-01T00:00:00.000Z"

detail

object

Show child attributes

endedAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2026-01-01T00:00:00.000Z"

error

object

Show child attributes

reason

enum<string>

Available options:

charge_refused,

entitlement_lost,

project_deleted

resourceId

string

startedAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2026-01-01T00:00:00.000Z"

⌘I

Get started

Problems

Endpoints

Event Delivery WebSocket

Event schemas

Cancel operation

Authorizations

Path Parameters

Response