Skip to main content
POST
Register a campaign

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.

Headers

Idempotency-Key
string
required

Identifies one campaign mutation across retries. UUIDs are recommended.

Required string length: 8 - 128
Pattern: ^[!-~]{8,128}$

Path Parameters

brandId
string
required
Pattern: ^pho_brd_[0-9a-z]{26}$
organization_id
string
required
Pattern: ^pho_org_[0-9a-z]{26}$

Body

application/json
description
string
required
Required string length: 40 - 4096
embeddedPhoneNumbers
boolean
required
messageFlow
string
required
Required string length: 40 - 2048
name
string
required
Required string length: 1 - 64
privacyPolicyUrl
string<uri>
required
Maximum string length: 2048
sampleMessages
string[]
required
Required array length: 2 - 5 elements
Required string length: 20 - 255
subscriberHelp
boolean
required
subscriberOptIn
boolean
required
subscriberOptOut
boolean
required
termsAndConditionsAccepted
boolean
required
termsAndConditionsUrl
string<uri>
required
Maximum string length: 2048
useCases
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
2FA,
ACCOUNT_NOTIFICATION,
CUSTOMER_CARE,
DELIVERY_NOTIFICATION,
FRAUD_ALERT,
HIGHER_EDUCATION,
MARKETING,
POLLING_VOTING,
PUBLIC_SERVICE_ANNOUNCEMENT,
SECURITY_ALERT
Maximum string length: 2048
helpKeywords
string[]
Minimum array length: 1
Pattern: ^[A-Z0-9]+$
helpMessage
string
Required string length: 20 - 320
optInKeywords
string[]
Minimum array length: 1
Pattern: ^[A-Z0-9]+$
optInMessage
string
Required string length: 20 - 320
optOutKeywords
string[]
Minimum array length: 1
Pattern: ^[A-Z0-9]+$
optOutMessage
string
Required string length: 20 - 320

Response

The request is awaiting registration settlement, or the campaign has started submission.

retryAfterSeconds
number
required
status
string
required
Allowed value: "pending"