Skip to main content

Update Ad Set Status (ON/OFF)

  • Updated

Use this endpoint to enable or disable an ad set.

Request

End Point https://business.newsbreak.com/business-api/v1/ad-set/updateStatus/{adSetId}

Method PUT

Header

Field Required Data Type Description
Access-Token Y string Authorized access token. 

Path Variable

Field Required Data Type Description
adSetId Y string ID of the ad set to update.

Request Parameters

Field Required Data Type Description
status Y string Status of the ad set. Available values: ON, OFF.

Example

curl --location --request PUT 'https://business.newsbreak.com/business-api/v1/ad-set/updateStatus/123456789' \
-H 'Content-Type: application/json' \
-H 'Access-Token:{{Access-Token}}' \
-d '{
  "status": "OFF"
}'
 

Response

Response Parameters

Field Data Type Description
code int Status code, see Return Codes.
errMsg string Error message when code!=0.
data object Response object.
└── id string Ad set ID.
└── name string Ad set name.
└── orgId string Organization ID.
└── adAccountId string Ad account ID.
└── campaignId string Campaign ID.
└── trackingId string Event tracking ID.
└── budget int Ad set budget in cents.
└── budgetType enumerate Ad set budget type.
└── status String Ad set status.
└── onlineStatus String Ad set Online status.
└── startTime String Ad set start time.
└── endTime String Ad set end time.
└── schedule map Ad set schedule.
└── bidType enumerate Ad set bid type.
└── bidRate String Ad set status in cents.
└── deliveryRate enumerate Delivery Rate of the ad set.
└── optimization bool Whether the creative should be optimized.
└── frequencyCaps list Delivery frequency cap of the ad set.
└── targeting map The targeting of the ad set.
└── createTime string Create time of the ad set.
└── updateTime string Update time of the ad set.

Example

{
    "code": 0,
    "data": {
        "id": "123456789",
        "orgId": "987654321",
        "adAccountId": "123456789",
        "campaignId": "987654321",
        "name": "my ad set example",
        "trackingId": "123456789",
        "budget": 10000,
        "onlineStatus": "ACTIVE",
        "status": "OFF",
        "budgetType": "DAILY",
        "startTime": 1712029800,
        "endTime": 1735793459,
        "schedule": {
            "1": [
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16
            ],
            "3": [
                6,
                7,
                8
            ]
        },
        "bidType": "TARGET_CPA",
        "bidRate": 1000,
        "deliveryRate": "ASAP",
        "optimization": true,
        "frequencyCaps": [
            {
                "impressions": 1,
                "days": 1,
                "timeUnit": "DAY"
            }
        ],
        "targeting": {
            "gender": {
                "positive": [
                    "female"
                ]
            },
            "ageGroup": {
                "positive": [
                    "31-44"
                ]
            },
            "interest": {
                "positive": [
                    "all"
                ]
            },
            "location": {
                "positive": [
                    "all"
                ]
            },
            "language": {
                "positive": [
                    "en_us"
                ]
            },
            "os": {
                "positive": [],
                "negative": [
                    "android@5",
                    "android@6"
                ]
            },
            "manufacturer": {
                "positive": [
                    "all"
                ]
            },
            "carrier": {
                "positive": [
                    "all"
                ]
            },
            "network": {
                "positive": [
                    "5g",
                    "wifi"
                ]
            }
        },
        "createTime": "1700000000",
        "updateTime": "1700000000"
    }
}

Related articles