Update marketing events

Requires write_marketing_event access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20261201/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 string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Request Body

marketing_eventobject required

Marketing events object
manage_url string

Manage links
Example: www.shopline.com/admin/1.html
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
preview_url string

Preview link
Example: www.shopline.com/preview/mobile.com
started_at string

Start time
Example: 2022-12-15T09:00:00+08:00
utm_medium string

Source type of logo ( email , article )
Example: email
description string

Marketing campaign description
Example: This is description of marketing event
remote_id string

Remote resources id
Example: 32ff8e60-9027-4d9c-8286-9f6059aaf97a
utm_source string

Identity advertising customers , advertising websites
Example: www.shopline.com
referring_domain string

Domain names for marketing events specify are required if marketing_channel is search and social
Example: www.shopline.com
utm_campaign string

Logo specific advertising
Example: google
utm_term string

Signature search keyword
Example: This is utm term name
ended_at string

End time
Example: 2023-12-15T09:00:00+08:00
utm_content string

Distinguish between different links within the same ad
Example: googleAds
marketing_channel string required

Marketing event select channels ● search ● display ● social ● email ● referral ● sms
Example: search

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

marketing_eventobject

Marketing events
marketing_event_id string

Event id
Example: MA_6019932248375043369
manage_url string

Managed links
Example: www.shopline.com/admin/1.html
utm_medium string

Source type of logo ( email , article )
Example: email
utm_source string

Identity advertising customers , advertising websites
Example: www.shopline.com
referring_domain string

Domain names for marketing events specify are required if marketing_channel is search and social
Example: www.shopline.com
utm_content string

Distinguish between different links within the same ad
Example: googleAds
utm_term string

Signature search keyword
Example: This is utm term name
description string

Marketing campaign description
Example: This is description of marketing event
remote_id string

Remote resources id
Example: 32ff8e60-9027-4d9c-8286-9f6059aaf97a
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
preview_url string

Url to preview
Example: www.shopline.com/preview/mobile.com
started_at string

Start time
Example: 2022-12-15T09:00:00+08:00
marketing_channel string

Marketing event select channels ● search ● display ● social ● email ● referral ● sms
Example: search
utm_campaign string

Logo specific advertising
Example: google
ended_at string

End time
Example: 2023-12-15T09:00:00+08:00

API Explorer

Debugger

Examples

Base URL

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

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",
    "marketing_channel": "search",
    "remote_id": "32ff8e60-9027-4d9c-8286-9f6059aaf97a",
    "utm_content": "googleAds",
    "manage_url": "www.shopline.com/admin/1.html",
    "preview_url": "www.shopline.com/preview/mobile.com",
    "utm_medium": "email",
    "started_at": "2022-12-15T09:00:00+08:00",
    "utm_campaign": "google",
    "utm_source": "www.shopline.com",
    "utm_term": "This is utm term name",
    "referring_domain": "www.shopline.com"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/sales/marketing_events/marketing_event_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal