[lightMode]

Update Advertisement

PUT/advertisements/{advertisements_id}

[updatedIn] 2 months ago

This endpoint allows you to update an existing advertisement post by passing the advertisement_id as a path parameter.

`marketing.read_write`- Marketing Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.pathParameter]

advertisements_id

string

required

Advertisement ID. List of Advertisement ID can be found here.

title

string

required

Advertisement Title.

Example:

Adv Title

description

string

required

Advertisement Description. 🌐 Support multi-language

Example:

Adv Description

type

object

required

name

enum<string>

optional

Advertisement Type

Allowed values:

categorypageproductofferswithout_urlexternal_link

Example:

product

number

optional

Advertisement ID. The type.id variable is requiredif type.name is any of these values: ["category" , "page" , "product"]

Example:

1261174103

link

string | null

optional

Advertisement Link. The type.link is requiredif type.name is external_link

expire_date

string

required

Advertisement expiry date.

Example:

2022-12-31

pages

array[string]

required

Which pages should the advertisement appear on.

Allowed values:

allcartproductpaymentcategoryhome

{
  "title": "Adv Title",
  "description": "Adv Description",
  "type": {
    "name": "product",
    "id": 1261174103,
    "link": null
  },
  "expire_date": "2022-12-31",
  "pages": [
    "all"
  ]
}

Request samples

[api.label.responses]

Success(200)

Not Found(404)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (Advertisement)

optional

number

required

Advertisement ID

title

string

required

Advertisement Title

description

string

required

Advertisement Description. 🌐 Support multi-language

type

object

required

style

object

required

expire_date

object

required

pages

array[string]

required

Which pages should the advertisement appear on

{
  "status": 200,
  "success": true,
  "data": {
    "id": 1549230938,
    "title": "Adv Title",
    "description": "Adv Description",
    "type": {
      "id": 1261174103,
      "name": "product",
      "link": null
    },
    "style": {
      "icon": "sicon-bell",
      "font_color": "#ffffff",
      "background_color": "#9d8383"
    },
    "expire_date": {
      "date": "2022-12-12 00:00:00.000000",
      "timezone_type": 3,
      "timezone": "Asia/Riyadh"
    },
    "pages": [
      "all"
    ]
  }
}

[updatedIn] 2 months ago