INinkbox
Campaign

Update Org Campaign

Changed on
put/api/v1/compliance/campaign

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/compliance/campaign
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Request body

help_messagestring nullable
message_flowstring nullable
sample1string nullable
sample2string nullable
sample3string nullable
sample4string nullable
sample5string nullable

Response

Successful Response

brandIdstring required
campaignIdstring required
cspIdstring required
descriptionstring required
mockboolean required
subUsecasesstring[] required
termsAndConditionsboolean required
usecasestring required
ageGatedboolean nullable
autoRenewalboolean nullable
billedDatestring nullable
brandDisplayNamestring nullable
campaignStatus'TCR_PENDING' | 'TCR_SUSPENDED' | 'TCR_EXPIRED' | 'TCR_ACCEPTED' | 'TCR_FAILED' | 'CSP_ACCEPTED' | 'CSP_FAILED' | 'MNO_PENDING' | 'MNO_ACCEPTED' | 'MNO_REJECTED' | 'MNO_PROVISIONED' | 'MNO_PROVISIONING_FAILED' nullable

Campaign status

createDatestring nullable
directLendingboolean nullable
embeddedLinkboolean nullable
embeddedLinkSamplestring nullable
embeddedPhoneboolean nullable
helpKeywordsstring nullable
helpMessagestring nullable
isTMobileNumberPoolingEnabledboolean nullable
isTMobileRegisteredboolean nullable
isTMobileSuspendedboolean nullable
messageFlowstring nullable
nextRenewalOrExpirationDatestring nullable
numberPoolboolean nullable
optinKeywordsstring nullable
optinMessagestring nullable
optoutKeywordsstring nullable
optoutMessagestring nullable
privacyPolicyLinkstring nullable
referenceIdstring nullable
resellerIdstring nullable
sample1string nullable
sample2string nullable
sample3string nullable
sample4string nullable
sample5string nullable
statusstring nullable
submissionStatus'CREATED' | 'FAILED' | 'PENDING' nullable
subscriberHelpboolean nullable
subscriberOptinboolean nullable
subscriberOptoutboolean nullable
tcrBrandIdstring nullable
tcrCampaignIdstring nullable
termsAndConditionsLinkstring nullable
verticalstring nullable
webhookFailoverURLstring nullable
webhookURLstring nullable

Changes

  • 77c7e3ee70cfRevision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed subschema #1 from the response body allOf list for the response status

  • a0729c3c4a0bRevision changes
    • info

      added subschema #1 to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status