Skip to main content

Delete Campaigns

POST 

https://sailpoint.api.identitynow.com/v2024/campaigns/delete

Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.

Request

Bodyrequired

IDs of the campaigns to delete.

    idsstring[]

    The ids of the campaigns to delete

    Example: ["2c9180887335cee10173490db1776c26","2c9180836a712436016a7125a90c0021"]

Responses

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

Schema
    objectobject

Authorization: oauth2

type: Personal Access Token
scopes: idn:campaign:manage
user levels: ORG_ADMIN, CERT_ADMIN

View SDK Reference

package main

import (
"context"
"fmt"
"os"
"encoding/json"
v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
campaignsdeleterequest := []byte(`{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
}`) // CampaignsDeleteRequest | IDs of the campaigns to delete.


var campaignsDeleteRequest v2024.CampaignsDeleteRequest
if err := json.Unmarshal(campaignsdeleterequest, &campaignsDeleteRequest); err != nil {
fmt.Println("Error:", err)
return
}



configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute()
//resp, r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteCampaigns`: map[string]interface{}
fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp)
}
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2024
Auth
Body required
{
  "ids": [
    "2c9180887335cee10173490db1776c26",
    "2c9180836a712436016a7125a90c0021"
  ]
}
ResponseClear

Click the Send API Request button above and see the response here!