Definitions for Campaign Management Endpoints

These APIs are used to manage campaigns, including listing, retrieving, updating, and deleting campaign settings. Use these endpoints to manage your campaign lifecycle.

List Campaign IDs

API Reference

Endpoint: GET https://api.taggun.io/api/validation/v1/campaign/settings/list

Request Definitions

No request parameters are needed for this endpoint.

Response Definitions

FieldTypeDescription
campaignIdsstring[]A list of all campaign IDs available in your system.

Get Campaign Settings

API Reference

Endpoint: GET https://api.taggun.io/api/validation/v1/campaign/settings/{campaignId}

Request Definitions

FieldTypeDescriptionRequired
campaignIdstringThe unique ID of the campaign to retrieve settings for.Yes

Response Definitions

FieldTypeDescription
campaignSettingsobjectThe full set of settings for the specified campaign.
statusCodenumberThe HTTP status code of the response.

Update A Campaign

API Reference

Endpoint: PUT https://api.taggun.io/api/validation/v1/campaign/settings/update/{campaignId}

Request Definitions

FieldTypeDescriptionRequired
campaignIdstringThe unique ID of the campaign to be updated.Yes
updatesobjectThe updated settings for the campaign.Yes

Response Definitions

FieldTypeDescription
resultstringA message indicating the outcome of the update.
statusCodenumberThe HTTP status code of the response.

Delete A Campaign

API Reference

Endpoint: DELETE https://api.taggun.io/api/validation/v1/campaign/settings/delete/{campaignId}

Request Definitions

FieldTypeDescriptionRequired
campaignIdstringThe unique ID of the campaign to be deleted.Yes

Response Definitions

FieldTypeDescription
resultstringA message confirming the deletion of the campaign.
statusCodenumberThe HTTP status code of the response.