Skip to content

Archive Campaign Idea

POST
/campaigns/ideas/{idea_id}/archive

Archive an idea. FREE.

Archived ideas are not deleted: future idea generation reads them - and the reason - to steer away from similar concepts.

Authorizations

Parameters

Path Parameters

idea_id
required

Campaign idea id.

string

Campaign idea id.

Query Parameters

reason
Any of:
string
<= 500 characters

Why it was archived.

Header Parameters

X-Target-Org-Id
Any of:
string

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