Skip to content

Update Campaign Idea

PATCH
/campaigns/ideas/{idea_id}

Edit an idea in place. FREE.

The ownership scope IS the permission gate here, exactly as in the app - there is no separate campaigns:write check on this route, so the per-record gate is the only thing between a key and another user’s idea. That is why it is re-declared rather than assumed.

Authorizations

Parameters

Path Parameters

idea_id
required

Campaign idea id.

string

Campaign idea id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Fields to change. Open for the same reason the create body is.

object
key
additional properties
any

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string