> ## Documentation Index > Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code. > Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer. > For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them. > The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes. # Register a campaign > Creates a campaign for an organization-owned brand, charges the non-refundable registration amount, and submits automatically after brand verification and qualification. The selected use cases are immutable after submission. Replay a pending request with the same body and Idempotency-Key. ## OpenAPI ````yaml https://api.photon.codes/openapi.json post /v1/organizations/{organization_id}/10dlc/brands/{brandId}/campaigns openapi: 3.1.0 info: title: Photon API version: 1.0.0 servers: - url: https://api.photon.codes security: [] paths: /v1/organizations/{organization_id}/10dlc/brands/{brandId}/campaigns: post: tags: - 10DLC campaigns summary: Register a campaign description: >- Creates a campaign for an organization-owned brand, charges the non-refundable registration amount, and submits automatically after brand verification and qualification. The selected use cases are immutable after submission. Replay a pending request with the same body and Idempotency-Key. operationId: createTenDlcCampaign parameters: - in: path name: brandId required: true schema: pattern: ^pho_brd_[0-9a-z]{26}$ type: string - in: path name: organization_id required: true schema: pattern: ^pho_org_[0-9a-z]{26}$ type: string - description: >- Identifies one campaign mutation across retries. UUIDs are recommended. in: header name: Idempotency-Key required: true schema: maxLength: 128 minLength: 8 pattern: ^[!-~]{8,128}$ type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTenDlcCampaignRequest' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/CreateTenDlcCampaignResponse' description: >- The request is awaiting registration settlement, or the campaign has started submission. headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' Location: description: Canonical campaign URL. schema: format: uri-reference type: string RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: description: Minimum seconds to wait before replaying a pending request. schema: minimum: 0 type: integer Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '400': content: application/problem+json: schema: $ref: '#/components/schemas/CreateTenDlcCampaignBadRequestProblem' description: >- IDEMPOTENCY_KEY_REQUIRED: Idempotency Key Required; IDEMPOTENCY_KEY_INVALID: Idempotency Key Invalid headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '401': content: application/problem+json: schema: $ref: '#/components/schemas/NotAuthenticatedProblem' description: 'NOT_AUTHENTICATED: Not Authenticated' headers: Link: description: Optional related resources. schema: type: string RateLimit: description: Optional rate limit information. schema: type: string RateLimit-Policy: description: Optional rate limit policy. schema: type: string Retry-After: description: Optional retry delay or HTTP date. schema: type: string WWW-Authenticate: required: true schema: type: string X-Request-ID: description: Application request identifier. schema: type: string '402': content: application/problem+json: schema: $ref: >- #/components/schemas/CreateTenDlcCampaignPaymentRequiredProblem description: >- CAMPAIGN_REGISTRATION_PAYMENT_FAILED: Campaign Registration Payment Failed; ENTITLEMENT_REQUIRED: Entitlement Required headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '403': content: application/problem+json: schema: $ref: '#/components/schemas/CreateTenDlcCampaignForbiddenProblem' description: >- FORBIDDEN: Forbidden; RESOURCE_MISMATCH: Resource Mismatch FORBIDDEN: Forbidden; INSUFFICIENT_SCOPE: Insufficient Scope; ORGANIZATION_SSO_REQUIRED: Organization SSO Required headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '404': content: application/problem+json: schema: $ref: '#/components/schemas/CreateTenDlcCampaignNotFoundProblem' description: >- BRAND_NOT_FOUND: Brand Not Found; CAMPAIGN_NOT_FOUND: Campaign Not Found headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '409': content: application/problem+json: schema: $ref: '#/components/schemas/CreateTenDlcCampaignConflictProblem' description: >- IDEMPOTENCY_CONFLICT: Idempotency Conflict; INVALID_LIFECYCLE_STATE: Invalid Lifecycle State; ORGANIZATION_CLOSING: Organization is closing; INVALID_CAMPAIGN_STATE: Invalid Campaign State; CAMPAIGN_REGISTRATION_UNAVAILABLE: Campaign Registration Unavailable headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '413': content: application/problem+json: schema: $ref: '#/components/schemas/PayloadTooLargeProblem' description: 'PAYLOAD_TOO_LARGE: Payload Too Large' headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '422': content: application/problem+json: schema: $ref: >- #/components/schemas/CreateTenDlcCampaignUnprocessableEntityProblem description: >- VALIDATION_FAILED: Request Validation Failed; IDEMPOTENCY_KEY_REUSED: Idempotency Key Reused; CAMPAIGN_VALIDATION_FAILED: Campaign Validation Failed headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '429': content: application/problem+json: schema: $ref: '#/components/schemas/RateLimitedProblem' description: 'RATE_LIMITED: Too Many Requests' headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '500': content: application/problem+json: schema: $ref: >- #/components/schemas/CreateTenDlcCampaignInternalServerErrorProblem description: |- INVALID_AUTH_CONTEXT: Invalid Authentication Context INTERNAL_ERROR: Internal Server Error headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '502': content: application/problem+json: schema: $ref: '#/components/schemas/ServiceFailureProblem' description: 'SERVICE_FAILURE: Service Failure' headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '503': content: application/problem+json: schema: $ref: >- #/components/schemas/CreateTenDlcCampaignServiceUnavailableProblem description: |- SERVICE_UNAVAILABLE: Service Temporarily Unavailable UPSTREAM_UNAVAILABLE: Upstream Service Unavailable headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '504': content: application/problem+json: schema: $ref: '#/components/schemas/CreateTenDlcCampaignGatewayTimeoutProblem' description: 'REQUEST_TIMEOUT: Request Timeout; SERVICE_TIMEOUT: Service Timeout' headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' security: - accountServiceKey: [] - serviceIdentityBearer: [] - oauth2: - ten_dlc:write components: schemas: CreateTenDlcCampaignRequest: additionalProperties: false properties: description: maxLength: 4096 minLength: 40 type: string embeddedLinkSample: format: uri maxLength: 2048 type: string embeddedLinks: type: boolean embeddedPhoneNumbers: type: boolean helpKeywords: items: pattern: ^[A-Z0-9]+$ type: string minItems: 1 type: array helpMessage: maxLength: 320 minLength: 20 type: string messageFlow: maxLength: 2048 minLength: 40 type: string name: maxLength: 64 minLength: 1 type: string optInKeywords: items: pattern: ^[A-Z0-9]+$ type: string minItems: 1 type: array optInMessage: maxLength: 320 minLength: 20 type: string optOutKeywords: items: pattern: ^[A-Z0-9]+$ type: string minItems: 1 type: array optOutMessage: maxLength: 320 minLength: 20 type: string privacyPolicyUrl: format: uri maxLength: 2048 type: string sampleMessages: items: maxLength: 255 minLength: 20 type: string maxItems: 5 minItems: 2 type: array subscriberHelp: const: true type: boolean subscriberOptIn: const: true type: boolean subscriberOptOut: const: true type: boolean termsAndConditionsAccepted: const: true type: boolean termsAndConditionsUrl: format: uri maxLength: 2048 type: string useCases: items: enum: - 2FA - ACCOUNT_NOTIFICATION - CUSTOMER_CARE - DELIVERY_NOTIFICATION - FRAUD_ALERT - HIGHER_EDUCATION - MARKETING - POLLING_VOTING - PUBLIC_SERVICE_ANNOUNCEMENT - SECURITY_ALERT type: string maxItems: 5 minItems: 1 type: array uniqueItems: true required: - description - embeddedLinks - embeddedPhoneNumbers - messageFlow - privacyPolicyUrl - sampleMessages - subscriberHelp - subscriberOptIn - subscriberOptOut - termsAndConditionsAccepted - termsAndConditionsUrl - useCases - name type: object CreateTenDlcCampaignResponse: anyOf: - additionalProperties: false properties: retryAfterSeconds: const: 2 type: number status: const: pending type: string required: - retryAfterSeconds - status type: object - additionalProperties: false properties: campaign: additionalProperties: false properties: brandId: type: string capabilities: additionalProperties: false properties: canResubmit: type: boolean editableFields: items: type: string type: array required: - canResubmit - editableFields type: object createdAt: example: '2026-01-01T00:00:00.000Z' format: date-time type: string currentStep: anyOf: - enum: - brand_verification - brand_qualification - submission - registration - compliance_review - carrier_processing - carrier_activation - billing_activation type: string - type: 'null' description: >- The current or blocked step; null when no active step is known. description: type: string embeddedLinkSample: format: uri maxLength: 2048 type: string embeddedLinks: type: boolean embeddedPhoneNumbers: type: boolean etag: type: string failureReasons: description: >- Photon review failure explanations. Empty when none are available for the current attempt. items: additionalProperties: false properties: message: description: >- Photon guidance for this campaign failure. Unrecognized failures receive a generic Photon support message. type: string required: - message type: object type: array hasUnsubmittedChanges: type: boolean helpKeywords: items: type: string type: array helpMessage: type: string id: type: string messageFlow: type: string name: type: string optInKeywords: items: type: string type: array optInMessage: type: string optOutKeywords: items: type: string type: array optOutMessage: type: string privacyPolicyUrl: type: string readyAt: example: '2026-01-01T00:00:00.000Z' format: date-time type: string reviewRevision: anyOf: - maximum: 9007199254740991 minimum: -9007199254740991 type: integer - type: 'null' revision: maximum: 9007199254740991 minimum: -9007199254740991 type: integer sampleMessages: items: type: string type: array status: description: >- Overall campaign state. reviewing means checks are pending; activating means activation is in progress; ready means activation and billing are complete. action_required needs customer corrections; support_required needs support assistance. enum: - awaiting_brand_verification - awaiting_brand_qualification - submitting - reviewing - activating - ready - action_required - support_required - suspended - expired type: string statusMessage: description: A plain-language explanation of the current campaign state. type: string statusReason: additionalProperties: false properties: code: type: string message: type: string required: - code - message type: object submittedAt: example: '2026-01-01T00:00:00.000Z' format: date-time type: string submittedRevision: anyOf: - maximum: 9007199254740991 minimum: -9007199254740991 type: integer - type: 'null' subscriberHelp: const: true type: boolean subscriberOptIn: const: true type: boolean subscriberOptOut: const: true type: boolean termsAndConditionsAccepted: const: true type: boolean termsAndConditionsUrl: type: string updatedAt: example: '2026-01-01T00:00:00.000Z' format: date-time type: string useCases: items: enum: - 2FA - ACCOUNT_NOTIFICATION - CUSTOMER_CARE - DELIVERY_NOTIFICATION - FRAUD_ALERT - HIGHER_EDUCATION - MARKETING - POLLING_VOTING - PUBLIC_SERVICE_ANNOUNCEMENT - SECURITY_ALERT type: string maxItems: 5 minItems: 1 type: array uniqueItems: true required: - brandId - capabilities - createdAt - currentStep - description - embeddedLinks - embeddedPhoneNumbers - etag - failureReasons - hasUnsubmittedChanges - helpKeywords - helpMessage - id - messageFlow - name - optInKeywords - optInMessage - optOutKeywords - optOutMessage - privacyPolicyUrl - reviewRevision - revision - sampleMessages - status - statusMessage - submittedRevision - subscriberHelp - subscriberOptIn - subscriberOptOut - termsAndConditionsAccepted - termsAndConditionsUrl - updatedAt - useCases type: object required: - campaign type: object CreateTenDlcCampaignBadRequestProblem: oneOf: - $ref: '#/components/schemas/IdempotencyKeyRequiredProblem' - $ref: '#/components/schemas/IdempotencyKeyInvalidProblem' NotAuthenticatedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: NOT_AUTHENTICATED status: 401 title: Not Authenticated type: https://photon.codes/docs/problems/not-authenticated properties: code: const: NOT_AUTHENTICATED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 401 type: number title: const: Not Authenticated type: string type: const: https://photon.codes/docs/problems/not-authenticated type: string required: - code - status - title - type type: object CreateTenDlcCampaignPaymentRequiredProblem: oneOf: - $ref: '#/components/schemas/CampaignRegistrationPaymentFailedProblem' - $ref: '#/components/schemas/EntitlementRequiredProblem' CreateTenDlcCampaignForbiddenProblem: oneOf: - $ref: '#/components/schemas/ForbiddenProblem' - $ref: '#/components/schemas/InsufficientScopeProblem' - $ref: '#/components/schemas/OrganizationSsoRequiredProblem' - $ref: '#/components/schemas/ResourceMismatchProblem' CreateTenDlcCampaignNotFoundProblem: oneOf: - $ref: '#/components/schemas/BrandNotFoundProblem' - $ref: '#/components/schemas/CampaignNotFoundProblem' CreateTenDlcCampaignConflictProblem: oneOf: - $ref: '#/components/schemas/IdempotencyConflictProblem' - $ref: '#/components/schemas/InvalidLifecycleStateProblem' - $ref: '#/components/schemas/OrganizationClosingProblem' - $ref: '#/components/schemas/InvalidCampaignStateProblem' - $ref: '#/components/schemas/CampaignRegistrationUnavailableProblem' PayloadTooLargeProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: PAYLOAD_TOO_LARGE status: 413 title: Payload Too Large type: https://photon.codes/docs/problems/payload-too-large properties: code: const: PAYLOAD_TOO_LARGE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 413 type: number title: const: Payload Too Large type: string type: const: https://photon.codes/docs/problems/payload-too-large type: string required: - code - status - title - type type: object CreateTenDlcCampaignUnprocessableEntityProblem: oneOf: - $ref: '#/components/schemas/ValidationFailedProblem' - $ref: '#/components/schemas/IdempotencyKeyReusedProblem' - $ref: '#/components/schemas/CampaignValidationFailedProblem' RateLimitedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: RATE_LIMITED status: 429 title: Too Many Requests type: https://photon.codes/docs/problems/rate-limited properties: code: const: RATE_LIMITED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 429 type: number title: const: Too Many Requests type: string type: const: https://photon.codes/docs/problems/rate-limited type: string required: - code - status - title - type type: object CreateTenDlcCampaignInternalServerErrorProblem: oneOf: - $ref: '#/components/schemas/InternalErrorProblem' - $ref: '#/components/schemas/InvalidAuthContextProblem' ServiceFailureProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: SERVICE_FAILURE status: 502 title: Service Failure type: https://photon.codes/docs/problems/service-failure properties: code: const: SERVICE_FAILURE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 502 type: number title: const: Service Failure type: string type: const: https://photon.codes/docs/problems/service-failure type: string required: - code - status - title - type type: object CreateTenDlcCampaignServiceUnavailableProblem: oneOf: - $ref: '#/components/schemas/ServiceUnavailableProblem' - $ref: '#/components/schemas/UpstreamUnavailableProblem' CreateTenDlcCampaignGatewayTimeoutProblem: oneOf: - $ref: '#/components/schemas/RequestTimeoutProblem' - $ref: '#/components/schemas/ServiceTimeoutProblem' IdempotencyKeyRequiredProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: IDEMPOTENCY_KEY_REQUIRED status: 400 title: Idempotency Key Required type: https://photon.codes/docs/problems/idempotency-key-required properties: code: const: IDEMPOTENCY_KEY_REQUIRED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 400 type: number title: const: Idempotency Key Required type: string type: const: https://photon.codes/docs/problems/idempotency-key-required type: string required: - code - status - title - type type: object IdempotencyKeyInvalidProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: IDEMPOTENCY_KEY_INVALID status: 400 title: Idempotency Key Invalid type: https://photon.codes/docs/problems/idempotency-key-invalid properties: code: const: IDEMPOTENCY_KEY_INVALID type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 400 type: number title: const: Idempotency Key Invalid type: string type: const: https://photon.codes/docs/problems/idempotency-key-invalid type: string required: - code - status - title - type type: object JsonValue: anyOf: - type: string - type: number - type: boolean - type: 'null' - items: $ref: '#/components/schemas/JsonValue' type: array - additionalProperties: $ref: '#/components/schemas/JsonValue' propertyNames: type: string type: object CampaignRegistrationPaymentFailedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' properties: code: const: CAMPAIGN_REGISTRATION_PAYMENT_FAILED type: string detail: minLength: 1 type: string failureDetail: description: Why billing could not collect the registration fee. type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 402 type: number title: const: Campaign Registration Payment Failed type: string type: const: >- https://photon.codes/docs/problems/campaign-registration-payment-failed type: string required: - code - status - title - type type: object EntitlementRequiredProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ENTITLEMENT_REQUIRED reason: card_required status: 402 title: Entitlement Required type: https://photon.codes/docs/problems/entitlement-required properties: code: const: ENTITLEMENT_REQUIRED type: string detail: minLength: 1 type: string effectiveAt: format: date-time type: string instance: minLength: 1 type: string reason: $ref: '#/components/schemas/EntitlementRejectionReason' remediation: not: {} requestId: minLength: 1 type: string status: const: 402 type: number title: const: Entitlement Required type: string type: const: https://photon.codes/docs/problems/entitlement-required type: string required: - reason - code - status - title - type type: object ForbiddenProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: FORBIDDEN status: 403 title: Forbidden type: https://photon.codes/docs/problems/forbidden properties: code: const: FORBIDDEN type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Forbidden type: string type: const: https://photon.codes/docs/problems/forbidden type: string required: - code - status - title - type type: object InsufficientScopeProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INSUFFICIENT_SCOPE status: 403 title: Insufficient Scope type: https://photon.codes/docs/problems/insufficient-scope properties: code: const: INSUFFICIENT_SCOPE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Insufficient Scope type: string type: const: https://photon.codes/docs/problems/insufficient-scope type: string required: - code - status - title - type type: object OrganizationSsoRequiredProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ORGANIZATION_SSO_REQUIRED status: 403 title: Organization SSO Required type: https://photon.codes/docs/problems/organization-sso-required properties: code: const: ORGANIZATION_SSO_REQUIRED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Organization SSO Required type: string type: const: https://photon.codes/docs/problems/organization-sso-required type: string required: - code - status - title - type type: object ResourceMismatchProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: RESOURCE_MISMATCH status: 403 title: Resource Mismatch type: https://photon.codes/docs/problems/resource-mismatch properties: code: const: RESOURCE_MISMATCH type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Resource Mismatch type: string type: const: https://photon.codes/docs/problems/resource-mismatch type: string required: - code - status - title - type type: object BrandNotFoundProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: BRAND_NOT_FOUND status: 404 title: Brand Not Found type: https://photon.codes/docs/problems/brand-not-found properties: code: const: BRAND_NOT_FOUND type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 404 type: number title: const: Brand Not Found type: string type: const: https://photon.codes/docs/problems/brand-not-found type: string required: - code - status - title - type type: object CampaignNotFoundProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: CAMPAIGN_NOT_FOUND status: 404 title: Campaign Not Found type: https://photon.codes/docs/problems/campaign-not-found properties: code: const: CAMPAIGN_NOT_FOUND type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 404 type: number title: const: Campaign Not Found type: string type: const: https://photon.codes/docs/problems/campaign-not-found type: string required: - code - status - title - type type: object IdempotencyConflictProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: IDEMPOTENCY_CONFLICT status: 409 title: Idempotency Conflict type: https://photon.codes/docs/problems/idempotency-conflict properties: code: const: IDEMPOTENCY_CONFLICT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Idempotency Conflict type: string type: const: https://photon.codes/docs/problems/idempotency-conflict type: string required: - code - status - title - type type: object InvalidLifecycleStateProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INVALID_LIFECYCLE_STATE status: 409 title: Invalid Lifecycle State type: https://photon.codes/docs/problems/invalid-lifecycle-state properties: code: const: INVALID_LIFECYCLE_STATE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Invalid Lifecycle State type: string type: const: https://photon.codes/docs/problems/invalid-lifecycle-state type: string required: - code - status - title - type type: object OrganizationClosingProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ORGANIZATION_CLOSING status: 409 title: Organization is closing type: https://photon.codes/docs/problems/organization-closing properties: code: const: ORGANIZATION_CLOSING type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Organization is closing type: string type: const: https://photon.codes/docs/problems/organization-closing type: string required: - code - status - title - type type: object InvalidCampaignStateProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INVALID_CAMPAIGN_STATE status: 409 title: Invalid Campaign State type: https://photon.codes/docs/problems/invalid-campaign-state properties: code: const: INVALID_CAMPAIGN_STATE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Invalid Campaign State type: string type: const: https://photon.codes/docs/problems/invalid-campaign-state type: string required: - code - status - title - type type: object CampaignRegistrationUnavailableProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: CAMPAIGN_REGISTRATION_UNAVAILABLE status: 409 title: Campaign Registration Unavailable type: https://photon.codes/docs/problems/campaign-registration-unavailable properties: code: const: CAMPAIGN_REGISTRATION_UNAVAILABLE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Campaign Registration Unavailable type: string type: const: https://photon.codes/docs/problems/campaign-registration-unavailable type: string required: - code - status - title - type type: object ValidationFailedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: 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 properties: code: const: VALIDATION_FAILED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string issues: items: $ref: '#/components/schemas/ValidationIssue' type: array remediation: not: {} requestId: minLength: 1 type: string status: const: 422 type: number title: const: Request Validation Failed type: string type: const: https://photon.codes/docs/problems/validation-failed type: string required: - issues - code - status - title - type type: object IdempotencyKeyReusedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: IDEMPOTENCY_KEY_REUSED status: 422 title: Idempotency Key Reused type: https://photon.codes/docs/problems/idempotency-key-reused properties: code: const: IDEMPOTENCY_KEY_REUSED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 422 type: number title: const: Idempotency Key Reused type: string type: const: https://photon.codes/docs/problems/idempotency-key-reused type: string required: - code - status - title - type type: object CampaignValidationFailedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: CAMPAIGN_VALIDATION_FAILED status: 422 title: Campaign Validation Failed type: https://photon.codes/docs/problems/campaign-validation-failed properties: code: const: CAMPAIGN_VALIDATION_FAILED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 422 type: number title: const: Campaign Validation Failed type: string type: const: https://photon.codes/docs/problems/campaign-validation-failed type: string required: - code - status - title - type type: object InternalErrorProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INTERNAL_ERROR status: 500 title: Internal Server Error type: https://photon.codes/docs/problems/internal-error properties: code: const: INTERNAL_ERROR type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 500 type: number title: const: Internal Server Error type: string type: const: https://photon.codes/docs/problems/internal-error type: string required: - code - status - title - type type: object InvalidAuthContextProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INVALID_AUTH_CONTEXT status: 500 title: Invalid Authentication Context type: https://photon.codes/docs/problems/invalid-auth-context properties: code: const: INVALID_AUTH_CONTEXT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 500 type: number title: const: Invalid Authentication Context type: string type: const: https://photon.codes/docs/problems/invalid-auth-context type: string required: - code - status - title - type type: object ServiceUnavailableProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: SERVICE_UNAVAILABLE status: 503 title: Service Temporarily Unavailable type: https://photon.codes/docs/problems/service-unavailable properties: code: const: SERVICE_UNAVAILABLE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 503 type: number title: const: Service Temporarily Unavailable type: string type: const: https://photon.codes/docs/problems/service-unavailable type: string required: - code - status - title - type type: object UpstreamUnavailableProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: UPSTREAM_UNAVAILABLE status: 503 title: Upstream Service Unavailable type: https://photon.codes/docs/problems/upstream-unavailable properties: code: const: UPSTREAM_UNAVAILABLE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 503 type: number title: const: Upstream Service Unavailable type: string type: const: https://photon.codes/docs/problems/upstream-unavailable type: string required: - code - status - title - type type: object RequestTimeoutProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: REQUEST_TIMEOUT status: 504 title: Request Timeout type: https://photon.codes/docs/problems/request-timeout properties: code: const: REQUEST_TIMEOUT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 504 type: number title: const: Request Timeout type: string type: const: https://photon.codes/docs/problems/request-timeout type: string required: - code - status - title - type type: object ServiceTimeoutProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: SERVICE_TIMEOUT status: 504 title: Service Timeout type: https://photon.codes/docs/problems/service-timeout properties: code: const: SERVICE_TIMEOUT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 504 type: number title: const: Service Timeout type: string type: const: https://photon.codes/docs/problems/service-timeout type: string required: - code - status - title - type type: object EntitlementRejectionReason: enum: - billing_restricted - business_plan_required - card_required - email_required - plan_change_scheduled - subscription_not_billable type: string ValidationIssue: additionalProperties: false properties: code: minLength: 1 type: string location: $ref: '#/components/schemas/ValidationLocation' message: minLength: 1 type: string path: type: string required: - code - location - message - path type: object ValidationLocation: enum: - body - cookie - form - header - json - param - query type: string headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: Links related to lifecycle or remediation documentation. schema: type: string RateLimit: description: Current rate-limit state. schema: type: string RateLimit-Policy: description: Rate-limit policy applied by the gateway. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: Identifier for this HTTP attempt. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string Retry-After: description: Delay before retrying, in seconds or as an HTTP date. schema: type: string securitySchemes: accountServiceKey: description: >- Account Service Key, prefixed with `pho_ask_`, sent as `Authorization: Bearer `. 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. scheme: bearer type: http serviceIdentityBearer: description: >- Organization Service Identity API key or M2M access token, sent as `Authorization: Bearer `. Restricted to its organization and explicitly granted business permissions. It does not authorize human organization governance or Photon credential management. Never send an M2M client secret to a business endpoint. scheme: bearer type: http oauth2: description: >- OAuth grant issued by the Photon authorization server. The token is a bearer JWT whose consented scope is intersected with the permissions the route grants; an empty intersection is `403 insufficient_scope`. flows: authorizationCode: authorizationUrl: https://auth.photon.codes/oauth2/authorize scopes: account:create_project: Create a project owned by the account. account:read: View account profile. account:read_projects: >- List projects associated with the account; does not grant access to project contents. account:write: Update account name and profile. billing:read: View invoices, usage, payment status. calls:read: >- Read project call data and lifecycle events via supported APIs or approved subscriptions; excludes stored Events queries. events:read: >- Query stored Events and discover their SQL schema within a project. messages:read: >- Read project messages, delivery status, participant changes and typing activity via supported APIs or approved subscriptions. organization:create_project: Create a project in the organization. organization:read: View organization name and avatar. organization:read_projects: List projects in the organization. platforms:read: View project platform configuration. platforms:write: Change project platform configuration. project:delete: Permanently delete the project. project:read: View non-sensitive project settings. project:read_usage: View project usage and costs. project:write: >- Change agent profiles, webhook settings, and other project configuration. ten_dlc:read: View organization 10DLC Brand and Campaign registration records. ten_dlc:write: >- Register and update organization 10DLC Brands and Campaigns, including OTP operations. tokenUrl: https://auth.photon.codes/oauth2/token type: oauth2 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.