v2.ads.edit_gms_product_campaign
POST /api/v2/ads/edit_gms_product_campaign
Edit a GMS campaign
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/edit_gms_product_campaign
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| campaign_id | int64 | False | 12412421 | The GMS Campaign ID. Provide if available. |
| edit_action | string | True | change_budget | The following is the list of possible actions and their required fields: 1.change_budgetdaily_budget 2.change_durationstart_date 3.end_date 4.pause 5.resume 6.start 7.change_roas_targetroas_target: when edit_action = change_roas_target, you must provide: roas_target (float) Value rules follow the same logic as in the create endpoint |
| daily_budget | float | False | 100.12 | Daily budget for Campaign. |
| start_date | string | False | 11-11-2025 | Start date of Campaign e.g. "11-11-2025". Cannot be earlier than today. |
| end_date | string | False | 11-11-2025 | End date of Campaign e.g. "11-11-2025". Do not fill if no end date. |
| roas_target | float | False | No input will be GMV Max Auto Bidding (Shop). Input 0 for GMV Max Auto Bidding (Shop). Input greater than 0 for GMV Max Custom ROAS (Shop). If value = 10.123456, it will be taken as 10.1 If value = 10.199999, it will be taken as 10.1 | |
| reference_id | string | False | 086a16bf-49e9-4103-b7fe-c0125beb9278 | Generated by developers, used to prevent duplicate requests Submitting the same reference_id more than once will fail; a new reference_id must be generated to retry. Example: 086a16bf-49e9-4103-b7fe-c0125beb9278 |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Indicate warning details if hit warning. Empty if no warning happened. | |
| request_id | string | The identifier for an API request for error tracking. | |
| response | object | ||
| campaign_id | int64 | 12412412 | GMS Campaign ID |