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
Endpoint: GET https://api.taggun.io/api/validation/v1/campaign/settings/list
Request Definitions
No request parameters are needed for this endpoint.
Response Definitions
| Field | Type | Description |
|---|---|---|
campaignIds | string[] | A list of all campaign IDs available in your system. |
Get Campaign Settings
Endpoint: GET https://api.taggun.io/api/validation/v1/campaign/settings/{campaignId}
Request Definitions
| Field | Type | Description | Required |
|---|---|---|---|
campaignId | string | The unique ID of the campaign to retrieve settings for. | Yes |
Response Definitions
| Field | Type | Description |
|---|---|---|
campaignSettings | object | The full set of settings for the specified campaign. |
statusCode | number | The HTTP status code of the response. |
Update A Campaign
Endpoint: PUT https://api.taggun.io/api/validation/v1/campaign/settings/update/{campaignId}
Request Definitions
| Field | Type | Description | Required |
|---|---|---|---|
campaignId | string | The unique ID of the campaign to be updated. | Yes |
updates | object | The updated settings for the campaign. | Yes |
Response Definitions
| Field | Type | Description |
|---|---|---|
result | string | A message indicating the outcome of the update. |
statusCode | number | The HTTP status code of the response. |
Delete A Campaign
Endpoint: DELETE https://api.taggun.io/api/validation/v1/campaign/settings/delete/{campaignId}
Request Definitions
| Field | Type | Description | Required |
|---|---|---|---|
campaignId | string | The unique ID of the campaign to be deleted. | Yes |
Response Definitions
| Field | Type | Description |
|---|---|---|
result | string | A message confirming the deletion of the campaign. |
statusCode | number | The HTTP status code of the response. |
Updated about 2 months ago