Sign in
latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Campaign

Update Campaign

Updates the Campaign with the given id. The provided fields will be updated, the rest will remain unchanged except for designId and badgeId. Those fields can be set to null.

Details for the body of the request:

  • title Campaign title
  • mailBody Campaign mail body
  • fromName Campaign mail sender name
  • fromAddress Campaign mail sender email address
  • emailTemplateId the Id of the EmailTemplate which is going to be linked to the Campaign
  • designId the Id of the certificate Design which is going to be linked to the Campaign
  • badgeId the Id of the badge Design which is going to be linked to the Campaign
  • detailId the Id of the Detail which is going to be linked to the Campaign
put/campaign/{campaign_id}

Path parameters

campaign_idstring required

ID of the Campaign

Headers

api-versionstring required

The API version. Current version is 3.3. This value has to be set in every request.

Request body

titlestring
detailIdstring
badgeIdstring nullable
designIdstring nullable
emailTemplateIdstring
emailFromNamestring
emailSubjectstring
emailfromAddressstring nullable
privateCampaignboolean

Response

Successful response

messagestring nullable
hasErrorboolean
validationErrorsstring[]
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","nullable":true}