younifyd
Menu

Delete Campaign

Delete Campaign

DELETE/v1/campaigns/{campaignId}

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the Delete Campaign action (under Campaigns).
  3. Fill in the fields below, then reference the result from later steps as {{deleteCampaign.response.data}}.

Request

Path parameters

campaignIdstringrequired

You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

Query parameters

forceboolean

If this flag is set to `true`, the campaign and related vouchers will be removed permanently. If it is set to `false` or not set at all, the campaign and related vouchers will be moved to the bin. Going forward, the user will be able to create the next campaign with exactly the same name.

Response

Returns 202 with an object. Read it in later steps with {{deleteCampaign.response.data.<field>}}.

async_action_idstring

The ID of the scheduled asynchronous action.

json
{
  "async_action_id": "aa_0a875d56c805df6601"
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.