Update Campaign

put

https://api.joinpopp.com/v1/campaigns/{campaignId}

Updates an existing campaign. All fields are optional but at least one must be provided. Questions cannot be updated after creation. Setting campaignStatus to ARCHIVED will stop the campaign. Setting campaignStatus to LIVE will activate a DRAFT campaign.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaignId

string

required

The ID of the campaign to update

Body Params

Update Campaign Request

campaignTitle

string

length ≥ 1

Campaign title

campaignDescription

string

length ≥ 1

Campaign description

campaignStatus

string

enum

Campaign status. Setting to ARCHIVED will stop the campaign. Setting to LIVE will activate a DRAFT campaign. Once archived, status cannot be changed.

Allowed:

language

string

enum

Language the campaign operates in: en_ca (Canadian English), en_gb (British English), en_us (American English), de (German), es (Spanish), fr (French), it (Italian), nl (Dutch), nl_be (Flemish), pt (Portuguese), pt_br (Brazilian Portuguese), zh_hk (Chinese), ar (Arabic), ja (Japanese), ko (Korean), ru (Russian), pl (Polish), tr (Turkish), hu (Hungarian), sv (Swedish), no (Norwegian), da (Danish). Changing this changes which message templates follow-up messages resolve to, so it must match a language the organization has templates for.

additionalContext

string

length ≥ 10

Additional context for the campaign

rejectionMessage

string

length ≥ 1

Rejection message

closingMessage

string

length ≥ 1

Closing message

customMessage

string

length ≥ 1

Custom message

openingMessageTemplateId

string

length ≥ 1

Opening message template ID

channel

string

enum

Communication channel

Allowed:

emailChannelFallbackEnabled

boolean | null

Controls falling back to email when an SMS or WhatsApp message cannot be delivered (invalid or missing phone number). Omit to leave the current value unchanged. Set true or false to override the organization-level setting for this campaign in either direction. Set null to clear a campaign override so the campaign inherits the organization-level setting again, including future changes to it. Has no effect on EMAIL channel campaigns. Only affects conversations created after the change.

conversationTimeout

integer

≥ 24

Conversation timeout in hours

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400

403

404

409

500