Skip to main content

Update Ad Status (ON/OFF)

  • Updated

Use this endpoint to enable or disable an ad.

Request

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

Method PUT

Header

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

Path Variable

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

Request Parameters

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

Example

curl --location --request PUT 'https://business.newsbreak.com/business-api/v1/ad/updateStatus/111111' \
-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 ID.
└── name string Ad name.
└── adAccountId string Ad account ID.
└── campaignId string Campaign ID.
└── adSetId string Ad set ID.
└── clickTrackingUrl string[] Click tracking url list.
└── impressionTrackingUrl string[] Impression tracking url list.
└── status enumerate Status of the ad. Available values: ON, OFF.
└── auditStatus enumerate Status of the ad. Available values: PENDING, APPROVED, REJECTED.
└── onlineStatus enumerate Online display status of the ad. Available values: PENDING, REJECTED, ACTIVE, INACTIVE, WARNING, DELETED.
└── statusTxt string Explanation of the status of the ad.
└── createTime string Create time of the ad.
└── updateTime string Update time of the ad.
└── creative object Creative of the ad.
    └── type enumerate Type of the ad. Available values: IMAGE, VIDEO, GIF.
    └── content object Content of the ad.
        └── headline string Title.
        └── assetUrl string Url of the image/video/gif.
        └── height int Height of the video in pixel. Only required for videos.
        └── width int Width of the video in pixel. Only required for videos.
        └── coverUrl string Cover image of the video. Only applicable for videos.
        └── description string Description of this ad.
        └── callToAction string Text on button.
        └── brandName string Brand name of this ad.
        └── logoUrl string Url of the logo.
        └── clickThroughUrl string Landing page url.

Example

{
    "code": 0,
    "data": {
        "id": "1783416606975545345",
        "adAccountId": "1524650104622800898",
        "campaignId": "1782327582344138754",
        "adSetId": "123456789",
        "name": "my ad example",
        "type": "IMAGE",
        "clickTrackingUrl": [
            "https://business.newsbreak.com/tracking/redirect?nb_event_type=AD_EVENT_IMPRESSION&nb_source=gam_3p_tracking&nb_device_id=%%ADVERTISING_IDENTIFIER_PLAIN%%&nb_flight_id=%eaid!&nb_creative_id=%ecid!&uid_01=%%PATTERN:uid_01%%&uid_02=%%PATTERN:uid_02%%&uid_03=%%PATTERN:uid_03%%&uid_04=%%PATTERN:uid_04%%&uid_05=%%PATTERN:uid_05%%&uid_06=%%PATTERN:uid_06%%&uid_07=%%PATTERN:uid_07%%&uid_08=%%PATTERN:uid_08%%"
        ],
        "status": "OFF",
        "auditStatus": "PENDING",
        "onlineStatus": "ACTIVE",
        "creative": {
            "type": "IMAGE",
            "content": {
                "clickThroughUrl": "https://www.newsbreak.com",
                "assetUrl": "https://static.particlenews.com/nova/assets/1524650104622800898/269c3dd37f7ce69535ce80dd004e6f6f34da15b1.jpg",
                "brandName": "Newsbreak",
                "headline": "my ad example",
                "description": "my ad example",
                "callToAction": "Subscribe"
            },
            "createTime": "1700000000",
            "updateTime": "1700000000"
        },
        "statusTxt": "Under review. It usually takes 1-2 work days.",
        "createTime": "1700000000",
        "updateTime": "1700000000"
    }
}
 

Related articles