Update marketing events

Requires write_marketing_event access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/sales/marketing_events/:marketing_event_id.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Path Parameters

marketing_event_id string required
[]
Id for events

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

marketing_eventobject required
[]
Marketing events object
description string
[]
Marketing campaign description
[]
Example: This is description of marketing event
ended_at string
[]
End time
[]
Example: 2023-12-15T09:00:00+08:00
event_type string required
[]
●ad : advertising ● post : push ( fb post-chinese ) ● message : sms ● retargeting : dynamic redirect advertising ● transactional : ● affiliate : distribution / kol / red people ●Loyalty : gift card ● newsletter : subscription mail ● abandoned_cart : discard ● live : live broadcast
[]
Example: ad
manage_url string
[]
Manage links
[]
Example: www.shopline.com/admin/1.html
marketing_channel string required
[]
Marketing event select channels ● search ● display ● social ● email ● referral ● sms
[]
Example: search
preview_url string
[]
Preview link
[]
Example: www.shopline.com/preview/mobile.com
referring_domain string
[]
Domain names for marketing events specify are required if marketing_channel is search and social
[]
Example: www.shopline.com
remote_id string
[]
Remote resources id
[]
Example: 32ff8e60-9027-4d9c-8286-9f6059aaf97a
started_at string
[]
Start time
[]
Example: 2022-12-15T09:00:00+08:00
utm_campaign string
[]
Logo specific advertising
[]
Example: google
utm_content string
[]
Distinguish between different links within the same ad
[]
Example: googleAds
utm_medium string
[]
Source type of logo ( email , article )
[]
Example: email
utm_source string
[]
Identity advertising customers , advertising websites
[]
Example: www.shopline.com
utm_term string
[]
Signature search keyword
[]
Example: This is utm term name

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

marketing_eventobject
[]
Marketing events
description string
[]
Marketing campaign description
[]
Example: This is description of marketing event
ended_at string
[]
End time
[]
Example: 2023-12-15T09:00:00+08:00
event_type string
[]
●ad : advertising ● post : push ( fb post-chinese ) ● message : sms ● retargeting : dynamic redirect advertising ● transactional : ● affiliate : distribution / kol / red people ●Loyalty : gift card ● newsletter : subscription mail ● abandoned_cart : discard ● live : live broadcast
[]
Example: ad
manage_url string
[]
Managed links
[]
Example: www.shopline.com/admin/1.html
marketing_channel string
[]
Marketing event select channels ● search ● display ● social ● email ● referral ● sms
[]
Example: search
marketing_event_id string
[]
Event id
[]
Example: MA_6019932248375043369
preview_url string
[]
Url to preview
[]
Example: www.shopline.com/preview/mobile.com
referring_domain string
[]
Domain names for marketing events specify are required if marketing_channel is search and social
[]
Example: www.shopline.com
remote_id string
[]
Remote resources id
[]
Example: 32ff8e60-9027-4d9c-8286-9f6059aaf97a
started_at string
[]
Start time
[]
Example: 2022-12-15T09:00:00+08:00
utm_campaign string
[]
Logo specific advertising
[]
Example: google
utm_content string
[]
Distinguish between different links within the same ad
[]
Example: googleAds
utm_medium string
[]
Source type of logo ( email , article )
[]
Example: email
utm_source string
[]
Identity advertising customers , advertising websites
[]
Example: www.shopline.com
utm_term string
[]
Signature search keyword
[]
Example: This is utm term name

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

marketing_event_id — path required

Authorization — header required

Body

Body required

{
  "marketing_event": {
    "description": "This is description of marketing event",
    "ended_at": "2023-12-15T09:00:00+08:00",
    "event_type": "ad",
    "manage_url": "www.shopline.com/admin/1.html",
    "marketing_channel": "search",
    "preview_url": "www.shopline.com/preview/mobile.com",
    "referring_domain": "www.shopline.com",
    "remote_id": "32ff8e60-9027-4d9c-8286-9f6059aaf97a",
    "started_at": "2022-12-15T09:00:00+08:00",
    "utm_campaign": "google",
    "utm_content": "googleAds",
    "utm_medium": "email",
    "utm_source": "www.shopline.com",
    "utm_term": "This is utm term name"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/sales/marketing_events/marketing_event_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal