Skip to main content

Complete a Campaign

POST 

/campaigns/:id/complete

caution

This endpoint will run successfully for any campaigns that are past due.

This endpoint will return a content error if the campaign is not past due.

Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed.

Request

Path Parameters

    id stringrequired

    Campaign ID.

    Example: ef38f94347e94562b5bb8424a56397d8

Body

Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE

    autoCompleteAction string

    Possible values: [APPROVE, REVOKE]

    Default value: APPROVE

    Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion.

Responses

Accepted - Returned if the request was successfully accepted into the system.

Schema

    object

Loading...