Skip to main content

Interface: OrgA2PBrandDetail

Defined in: packages/sdk/src/types/organization-types.ts:249

Brand detail (GET /a2p-brands/{uuid}). Adds live registration-workflow state: workflowStatus is the workflow phase ("registering" / "awaiting_approval" / …, null when no workflow is running) and pendingSampleMessages carries the proposed samples while the workflow waits at the human-approval step.

Extends

Properties

brandRegistrationSid?

optional brandRegistrationSid: string | null

Defined in: packages/sdk/src/types/organization-types.ts:221

BN… SID once registered — gates the live use-case eligibility fetch.

Inherited from

OrgA2PBrandSummary.brandRegistrationSid


brandStatus?

optional brandStatus: string | null

Defined in: packages/sdk/src/types/organization-types.ts:222

Inherited from

OrgA2PBrandSummary.brandStatus


brandType?

optional brandType: string | null

Defined in: packages/sdk/src/types/organization-types.ts:224

Row-verbatim brand type; null on legacy rows the sync has not filled.

Inherited from

OrgA2PBrandSummary.brandType


campaignStatus?

optional campaignStatus: string | null

Defined in: packages/sdk/src/types/organization-types.ts:225

Inherited from

OrgA2PBrandSummary.campaignStatus


campaignUseCase?

optional campaignUseCase: string | null

Defined in: packages/sdk/src/types/organization-types.ts:227

The use case TCR actually holds, verbatim; null when unknown.

Inherited from

OrgA2PBrandSummary.campaignUseCase


displayName

displayName: string

Defined in: packages/sdk/src/types/organization-types.ts:219

Inherited from

OrgA2PBrandSummary.displayName


evidenceUrl

evidenceUrl: string

Defined in: packages/sdk/src/types/organization-types.ts:229

Inherited from

OrgA2PBrandSummary.evidenceUrl


internalError?

optional internalError: string | null

Defined in: packages/sdk/src/types/organization-types.ts:228

Inherited from

OrgA2PBrandSummary.internalError


legalEntityUuid?

optional legalEntityUuid: string | null

Defined in: packages/sdk/src/types/organization-types.ts:218

The legal entity (Customer Profile) this brand registers under.

Inherited from

OrgA2PBrandSummary.legalEntityUuid


pendingSampleMessages?

optional pendingSampleMessages: string[] | null

Defined in: packages/sdk/src/types/organization-types.ts:251


subAccountSid?

optional subAccountSid: string | null

Defined in: packages/sdk/src/types/organization-types.ts:235

Twilio account owning this brand's Messaging Service. Compare against a number's twilioAccountSid to tell, before submitting, that it cannot be attached to this brand. Null for an org with no subaccount.

Inherited from

OrgA2PBrandSummary.subAccountSid


uuid

uuid: string

Defined in: packages/sdk/src/types/organization-types.ts:216

Inherited from

OrgA2PBrandSummary.uuid


workflowStatus?

optional workflowStatus: string | null

Defined in: packages/sdk/src/types/organization-types.ts:250