Create marketing expansion

Requires write_marketing_event access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/sales/marketing_activity_extension.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 .

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_activityobject
[]
Marketing expansion
ended_at string
[]
End time
[]
Example: 2022-12-15T09:00:00+08:00
form_data string
[]
Json's form data is serialized as a string
[]
Example: {\"budget\":{\"frequency\":\"DAILY\",\"currency\":\"TWD\"},\"time\":{\"startTime\":1671275280000,\"endTime\":1671361680000}}
marketing_activity_extension_id string required
[]
Marketing expansion id
[]
Example: b1ee529b-d71d-41d6-93ba-ee46986d3a4b
marketing_activity_id string
[]
Marketing expansion campaign id
[]
Example: MA_6019932248291157288
marketing_activity_title string
[]
Marketing expansion campaign title
[]
Example: This is marketing activity title
remote_id string required
[]
unique id for [App] data
[]
Example: 53e7f97e-8df5-4a6b-b672-5cda96b90821
started_at string
[]
Start time
[]
Example: 2022-12-15T09:00:00+08:00
status string required
[]
Current status of marketing campaign , draft
,failed
,active
,inactive
,scheduled
,paused
,deleted_externally
on the outside
[]
Example: draft
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_activityobject
[]
Marketing expansion
ended_at string
[]
End time
[]
Example: 2022-12-15T09:00:00+08:00
form_data string
[]
Json's form data is serialized as a string
[]
Example: {\"budget\":{\"frequency\":\"DAILY\",\"currency\":\"TWD\"},\"time\":{\"startTime\":1671275280000,\"endTime\":1671361680000}}
marketing_activity_extension_id string
[]
Marketing expansion id
[]
Example: b1ee529b-d71d-41d6-93ba-ee46986d3a4b
marketing_activity_id string
[]
Marketing expansion campaign id
[]
Example: MA_6019932248291157288
marketing_activity_title string
[]
Marketing expansion campaign title
[]
Example: This is marketing activity title
remote_id string
[]
unique id for [App] data
[]
Example: 53e7f97e-8df5-4a6b-b672-5cda96b90821
started_at string
[]
Start time
[]
Example: 2022-12-15T09:00:00+08:00
status string
[]
Current status of marketing campaign , draft
,failed
,active
,inactive
,scheduled
,paused
,deleted_externally
on the outside
[]
Example: draft
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

Authorization — header required

Body

Body required

{
  "marketing_activity": {
    "ended_at": "2022-12-15T09:00:00+08:00",
    "form_data": "{\\\"budget\\\":{\\\"frequency\\\":\\\"DAILY\\\",\\\"currency\\\":\\\"TWD\\\"},\\\"time\\\":{\\\"startTime\\\":1671275280000,\\\"endTime\\\":1671361680000}}",
    "marketing_activity_extension_id": "b1ee529b-d71d-41d6-93ba-ee46986d3a4b",
    "marketing_activity_id": "MA_6019932248291157288",
    "marketing_activity_title": "This is marketing activity title",
    "remote_id": "53e7f97e-8df5-4a6b-b672-5cda96b90821",
    "started_at": "2022-12-15T09:00:00+08:00",
    "status": "draft",
    "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_activity_extension.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