v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB

Campaigns

Modify campaign

Requires the CAMPAIGNEDIT security role.

put/api/workflow/campaigns/{id}

Path parameters

idstring required

Example:00000000-0000-0000-0000-000000000000

Request body

namestring

keystring

descriptionstring

dateStartstring date

deadlinestring date

closedboolean

responsibleIDstring

campaignMetapropertiesobject

Example request

{
  "name": "Example campaign",
  "key": "excp",
  "description": "Campaign for managing examples",
  "dateStart": "2015-01-01T00:00:00",
  "deadline": "2015-09-04T00:00:00",
  "responsibleID": "00000000-0000-0000-0000-000000000000"
}

Response

Campaign modified successfully

idstring

Example response

{
  "id": "00000000000000000000000000000000"
}