Skip to main content

Update Campaign Status (ON/OFF)

  • Updated

Use this endpoint to enable or disable a campaign.

Request

End Point https://business.newsbreak.com/business-api/v1/campaign/updateStatus/{campaignId}

Method PUT

Header

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

Path Variable

Field Required Data Type Description
campaignId Y string ID of the campaign to update.

Request Parameters

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

Example

curl --location --request PUT 'https://business.newsbreak.com/business-api/v1/campaign/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 Campaign ID.
└── name string Campaign name.
└── orgId string Organization ID.
└── adAccountId string Ad account ID.
└── objective string Objective of campaign.
└── budget int Campaign budget.
└── onlineStatus string Online status of the campaign.
└── status string Campaign status.
└── createTime string Create time of the campaign.
└── updateTime string Update time of the campaign.

Example

{
    "code": 0,
    "data": {
        "id": "111111",
        "orgId": "111111",
        "adAccountId": "123456",
        "name": "my campaign",
        "objective": "WEB_CONVERSION",
        "budget": 1000,
        "onlineStatus": "ACTIVE",
        "status": "OFF",
        "createTime": "1700000000",
        "updateTime": "1710000000"
    }
}
 

Related articles