Skip to main content

Patches a Campaign

PATCH 
/campaigns/{id}

Patches a Campaign for a given Campaign id.

Privileges: campaign-detector.manage

Auditlog Event: campaign.detector.campaign.patch

Errors:

  • CAMPAIGN_DETECTOR_API_CAMPAIGN_NOT_FOUND - campaign not found
  • BAD_REQUEST_BODY_FORMAT - Unable to decode request body
  • INT_APP_ERROR - unexpected internal error / missing instance context

Validation Errors:

  • CAMPAIGN_DETECTOR_API_CAMPAIGN_STATUS_NOT_SUPPORTED - The given status is not supported
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ARCHIVED_STATUS_CANNOT_BE_CHANGED - The status of the archived campaign cannot be changed
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTIVE_DURATION_NOT_SUPPORTED - The given active duration value is not supported
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTIVE_DURATION_CANNOT_BE_UPDATED - The action duration can be changed only for active or inactive campaigns
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_NAME_IS_REQUIRED - The name is a required field and cannot be empty
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_NAME_IS_TOO_LONG - The name cannot be longer than 255 characters
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_PRIORITY_NOT_SUPPORTED - The given priority value is not supported
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_LANG_LEN_NOT_EQ_2 - The lang field must have 2 characters
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_LANG_NOT_FOUND - Language not found
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTION_NOT_SUPPORTED - The given action value is not supported
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTION_METHOD_REQUIRED - The action method id required and cannot be empty
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_GROUP_NOT_FOUND - campaign group not found
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_CANNOT_BE_IGNORED - Only new campaigns can be ignored
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTIVE_UNTIL_DT_IS_REQUIRED - The value for the active until dt field is required and cannot be empty
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTIVE_UNTIL_DT_NOT_VALID_FORMAT - The value for the active until dt field is not in the valid date-time format
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTIVE_UNTIL_DT_IS_FAR_IN_FUTURE - The given value for the active until dt field is in far in the future
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_ACTIVE_UNTIL_DT_IS_IN_PAST - The given value for the active until dt field cannot be in the past
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_TAG_IS_INACTIVE - Campaign tag tagname is inactive
  • CAMPAIGN_DETECTOR_API_CAMPAIGN_LANGUAGE_IS_TOO_LONG - The language cannot be longer than 50 characters

Request​

Responses​

Campaign data