Skip to main content
PATCH
Update Reddit campaign

Authorizations

Authorization
string
header
required

A workspace API key.

Path Parameters

campaignId
string
required

A Reddit campaign id, from GET /v1/reddit-campaigns.

Required string length: 1 - 200
Example:

"rcm_9e14"

Body

application/json
name
string

Human-readable campaign name.

Required string length: 1 - 120
connectedAccountId
string

Id of a connected Reddit account in this workspace. Connect and select the account in the dashboard before using this endpoint.

Required string length: 1 - 200
brandBrainId
string | null

Optional saved Voice profile id. Omit or send null to use the Brand Foundation and Brand context.

Required string length: 1 - 200
objective
string

What the campaign should achieve, written in plain language.

Required string length: 1 - 2000
offerUrl
string<uri>

Real landing-page URL for disclosed promotional links. Omit when there is no offer.

keywords
string[]

One to 25 topics or phrases used to find relevant conversations.

Required array length: 1 - 25 elements
Required string length: 1 - 80
negativeKeywords
string[]

Topics or phrases the campaign must avoid.

Maximum array length: 25
Required string length: 1 - 80
caps
object

Only the caps sent change; every other cap keeps its saved value.

autoReplyOurPosts
boolean

Allow automatic replies only to comments on your own campaign posts. Defaults to false.

schedule
object

When the campaign may run.

quietHours
object | null

Additional local-time window during which no action is taken. null clears the saved quiet hours.

alertEmail
string<email> | null

Email address for campaign alerts. Null disables email alerts.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
status
enum<string>

active runs normally, paused preserves the campaign without acting, and completed closes it.

Available options:
active,
paused,
completed

Response

Success.

success
boolean
required
campaign
object
required
{key}
any