Skip to main content

v2.ams.update_basic_info_of_targeted_campaign

POST /api/v2/ams/update_basic_info_of_targeted_campaign

Edit campaign name, promotion period, message, and budget (if the shop is whitelisted) of target campaign

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ams/update_basic_info_of_targeted_campaign

Common Request Parameters

NameTypeSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

NameTypeRequiredSampleDescription
campaign_idint64True101The unique key for the current campaign.
campaign_namestringFalsecampaign aThe name of the current campaign.
period_start_timetimestampFalse1735660800The start time of the designated campaign, in seconds.
period_end_timetimestampFalse32503651199The period end time of campaign, in seconds. Can set 32503651199 (2999-12-31 23:59:59) represent of no limit.
is_set_budgetbooleanFalsetrueBudget allocation toggle for the current campaign. Note: TH not supported
budgetfloatFalse10000.0Budget value set for the current campaign. Note: TH not supported

Response Parameters

NameTypeSampleDescription
errorstringerror_businessIndicate error type if hit error. Empty if no error happened.
messagestringPlease agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.Indicate error details if hit error. Empty if no error happened.
request_idstringb937c04e554847789cbf3fe33a0ad5f1The identifier for an API request for error tracking.