Update a campaign
curl --request PATCH \
--url https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"etag": "<string>",
"updateMask": [],
"description": "<string>",
"embeddedLinkSample": "<string>",
"embeddedLinks": true,
"embeddedPhoneNumbers": true,
"helpKeywords": [
"<string>"
],
"helpMessage": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": [
"<string>"
],
"optInMessage": "<string>",
"optOutKeywords": [
"<string>"
],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"sampleMessages": [
"<string>"
],
"termsAndConditionsUrl": "<string>"
}
'import requests
url = "https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}"
payload = {
"etag": "<string>",
"updateMask": [],
"description": "<string>",
"embeddedLinkSample": "<string>",
"embeddedLinks": True,
"embeddedPhoneNumbers": True,
"helpKeywords": ["<string>"],
"helpMessage": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": ["<string>"],
"optInMessage": "<string>",
"optOutKeywords": ["<string>"],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"sampleMessages": ["<string>"],
"termsAndConditionsUrl": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
etag: '<string>',
updateMask: [],
description: '<string>',
embeddedLinkSample: '<string>',
embeddedLinks: true,
embeddedPhoneNumbers: true,
helpKeywords: ['<string>'],
helpMessage: '<string>',
messageFlow: '<string>',
name: '<string>',
optInKeywords: ['<string>'],
optInMessage: '<string>',
optOutKeywords: ['<string>'],
optOutMessage: '<string>',
privacyPolicyUrl: '<string>',
sampleMessages: ['<string>'],
termsAndConditionsUrl: '<string>'
})
};
fetch('https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}', 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/organizations/{organization_id}/10dlc/campaigns/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'etag' => '<string>',
'updateMask' => [
],
'description' => '<string>',
'embeddedLinkSample' => '<string>',
'embeddedLinks' => true,
'embeddedPhoneNumbers' => true,
'helpKeywords' => [
'<string>'
],
'helpMessage' => '<string>',
'messageFlow' => '<string>',
'name' => '<string>',
'optInKeywords' => [
'<string>'
],
'optInMessage' => '<string>',
'optOutKeywords' => [
'<string>'
],
'optOutMessage' => '<string>',
'privacyPolicyUrl' => '<string>',
'sampleMessages' => [
'<string>'
],
'termsAndConditionsUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}"
payload := strings.NewReader("{\n \"etag\": \"<string>\",\n \"updateMask\": [],\n \"description\": \"<string>\",\n \"embeddedLinkSample\": \"<string>\",\n \"embeddedLinks\": true,\n \"embeddedPhoneNumbers\": true,\n \"helpKeywords\": [\n \"<string>\"\n ],\n \"helpMessage\": \"<string>\",\n \"messageFlow\": \"<string>\",\n \"name\": \"<string>\",\n \"optInKeywords\": [\n \"<string>\"\n ],\n \"optInMessage\": \"<string>\",\n \"optOutKeywords\": [\n \"<string>\"\n ],\n \"optOutMessage\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"sampleMessages\": [\n \"<string>\"\n ],\n \"termsAndConditionsUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"etag\": \"<string>\",\n \"updateMask\": [],\n \"description\": \"<string>\",\n \"embeddedLinkSample\": \"<string>\",\n \"embeddedLinks\": true,\n \"embeddedPhoneNumbers\": true,\n \"helpKeywords\": [\n \"<string>\"\n ],\n \"helpMessage\": \"<string>\",\n \"messageFlow\": \"<string>\",\n \"name\": \"<string>\",\n \"optInKeywords\": [\n \"<string>\"\n ],\n \"optInMessage\": \"<string>\",\n \"optOutKeywords\": [\n \"<string>\"\n ],\n \"optOutMessage\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"sampleMessages\": [\n \"<string>\"\n ],\n \"termsAndConditionsUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"etag\": \"<string>\",\n \"updateMask\": [],\n \"description\": \"<string>\",\n \"embeddedLinkSample\": \"<string>\",\n \"embeddedLinks\": true,\n \"embeddedPhoneNumbers\": true,\n \"helpKeywords\": [\n \"<string>\"\n ],\n \"helpMessage\": \"<string>\",\n \"messageFlow\": \"<string>\",\n \"name\": \"<string>\",\n \"optInKeywords\": [\n \"<string>\"\n ],\n \"optInMessage\": \"<string>\",\n \"optOutKeywords\": [\n \"<string>\"\n ],\n \"optOutMessage\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"sampleMessages\": [\n \"<string>\"\n ],\n \"termsAndConditionsUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"brandId": "<string>",
"capabilities": {
"canResubmit": true,
"editableFields": [
"<string>"
]
},
"createdAt": "2026-01-01T00:00:00.000Z",
"currentStep": "brand_verification",
"description": "<string>",
"embeddedLinks": true,
"embeddedPhoneNumbers": true,
"etag": "<string>",
"failureReasons": [
{
"message": "<string>"
}
],
"hasUnsubmittedChanges": true,
"helpKeywords": [
"<string>"
],
"helpMessage": "<string>",
"id": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": [
"<string>"
],
"optInMessage": "<string>",
"optOutKeywords": [
"<string>"
],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"reviewRevision": 0,
"revision": 0,
"sampleMessages": [
"<string>"
],
"status": "awaiting_brand_verification",
"statusMessage": "<string>",
"submittedRevision": 0,
"subscriberHelp": true,
"subscriberOptIn": true,
"subscriberOptOut": true,
"termsAndConditionsAccepted": true,
"termsAndConditionsUrl": "<string>",
"updatedAt": "2026-01-01T00:00:00.000Z",
"useCases": [
"2FA"
],
"embeddedLinkSample": "<string>",
"readyAt": "2026-01-01T00:00:00.000Z",
"statusReason": {
"code": "<string>",
"message": "<string>"
},
"submittedAt": "2026-01-01T00:00:00.000Z"
}
}{
"campaign": {
"brandId": "<string>",
"capabilities": {
"canResubmit": true,
"editableFields": [
"<string>"
]
},
"createdAt": "2026-01-01T00:00:00.000Z",
"currentStep": "brand_verification",
"description": "<string>",
"embeddedLinks": true,
"embeddedPhoneNumbers": true,
"etag": "<string>",
"failureReasons": [
{
"message": "<string>"
}
],
"hasUnsubmittedChanges": true,
"helpKeywords": [
"<string>"
],
"helpMessage": "<string>",
"id": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": [
"<string>"
],
"optInMessage": "<string>",
"optOutKeywords": [
"<string>"
],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"reviewRevision": 0,
"revision": 0,
"sampleMessages": [
"<string>"
],
"status": "awaiting_brand_verification",
"statusMessage": "<string>",
"submittedRevision": 0,
"subscriberHelp": true,
"subscriberOptIn": true,
"subscriberOptOut": true,
"termsAndConditionsAccepted": true,
"termsAndConditionsUrl": "<string>",
"updatedAt": "2026-01-01T00:00:00.000Z",
"useCases": [
"2FA"
],
"embeddedLinkSample": "<string>",
"readyAt": "2026-01-01T00:00:00.000Z",
"statusReason": {
"code": "<string>",
"message": "<string>"
},
"submittedAt": "2026-01-01T00:00:00.000Z"
}
}{
"code": "IDEMPOTENCY_KEY_REQUIRED",
"status": 400,
"title": "Idempotency Key Required",
"type": "https://photon.codes/docs/problems/idempotency-key-required"
}{
"code": "NOT_AUTHENTICATED",
"status": 401,
"title": "Not Authenticated",
"type": "https://photon.codes/docs/problems/not-authenticated"
}{
"code": "CAMPAIGN_REGISTRATION_PAYMENT_FAILED",
"status": 402,
"title": "Campaign Registration Payment Failed",
"type": "https://photon.codes/docs/problems/campaign-registration-payment-failed",
"detail": "<string>",
"failureDetail": "<string>",
"instance": "<string>",
"remediation": "<unknown>",
"requestId": "<string>"
}{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"type": "https://photon.codes/docs/problems/forbidden"
}{
"code": "BRAND_NOT_FOUND",
"status": 404,
"title": "Brand Not Found",
"type": "https://photon.codes/docs/problems/brand-not-found"
}{
"code": "IDEMPOTENCY_CONFLICT",
"status": 409,
"title": "Idempotency Conflict",
"type": "https://photon.codes/docs/problems/idempotency-conflict"
}{
"code": "PAYLOAD_TOO_LARGE",
"status": 413,
"title": "Payload Too Large",
"type": "https://photon.codes/docs/problems/payload-too-large"
}{
"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": "SERVICE_FAILURE",
"status": 502,
"title": "Service Failure",
"type": "https://photon.codes/docs/problems/service-failure"
}{
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"title": "Service Temporarily Unavailable",
"type": "https://photon.codes/docs/problems/service-unavailable"
}{
"code": "REQUEST_TIMEOUT",
"status": 504,
"title": "Request Timeout",
"type": "https://photon.codes/docs/problems/request-timeout"
}10DLC campaigns
Update a campaign
Updates campaign fields selected by updateMask, guarded by etag. Name changes are local and allowed in every state. Eligible rejected campaigns save content locally until resubmit. Ready campaigns allow asynchronous sample changes. Other states lock campaign content.
PATCH
/
v1
/
organizations
/
{organization_id}
/
10dlc
/
campaigns
/
{campaignId}
Update a campaign
curl --request PATCH \
--url https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"etag": "<string>",
"updateMask": [],
"description": "<string>",
"embeddedLinkSample": "<string>",
"embeddedLinks": true,
"embeddedPhoneNumbers": true,
"helpKeywords": [
"<string>"
],
"helpMessage": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": [
"<string>"
],
"optInMessage": "<string>",
"optOutKeywords": [
"<string>"
],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"sampleMessages": [
"<string>"
],
"termsAndConditionsUrl": "<string>"
}
'import requests
url = "https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}"
payload = {
"etag": "<string>",
"updateMask": [],
"description": "<string>",
"embeddedLinkSample": "<string>",
"embeddedLinks": True,
"embeddedPhoneNumbers": True,
"helpKeywords": ["<string>"],
"helpMessage": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": ["<string>"],
"optInMessage": "<string>",
"optOutKeywords": ["<string>"],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"sampleMessages": ["<string>"],
"termsAndConditionsUrl": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
etag: '<string>',
updateMask: [],
description: '<string>',
embeddedLinkSample: '<string>',
embeddedLinks: true,
embeddedPhoneNumbers: true,
helpKeywords: ['<string>'],
helpMessage: '<string>',
messageFlow: '<string>',
name: '<string>',
optInKeywords: ['<string>'],
optInMessage: '<string>',
optOutKeywords: ['<string>'],
optOutMessage: '<string>',
privacyPolicyUrl: '<string>',
sampleMessages: ['<string>'],
termsAndConditionsUrl: '<string>'
})
};
fetch('https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}', 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/organizations/{organization_id}/10dlc/campaigns/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'etag' => '<string>',
'updateMask' => [
],
'description' => '<string>',
'embeddedLinkSample' => '<string>',
'embeddedLinks' => true,
'embeddedPhoneNumbers' => true,
'helpKeywords' => [
'<string>'
],
'helpMessage' => '<string>',
'messageFlow' => '<string>',
'name' => '<string>',
'optInKeywords' => [
'<string>'
],
'optInMessage' => '<string>',
'optOutKeywords' => [
'<string>'
],
'optOutMessage' => '<string>',
'privacyPolicyUrl' => '<string>',
'sampleMessages' => [
'<string>'
],
'termsAndConditionsUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}"
payload := strings.NewReader("{\n \"etag\": \"<string>\",\n \"updateMask\": [],\n \"description\": \"<string>\",\n \"embeddedLinkSample\": \"<string>\",\n \"embeddedLinks\": true,\n \"embeddedPhoneNumbers\": true,\n \"helpKeywords\": [\n \"<string>\"\n ],\n \"helpMessage\": \"<string>\",\n \"messageFlow\": \"<string>\",\n \"name\": \"<string>\",\n \"optInKeywords\": [\n \"<string>\"\n ],\n \"optInMessage\": \"<string>\",\n \"optOutKeywords\": [\n \"<string>\"\n ],\n \"optOutMessage\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"sampleMessages\": [\n \"<string>\"\n ],\n \"termsAndConditionsUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"etag\": \"<string>\",\n \"updateMask\": [],\n \"description\": \"<string>\",\n \"embeddedLinkSample\": \"<string>\",\n \"embeddedLinks\": true,\n \"embeddedPhoneNumbers\": true,\n \"helpKeywords\": [\n \"<string>\"\n ],\n \"helpMessage\": \"<string>\",\n \"messageFlow\": \"<string>\",\n \"name\": \"<string>\",\n \"optInKeywords\": [\n \"<string>\"\n ],\n \"optInMessage\": \"<string>\",\n \"optOutKeywords\": [\n \"<string>\"\n ],\n \"optOutMessage\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"sampleMessages\": [\n \"<string>\"\n ],\n \"termsAndConditionsUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.photon.codes/v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"etag\": \"<string>\",\n \"updateMask\": [],\n \"description\": \"<string>\",\n \"embeddedLinkSample\": \"<string>\",\n \"embeddedLinks\": true,\n \"embeddedPhoneNumbers\": true,\n \"helpKeywords\": [\n \"<string>\"\n ],\n \"helpMessage\": \"<string>\",\n \"messageFlow\": \"<string>\",\n \"name\": \"<string>\",\n \"optInKeywords\": [\n \"<string>\"\n ],\n \"optInMessage\": \"<string>\",\n \"optOutKeywords\": [\n \"<string>\"\n ],\n \"optOutMessage\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"sampleMessages\": [\n \"<string>\"\n ],\n \"termsAndConditionsUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"brandId": "<string>",
"capabilities": {
"canResubmit": true,
"editableFields": [
"<string>"
]
},
"createdAt": "2026-01-01T00:00:00.000Z",
"currentStep": "brand_verification",
"description": "<string>",
"embeddedLinks": true,
"embeddedPhoneNumbers": true,
"etag": "<string>",
"failureReasons": [
{
"message": "<string>"
}
],
"hasUnsubmittedChanges": true,
"helpKeywords": [
"<string>"
],
"helpMessage": "<string>",
"id": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": [
"<string>"
],
"optInMessage": "<string>",
"optOutKeywords": [
"<string>"
],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"reviewRevision": 0,
"revision": 0,
"sampleMessages": [
"<string>"
],
"status": "awaiting_brand_verification",
"statusMessage": "<string>",
"submittedRevision": 0,
"subscriberHelp": true,
"subscriberOptIn": true,
"subscriberOptOut": true,
"termsAndConditionsAccepted": true,
"termsAndConditionsUrl": "<string>",
"updatedAt": "2026-01-01T00:00:00.000Z",
"useCases": [
"2FA"
],
"embeddedLinkSample": "<string>",
"readyAt": "2026-01-01T00:00:00.000Z",
"statusReason": {
"code": "<string>",
"message": "<string>"
},
"submittedAt": "2026-01-01T00:00:00.000Z"
}
}{
"campaign": {
"brandId": "<string>",
"capabilities": {
"canResubmit": true,
"editableFields": [
"<string>"
]
},
"createdAt": "2026-01-01T00:00:00.000Z",
"currentStep": "brand_verification",
"description": "<string>",
"embeddedLinks": true,
"embeddedPhoneNumbers": true,
"etag": "<string>",
"failureReasons": [
{
"message": "<string>"
}
],
"hasUnsubmittedChanges": true,
"helpKeywords": [
"<string>"
],
"helpMessage": "<string>",
"id": "<string>",
"messageFlow": "<string>",
"name": "<string>",
"optInKeywords": [
"<string>"
],
"optInMessage": "<string>",
"optOutKeywords": [
"<string>"
],
"optOutMessage": "<string>",
"privacyPolicyUrl": "<string>",
"reviewRevision": 0,
"revision": 0,
"sampleMessages": [
"<string>"
],
"status": "awaiting_brand_verification",
"statusMessage": "<string>",
"submittedRevision": 0,
"subscriberHelp": true,
"subscriberOptIn": true,
"subscriberOptOut": true,
"termsAndConditionsAccepted": true,
"termsAndConditionsUrl": "<string>",
"updatedAt": "2026-01-01T00:00:00.000Z",
"useCases": [
"2FA"
],
"embeddedLinkSample": "<string>",
"readyAt": "2026-01-01T00:00:00.000Z",
"statusReason": {
"code": "<string>",
"message": "<string>"
},
"submittedAt": "2026-01-01T00:00:00.000Z"
}
}{
"code": "IDEMPOTENCY_KEY_REQUIRED",
"status": 400,
"title": "Idempotency Key Required",
"type": "https://photon.codes/docs/problems/idempotency-key-required"
}{
"code": "NOT_AUTHENTICATED",
"status": 401,
"title": "Not Authenticated",
"type": "https://photon.codes/docs/problems/not-authenticated"
}{
"code": "CAMPAIGN_REGISTRATION_PAYMENT_FAILED",
"status": 402,
"title": "Campaign Registration Payment Failed",
"type": "https://photon.codes/docs/problems/campaign-registration-payment-failed",
"detail": "<string>",
"failureDetail": "<string>",
"instance": "<string>",
"remediation": "<unknown>",
"requestId": "<string>"
}{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"type": "https://photon.codes/docs/problems/forbidden"
}{
"code": "BRAND_NOT_FOUND",
"status": 404,
"title": "Brand Not Found",
"type": "https://photon.codes/docs/problems/brand-not-found"
}{
"code": "IDEMPOTENCY_CONFLICT",
"status": 409,
"title": "Idempotency Conflict",
"type": "https://photon.codes/docs/problems/idempotency-conflict"
}{
"code": "PAYLOAD_TOO_LARGE",
"status": 413,
"title": "Payload Too Large",
"type": "https://photon.codes/docs/problems/payload-too-large"
}{
"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": "SERVICE_FAILURE",
"status": 502,
"title": "Service Failure",
"type": "https://photon.codes/docs/problems/service-failure"
}{
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"title": "Service Temporarily Unavailable",
"type": "https://photon.codes/docs/problems/service-unavailable"
}{
"code": "REQUEST_TIMEOUT",
"status": 504,
"title": "Request Timeout",
"type": "https://photon.codes/docs/problems/request-timeout"
}Authorizations
accountServiceKeyserviceIdentityBeareroauth2
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.
Headers
Identifies one campaign mutation across retries. UUIDs are recommended.
Required string length:
8 - 128Pattern:
^[!-~]{8,128}$Path Parameters
Pattern:
^pho_cmp_[0-9a-z]{26}$Pattern:
^pho_org_[0-9a-z]{26}$Body
application/json
Required string length:
1 - 256Required array length:
1 - 15 elementsAvailable options:
name, description, messageFlow, sampleMessages, optInMessage, optOutMessage, helpMessage, optInKeywords, optOutKeywords, helpKeywords, privacyPolicyUrl, termsAndConditionsUrl, embeddedLinks, embeddedPhoneNumbers, embeddedLinkSample Required string length:
40 - 4096Maximum string length:
2048Minimum array length:
1Pattern:
^[A-Z0-9]+$Required string length:
20 - 320Required string length:
40 - 2048Required string length:
1 - 64Minimum array length:
1Pattern:
^[A-Z0-9]+$Required string length:
20 - 320Minimum array length:
1Pattern:
^[A-Z0-9]+$Required string length:
20 - 320Maximum string length:
2048Required array length:
2 - 5 elementsRequired string length:
20 - 255Maximum string length:
2048Response
The campaign after a local save or a completed sample update.
Show child attributes
Show child attributes
Was this page helpful?
⌘I