Skip to content

Archive campaign

POST
/api/nova/campaigns/{campaignId}/archive

Archives a campaign so it drops out of the live list (list it back with archived=true). Returns 404 if the campaign is not found, 400 if it cannot be archived and 401 if the API key is invalid.

Authorizations

privateApiKey
Type
API Key (query: apiKey)

Parameters

Path Parameters

campaignId*

campaignId

Type
string
Required

Query Parameters

apiKey*

apiKey

Type
string
Required

Responses

OK

application/json
JSON
{
  
"data": "string",
  
"error": "string",
  
"message": "string",
  
"requestId": "string",
  
"success": true
}

Playground

Authorization
Variables
Key
Value

Samples

Recruitly — Recruitment CRM for Agencies