Marketing settings

Marketing module settings

INFO

Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.

GET /marketing-settings/get

Get the tenant's marketing settings (created with defaults on first access).

Request body

No request body.

Response

Field	Type	Description
_id	string
expected_product_template_id	string
send_by_sms	boolean
send_by_bot	boolean
integration_id	string
template	object
template._id	string
template.content	string
integration	object
integration._id	string
integration.name	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "expected_product_template_id": "string",
    "send_by_sms": false,
    "send_by_bot": false,
    "integration_id": "string",
    "template": {
      "_id": "string",
      "content": "string"
    },
    "integration": {
      "_id": "string",
      "name": "string"
    }
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /marketing-settings/set

Update the tenant's marketing settings (partial patch).

Request body

Field	Type	Required	Description
expected_product_template_id	string	No	ObjectId of the SMS template used for the expected-product event notification
send_by_sms	boolean	No	Whether to send expected-product notifications via SMS
send_by_bot	boolean	No	Whether to send expected-product notifications via Telegram bot
integration_id	string	No	ObjectId of the SMS integration to use for outgoing messages

{
  "expected_product_template_id": "string",
  "send_by_sms": false,
  "send_by_bot": false,
  "integration_id": "string"
}

Response

Same response shape as GET /marketing-settings/get.

---

This page is generated from the OpenAPI spec.