Message settings

Outbound messaging 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.

POST /message-settings/get

Get the message settings for a specific (bot_type, message_type) combination. Auto-creates the document with defaults if it does not exist yet. Because the resource is keyed by a composite — not an ObjectId — the request requires a body with both keys.

Request body

Field	Type	Required	Description
bot_type	string	Yes	Bot channel type. One of: CUSTOMER_BOT, REPORT_BOT, SMS
message_type	string	Yes	Business event category the settings apply to. One of: TRADE, PURCHASE, TRANSACTION, TRANSFER, PRODUCTION, TASK

{
  "bot_type": "CUSTOMER_BOT",
  "message_type": "TRADE"
}

Response

Field	Type	Description
_id	string	Document ObjectId
account_id	string	Tenant identifier
bot_type	string	Bot channel type. One of: CUSTOMER_BOT, REPORT_BOT, SMS
message_type	string	Business event category the settings apply to. One of: TRADE, PURCHASE, TRANSACTION, TRANSFER, PRODUCTION, TASK
is_task_created	boolean
is_task_closed	boolean
is_refund	object
is_refund.show	boolean	Whether this field is shown in the message
is_refund.position	integer	Display position (0-based)
sold_at	object
sold_at.show	boolean	Whether this field is shown in the message
sold_at.position	integer	Display position (0-based)
state	object
state.show	boolean	Whether this field is shown in the message
state.position	integer	Display position (0-based)
organization	object
organization.show	boolean	Whether this field is shown in the message
organization.position	integer	Display position (0-based)
seller	object
seller.show	boolean	Whether this field is shown in the message
seller.position	integer	Display position (0-based)
customer	object
customer.show	boolean	Whether this field is shown in the message
customer.position	integer	Display position (0-based)
note	object
note.show	boolean	Whether this field is shown in the message
note.position	integer	Display position (0-based)
total_amount	object
total_amount.show	boolean	Whether this field is shown in the message
total_amount.position	integer	Display position (0-based)
items	object
items.show	boolean	Whether this field is shown in the message
items.position	integer	Display position (0-based)
discount	object
discount.show	boolean	Whether this field is shown in the message
discount.position	integer	Display position (0-based)
included_tax	object
included_tax.show	boolean	Whether this field is shown in the message
included_tax.position	integer	Display position (0-based)
added_tax	object
added_tax.show	boolean	Whether this field is shown in the message
added_tax.position	integer	Display position (0-based)
total	object
total.show	boolean	Whether this field is shown in the message
total.position	integer	Display position (0-based)
payments	object
payments.show	boolean	Whether this field is shown in the message
payments.position	integer	Display position (0-based)
by_balance	object
by_balance.show	boolean	Whether this field is shown in the message
by_balance.position	integer	Display position (0-based)
is_installment_plan	object
is_installment_plan.show	boolean	Whether this field is shown in the message
is_installment_plan.position	integer	Display position (0-based)
debt	object
debt.show	boolean	Whether this field is shown in the message
debt.position	integer	Display position (0-based)
applied_cashbacks	object
applied_cashbacks.show	boolean	Whether this field is shown in the message
applied_cashbacks.position	integer	Display position (0-based)
initial_payment	object
initial_payment.show	boolean	Whether this field is shown in the message
initial_payment.position	integer	Display position (0-based)
purchase	object
purchase.show	boolean	Whether this field is shown in the message
purchase.position	integer	Display position (0-based)
balance	object
balance.show	boolean	Whether this field is shown in the message
balance.position	integer	Display position (0-based)
earned_cashback	object
earned_cashback.show	boolean	Whether this field is shown in the message
earned_cashback.position	integer	Display position (0-based)
marks	object
marks.show	boolean	Whether this field is shown in the message
marks.position	integer	Display position (0-based)
date	object
date.show	boolean	Whether this field is shown in the message
date.position	integer	Display position (0-based)
responsible	object
responsible.show	boolean	Whether this field is shown in the message
responsible.position	integer	Display position (0-based)
supplier	object
supplier.show	boolean	Whether this field is shown in the message
supplier.position	integer	Display position (0-based)
purchase_created_at	object
purchase_created_at.show	boolean	Whether this field is shown in the message
purchase_created_at.position	integer	Display position (0-based)
orders	object
orders.show	boolean	Whether this field is shown in the message
orders.position	integer	Display position (0-based)
transaction	object
transaction.show	boolean	Whether this field is shown in the message
transaction.position	integer	Display position (0-based)
transaction_type	object
transaction_type.show	boolean	Whether this field is shown in the message
transaction_type.position	integer	Display position (0-based)
cashbox	object
cashbox.show	boolean	Whether this field is shown in the message
cashbox.position	integer	Display position (0-based)
cashier	object
cashier.show	boolean	Whether this field is shown in the message
cashier.position	integer	Display position (0-based)
invoice	object
invoice.show	boolean	Whether this field is shown in the message
invoice.position	integer	Display position (0-based)
trade	object
trade.show	boolean	Whether this field is shown in the message
trade.position	integer	Display position (0-based)
employee	object
employee.show	boolean	Whether this field is shown in the message
employee.position	integer	Display position (0-based)
person	object
person.show	boolean	Whether this field is shown in the message
person.position	integer	Display position (0-based)
amount	object
amount.show	boolean	Whether this field is shown in the message
amount.position	integer	Display position (0-based)
payment_method	object
payment_method.show	boolean	Whether this field is shown in the message
payment_method.position	integer	Display position (0-based)
payment_type	object
payment_type.show	boolean	Whether this field is shown in the message
payment_type.position	integer	Display position (0-based)
production_number	object
production_number.show	boolean	Whether this field is shown in the message
production_number.position	integer	Display position (0-based)
used_warehouse	object
used_warehouse.show	boolean	Whether this field is shown in the message
used_warehouse.position	integer	Display position (0-based)
produced_warehouse	object
produced_warehouse.show	boolean	Whether this field is shown in the message
produced_warehouse.position	integer	Display position (0-based)
used_date	object
used_date.show	boolean	Whether this field is shown in the message
used_date.position	integer	Display position (0-based)
produced_date	object
produced_date.show	boolean	Whether this field is shown in the message
produced_date.position	integer	Display position (0-based)
currency	object
currency.show	boolean	Whether this field is shown in the message
currency.position	integer	Display position (0-based)
route_sheet	object
route_sheet.show	boolean	Whether this field is shown in the message
route_sheet.position	integer	Display position (0-based)
production_created_by	object
production_created_by.show	boolean	Whether this field is shown in the message
production_created_by.position	integer	Display position (0-based)
production_code	object
production_code.show	boolean	Whether this field is shown in the message
production_code.position	integer	Display position (0-based)
total_produced	object
total_produced.show	boolean	Whether this field is shown in the message
total_produced.position	integer	Display position (0-based)
total_used	object
total_used.show	boolean	Whether this field is shown in the message
total_used.position	integer	Display position (0-based)
total_cost	object
total_cost.show	boolean	Whether this field is shown in the message
total_cost.position	integer	Display position (0-based)
total_expense	object
total_expense.show	boolean	Whether this field is shown in the message
total_expense.position	integer	Display position (0-based)
link	object
link.show	boolean	Whether this field is shown in the message
link.position	integer	Display position (0-based)
state_changes	object
state_changes.show	boolean	Whether this field is shown in the message
state_changes.position	integer	Display position (0-based)
state_change	object
state_change.show	boolean	Whether this field is shown in the message
state_change.position	integer	Display position (0-based)
transfer	object
transfer.show	boolean	Whether this field is shown in the message
transfer.position	integer	Display position (0-based)
sender_organization	object
sender_organization.show	boolean	Whether this field is shown in the message
sender_organization.position	integer	Display position (0-based)
receiver_organization	object
receiver_organization.show	boolean	Whether this field is shown in the message
receiver_organization.position	integer	Display position (0-based)
sender_warehouse	object
sender_warehouse.show	boolean	Whether this field is shown in the message
sender_warehouse.position	integer	Display position (0-based)
sender_employee	object
sender_employee.show	boolean	Whether this field is shown in the message
sender_employee.position	integer	Display position (0-based)
reason	object
reason.show	boolean	Whether this field is shown in the message
reason.position	integer	Display position (0-based)
products	object
products.show	boolean	Whether this field is shown in the message
products.position	integer	Display position (0-based)
customer_balance	object
customer_balance.show	boolean	Whether this field is shown in the message
customer_balance.position	integer	Display position (0-based)
transfer_created_at	object
transfer_created_at.show	boolean	Whether this field is shown in the message
transfer_created_at.position	integer	Display position (0-based)
production_created_at	object
production_created_at.show	boolean	Whether this field is shown in the message
production_created_at.position	integer	Display position (0-based)
change	object
change.show	boolean	Whether this field is shown in the message
change.position	integer	Display position (0-based)
sign_amount	object
sign_amount.show	boolean	Whether this field is shown in the message
sign_amount.position	integer	Display position (0-based)
number	object
number.show	boolean	Whether this field is shown in the message
number.position	integer	Display position (0-based)
transaction_created_by	object
transaction_created_by.show	boolean	Whether this field is shown in the message
transaction_created_by.position	integer	Display position (0-based)
device_name	object
device_name.show	boolean	Whether this field is shown in the message
device_name.position	integer	Display position (0-based)
total_discount	object
total_discount.show	boolean	Whether this field is shown in the message
total_discount.position	integer	Display position (0-based)
task_type	object
task_type.show	boolean	Whether this field is shown in the message
task_type.position	integer	Display position (0-based)
task_description	object
task_description.show	boolean	Whether this field is shown in the message
task_description.position	integer	Display position (0-based)
result	object
result.show	boolean	Whether this field is shown in the message
result.position	integer	Display position (0-based)
task_deadline	object
task_deadline.show	boolean	Whether this field is shown in the message
task_deadline.position	integer	Display position (0-based)
task_created_at	object
task_created_at.show	boolean	Whether this field is shown in the message
task_created_at.position	integer	Display position (0-based)
phone_number	object
phone_number.show	boolean	Whether this field is shown in the message
phone_number.position	integer	Display position (0-based)
created_at	string (date-time)
updated_at	string (date-time)

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "account_id": "string",
    "bot_type": "CUSTOMER_BOT",
    "message_type": "TRADE",
    "is_task_created": false,
    "is_task_closed": false,
    "is_refund": {
      "show": false,
      "position": 0
    },
    "sold_at": {
      "show": false,
      "position": 0
    },
    "state": {
      "show": false,
      "position": 0
    },
    "organization": {
      "show": false,
      "position": 0
    },
    "seller": {
      "show": false,
      "position": 0
    },
    "customer": {
      "show": false,
      "position": 0
    },
    "note": {
      "show": false,
      "position": 0
    },
    "total_amount": {
      "show": false,
      "position": 0
    },
    "items": {
      "show": false,
      "position": 0
    },
    "discount": {
      "show": false,
      "position": 0
    },
    "included_tax": {
      "show": false,
      "position": 0
    },
    "added_tax": {
      "show": false,
      "position": 0
    },
    "total": {
      "show": false,
      "position": 0
    },
    "payments": {
      "show": false,
      "position": 0
    },
    "by_balance": {
      "show": false,
      "position": 0
    },
    "is_installment_plan": {
      "show": false,
      "position": 0
    },
    "debt": {
      "show": false,
      "position": 0
    },
    "applied_cashbacks": {
      "show": false,
      "position": 0
    },
    "initial_payment": {
      "show": false,
      "position": 0
    },
    "purchase": {
      "show": false,
      "position": 0
    },
    "balance": {
      "show": false,
      "position": 0
    },
    "earned_cashback": {
      "show": false,
      "position": 0
    },
    "marks": {
      "show": false,
      "position": 0
    },
    "date": {
      "show": false,
      "position": 0
    },
    "responsible": {
      "show": false,
      "position": 0
    },
    "supplier": {
      "show": false,
      "position": 0
    },
    "purchase_created_at": {
      "show": false,
      "position": 0
    },
    "orders": {
      "show": false,
      "position": 0
    },
    "transaction": {
      "show": false,
      "position": 0
    },
    "transaction_type": {
      "show": false,
      "position": 0
    },
    "cashbox": {
      "show": false,
      "position": 0
    },
    "cashier": {
      "show": false,
      "position": 0
    },
    "invoice": {
      "show": false,
      "position": 0
    },
    "trade": {
      "show": false,
      "position": 0
    },
    "employee": {
      "show": false,
      "position": 0
    },
    "person": {
      "show": false,
      "position": 0
    },
    "amount": {
      "show": false,
      "position": 0
    },
    "payment_method": {
      "show": false,
      "position": 0
    },
    "payment_type": {
      "show": false,
      "position": 0
    },
    "production_number": {
      "show": false,
      "position": 0
    },
    "used_warehouse": {
      "show": false,
      "position": 0
    },
    "produced_warehouse": {
      "show": false,
      "position": 0
    },
    "used_date": {
      "show": false,
      "position": 0
    },
    "produced_date": {
      "show": false,
      "position": 0
    },
    "currency": {
      "show": false,
      "position": 0
    },
    "route_sheet": {
      "show": false,
      "position": 0
    },
    "production_created_by": {
      "show": false,
      "position": 0
    },
    "production_code": {
      "show": false,
      "position": 0
    },
    "total_produced": {
      "show": false,
      "position": 0
    },
    "total_used": {
      "show": false,
      "position": 0
    },
    "total_cost": {
      "show": false,
      "position": 0
    },
    "total_expense": {
      "show": false,
      "position": 0
    },
    "link": {
      "show": false,
      "position": 0
    },
    "state_changes": {
      "show": false,
      "position": 0
    },
    "state_change": {
      "show": false,
      "position": 0
    },
    "transfer": {
      "show": false,
      "position": 0
    },
    "sender_organization": {
      "show": false,
      "position": 0
    },
    "receiver_organization": {
      "show": false,
      "position": 0
    },
    "sender_warehouse": {
      "show": false,
      "position": 0
    },
    "sender_employee": {
      "show": false,
      "position": 0
    },
    "reason": {
      "show": false,
      "position": 0
    },
    "products": {
      "show": false,
      "position": 0
    },
    "customer_balance": {
      "show": false,
      "position": 0
    },
    "transfer_created_at": {
      "show": false,
      "position": 0
    },
    "production_created_at": {
      "show": false,
      "position": 0
    },
    "change": {
      "show": false,
      "position": 0
    },
    "sign_amount": {
      "show": false,
      "position": 0
    },
    "number": {
      "show": false,
      "position": 0
    },
    "transaction_created_by": {
      "show": false,
      "position": 0
    },
    "device_name": {
      "show": false,
      "position": 0
    },
    "total_discount": {
      "show": false,
      "position": 0
    },
    "task_type": {
      "show": false,
      "position": 0
    },
    "task_description": {
      "show": false,
      "position": 0
    },
    "result": {
      "show": false,
      "position": 0
    },
    "task_deadline": {
      "show": false,
      "position": 0
    },
    "task_created_at": {
      "show": false,
      "position": 0
    },
    "phone_number": {
      "show": false,
      "position": 0
    },
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": "2025-05-01T12:00:00Z"
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /message-settings/set

Create or update the message settings for a specific (bot_type, message_type) combination. All ~80 DetailSettings toggle fields (show + position) are optional — omitted fields keep their existing values on update, or receive defaults on create.

Request body

Field	Type	Required	Description
bot_type	string	Yes	Bot channel type. One of: CUSTOMER_BOT, REPORT_BOT, SMS
message_type	string	Yes	Business event category the settings apply to. One of: TRADE, PURCHASE, TRANSACTION, TRANSFER, PRODUCTION, TASK
is_task_created	boolean	No	Notify when a task is created
is_task_closed	boolean	No	Notify when a task is closed
is_refund	object	No
is_refund.show	boolean	No	Whether this field is shown in the message
is_refund.position	integer	No	Display position (0-based)
sold_at	object	No
sold_at.show	boolean	No	Whether this field is shown in the message
sold_at.position	integer	No	Display position (0-based)
state	object	No
state.show	boolean	No	Whether this field is shown in the message
state.position	integer	No	Display position (0-based)
organization	object	No
organization.show	boolean	No	Whether this field is shown in the message
organization.position	integer	No	Display position (0-based)
seller	object	No
seller.show	boolean	No	Whether this field is shown in the message
seller.position	integer	No	Display position (0-based)
customer	object	No
customer.show	boolean	No	Whether this field is shown in the message
customer.position	integer	No	Display position (0-based)
note	object	No
note.show	boolean	No	Whether this field is shown in the message
note.position	integer	No	Display position (0-based)
total_amount	object	No
total_amount.show	boolean	No	Whether this field is shown in the message
total_amount.position	integer	No	Display position (0-based)
items	object	No
items.show	boolean	No	Whether this field is shown in the message
items.position	integer	No	Display position (0-based)
discount	object	No
discount.show	boolean	No	Whether this field is shown in the message
discount.position	integer	No	Display position (0-based)
included_tax	object	No
included_tax.show	boolean	No	Whether this field is shown in the message
included_tax.position	integer	No	Display position (0-based)
added_tax	object	No
added_tax.show	boolean	No	Whether this field is shown in the message
added_tax.position	integer	No	Display position (0-based)
total	object	No
total.show	boolean	No	Whether this field is shown in the message
total.position	integer	No	Display position (0-based)
payments	object	No
payments.show	boolean	No	Whether this field is shown in the message
payments.position	integer	No	Display position (0-based)
by_balance	object	No
by_balance.show	boolean	No	Whether this field is shown in the message
by_balance.position	integer	No	Display position (0-based)
is_installment_plan	object	No
is_installment_plan.show	boolean	No	Whether this field is shown in the message
is_installment_plan.position	integer	No	Display position (0-based)
debt	object	No
debt.show	boolean	No	Whether this field is shown in the message
debt.position	integer	No	Display position (0-based)
applied_cashbacks	object	No
applied_cashbacks.show	boolean	No	Whether this field is shown in the message
applied_cashbacks.position	integer	No	Display position (0-based)
initial_payment	object	No
initial_payment.show	boolean	No	Whether this field is shown in the message
initial_payment.position	integer	No	Display position (0-based)
purchase	object	No
purchase.show	boolean	No	Whether this field is shown in the message
purchase.position	integer	No	Display position (0-based)
balance	object	No
balance.show	boolean	No	Whether this field is shown in the message
balance.position	integer	No	Display position (0-based)
earned_cashback	object	No
earned_cashback.show	boolean	No	Whether this field is shown in the message
earned_cashback.position	integer	No	Display position (0-based)
marks	object	No
marks.show	boolean	No	Whether this field is shown in the message
marks.position	integer	No	Display position (0-based)
date	object	No
date.show	boolean	No	Whether this field is shown in the message
date.position	integer	No	Display position (0-based)
responsible	object	No
responsible.show	boolean	No	Whether this field is shown in the message
responsible.position	integer	No	Display position (0-based)
supplier	object	No
supplier.show	boolean	No	Whether this field is shown in the message
supplier.position	integer	No	Display position (0-based)
purchase_created_at	object	No
purchase_created_at.show	boolean	No	Whether this field is shown in the message
purchase_created_at.position	integer	No	Display position (0-based)
orders	object	No
orders.show	boolean	No	Whether this field is shown in the message
orders.position	integer	No	Display position (0-based)
transaction	object	No
transaction.show	boolean	No	Whether this field is shown in the message
transaction.position	integer	No	Display position (0-based)
transaction_type	object	No
transaction_type.show	boolean	No	Whether this field is shown in the message
transaction_type.position	integer	No	Display position (0-based)
cashbox	object	No
cashbox.show	boolean	No	Whether this field is shown in the message
cashbox.position	integer	No	Display position (0-based)
cashier	object	No
cashier.show	boolean	No	Whether this field is shown in the message
cashier.position	integer	No	Display position (0-based)
invoice	object	No
invoice.show	boolean	No	Whether this field is shown in the message
invoice.position	integer	No	Display position (0-based)
trade	object	No
trade.show	boolean	No	Whether this field is shown in the message
trade.position	integer	No	Display position (0-based)
employee	object	No
employee.show	boolean	No	Whether this field is shown in the message
employee.position	integer	No	Display position (0-based)
person	object	No
person.show	boolean	No	Whether this field is shown in the message
person.position	integer	No	Display position (0-based)
amount	object	No
amount.show	boolean	No	Whether this field is shown in the message
amount.position	integer	No	Display position (0-based)
payment_method	object	No
payment_method.show	boolean	No	Whether this field is shown in the message
payment_method.position	integer	No	Display position (0-based)
payment_type	object	No
payment_type.show	boolean	No	Whether this field is shown in the message
payment_type.position	integer	No	Display position (0-based)
production_number	object	No
production_number.show	boolean	No	Whether this field is shown in the message
production_number.position	integer	No	Display position (0-based)
used_warehouse	object	No
used_warehouse.show	boolean	No	Whether this field is shown in the message
used_warehouse.position	integer	No	Display position (0-based)
produced_warehouse	object	No
produced_warehouse.show	boolean	No	Whether this field is shown in the message
produced_warehouse.position	integer	No	Display position (0-based)
used_date	object	No
used_date.show	boolean	No	Whether this field is shown in the message
used_date.position	integer	No	Display position (0-based)
produced_date	object	No
produced_date.show	boolean	No	Whether this field is shown in the message
produced_date.position	integer	No	Display position (0-based)
currency	object	No
currency.show	boolean	No	Whether this field is shown in the message
currency.position	integer	No	Display position (0-based)
route_sheet	object	No
route_sheet.show	boolean	No	Whether this field is shown in the message
route_sheet.position	integer	No	Display position (0-based)
production_created_by	object	No
production_created_by.show	boolean	No	Whether this field is shown in the message
production_created_by.position	integer	No	Display position (0-based)
production_code	object	No
production_code.show	boolean	No	Whether this field is shown in the message
production_code.position	integer	No	Display position (0-based)
total_produced	object	No
total_produced.show	boolean	No	Whether this field is shown in the message
total_produced.position	integer	No	Display position (0-based)
total_used	object	No
total_used.show	boolean	No	Whether this field is shown in the message
total_used.position	integer	No	Display position (0-based)
total_cost	object	No
total_cost.show	boolean	No	Whether this field is shown in the message
total_cost.position	integer	No	Display position (0-based)
total_expense	object	No
total_expense.show	boolean	No	Whether this field is shown in the message
total_expense.position	integer	No	Display position (0-based)
link	object	No
link.show	boolean	No	Whether this field is shown in the message
link.position	integer	No	Display position (0-based)
state_changes	object	No
state_changes.show	boolean	No	Whether this field is shown in the message
state_changes.position	integer	No	Display position (0-based)
state_change	object	No
state_change.show	boolean	No	Whether this field is shown in the message
state_change.position	integer	No	Display position (0-based)
transfer	object	No
transfer.show	boolean	No	Whether this field is shown in the message
transfer.position	integer	No	Display position (0-based)
sender_organization	object	No
sender_organization.show	boolean	No	Whether this field is shown in the message
sender_organization.position	integer	No	Display position (0-based)
receiver_organization	object	No
receiver_organization.show	boolean	No	Whether this field is shown in the message
receiver_organization.position	integer	No	Display position (0-based)
sender_warehouse	object	No
sender_warehouse.show	boolean	No	Whether this field is shown in the message
sender_warehouse.position	integer	No	Display position (0-based)
sender_employee	object	No
sender_employee.show	boolean	No	Whether this field is shown in the message
sender_employee.position	integer	No	Display position (0-based)
reason	object	No
reason.show	boolean	No	Whether this field is shown in the message
reason.position	integer	No	Display position (0-based)
products	object	No
products.show	boolean	No	Whether this field is shown in the message
products.position	integer	No	Display position (0-based)
customer_balance	object	No
customer_balance.show	boolean	No	Whether this field is shown in the message
customer_balance.position	integer	No	Display position (0-based)
transfer_created_at	object	No
transfer_created_at.show	boolean	No	Whether this field is shown in the message
transfer_created_at.position	integer	No	Display position (0-based)
production_created_at	object	No
production_created_at.show	boolean	No	Whether this field is shown in the message
production_created_at.position	integer	No	Display position (0-based)
change	object	No
change.show	boolean	No	Whether this field is shown in the message
change.position	integer	No	Display position (0-based)
sign_amount	object	No
sign_amount.show	boolean	No	Whether this field is shown in the message
sign_amount.position	integer	No	Display position (0-based)
number	object	No
number.show	boolean	No	Whether this field is shown in the message
number.position	integer	No	Display position (0-based)
transaction_created_by	object	No
transaction_created_by.show	boolean	No	Whether this field is shown in the message
transaction_created_by.position	integer	No	Display position (0-based)
device_name	object	No
device_name.show	boolean	No	Whether this field is shown in the message
device_name.position	integer	No	Display position (0-based)
total_discount	object	No
total_discount.show	boolean	No	Whether this field is shown in the message
total_discount.position	integer	No	Display position (0-based)
task_type	object	No
task_type.show	boolean	No	Whether this field is shown in the message
task_type.position	integer	No	Display position (0-based)
task_description	object	No
task_description.show	boolean	No	Whether this field is shown in the message
task_description.position	integer	No	Display position (0-based)
result	object	No
result.show	boolean	No	Whether this field is shown in the message
result.position	integer	No	Display position (0-based)
task_deadline	object	No
task_deadline.show	boolean	No	Whether this field is shown in the message
task_deadline.position	integer	No	Display position (0-based)
task_created_at	object	No
task_created_at.show	boolean	No	Whether this field is shown in the message
task_created_at.position	integer	No	Display position (0-based)
phone_number	object	No
phone_number.show	boolean	No	Whether this field is shown in the message
phone_number.position	integer	No	Display position (0-based)

{
  "bot_type": "CUSTOMER_BOT",
  "message_type": "TRADE",
  "is_task_created": false,
  "is_task_closed": false,
  "is_refund": {
    "show": false,
    "position": 0
  },
  "sold_at": {
    "show": false,
    "position": 0
  },
  "state": {
    "show": false,
    "position": 0
  },
  "organization": {
    "show": false,
    "position": 0
  },
  "seller": {
    "show": false,
    "position": 0
  },
  "customer": {
    "show": false,
    "position": 0
  },
  "note": {
    "show": false,
    "position": 0
  },
  "total_amount": {
    "show": false,
    "position": 0
  },
  "items": {
    "show": false,
    "position": 0
  },
  "discount": {
    "show": false,
    "position": 0
  },
  "included_tax": {
    "show": false,
    "position": 0
  },
  "added_tax": {
    "show": false,
    "position": 0
  },
  "total": {
    "show": false,
    "position": 0
  },
  "payments": {
    "show": false,
    "position": 0
  },
  "by_balance": {
    "show": false,
    "position": 0
  },
  "is_installment_plan": {
    "show": false,
    "position": 0
  },
  "debt": {
    "show": false,
    "position": 0
  },
  "applied_cashbacks": {
    "show": false,
    "position": 0
  },
  "initial_payment": {
    "show": false,
    "position": 0
  },
  "purchase": {
    "show": false,
    "position": 0
  },
  "balance": {
    "show": false,
    "position": 0
  },
  "earned_cashback": {
    "show": false,
    "position": 0
  },
  "marks": {
    "show": false,
    "position": 0
  },
  "date": {
    "show": false,
    "position": 0
  },
  "responsible": {
    "show": false,
    "position": 0
  },
  "supplier": {
    "show": false,
    "position": 0
  },
  "purchase_created_at": {
    "show": false,
    "position": 0
  },
  "orders": {
    "show": false,
    "position": 0
  },
  "transaction": {
    "show": false,
    "position": 0
  },
  "transaction_type": {
    "show": false,
    "position": 0
  },
  "cashbox": {
    "show": false,
    "position": 0
  },
  "cashier": {
    "show": false,
    "position": 0
  },
  "invoice": {
    "show": false,
    "position": 0
  },
  "trade": {
    "show": false,
    "position": 0
  },
  "employee": {
    "show": false,
    "position": 0
  },
  "person": {
    "show": false,
    "position": 0
  },
  "amount": {
    "show": false,
    "position": 0
  },
  "payment_method": {
    "show": false,
    "position": 0
  },
  "payment_type": {
    "show": false,
    "position": 0
  },
  "production_number": {
    "show": false,
    "position": 0
  },
  "used_warehouse": {
    "show": false,
    "position": 0
  },
  "produced_warehouse": {
    "show": false,
    "position": 0
  },
  "used_date": {
    "show": false,
    "position": 0
  },
  "produced_date": {
    "show": false,
    "position": 0
  },
  "currency": {
    "show": false,
    "position": 0
  },
  "route_sheet": {
    "show": false,
    "position": 0
  },
  "production_created_by": {
    "show": false,
    "position": 0
  },
  "production_code": {
    "show": false,
    "position": 0
  },
  "total_produced": {
    "show": false,
    "position": 0
  },
  "total_used": {
    "show": false,
    "position": 0
  },
  "total_cost": {
    "show": false,
    "position": 0
  },
  "total_expense": {
    "show": false,
    "position": 0
  },
  "link": {
    "show": false,
    "position": 0
  },
  "state_changes": {
    "show": false,
    "position": 0
  },
  "state_change": {
    "show": false,
    "position": 0
  },
  "transfer": {
    "show": false,
    "position": 0
  },
  "sender_organization": {
    "show": false,
    "position": 0
  },
  "receiver_organization": {
    "show": false,
    "position": 0
  },
  "sender_warehouse": {
    "show": false,
    "position": 0
  },
  "sender_employee": {
    "show": false,
    "position": 0
  },
  "reason": {
    "show": false,
    "position": 0
  },
  "products": {
    "show": false,
    "position": 0
  },
  "customer_balance": {
    "show": false,
    "position": 0
  },
  "transfer_created_at": {
    "show": false,
    "position": 0
  },
  "production_created_at": {
    "show": false,
    "position": 0
  },
  "change": {
    "show": false,
    "position": 0
  },
  "sign_amount": {
    "show": false,
    "position": 0
  },
  "number": {
    "show": false,
    "position": 0
  },
  "transaction_created_by": {
    "show": false,
    "position": 0
  },
  "device_name": {
    "show": false,
    "position": 0
  },
  "total_discount": {
    "show": false,
    "position": 0
  },
  "task_type": {
    "show": false,
    "position": 0
  },
  "task_description": {
    "show": false,
    "position": 0
  },
  "result": {
    "show": false,
    "position": 0
  },
  "task_deadline": {
    "show": false,
    "position": 0
  },
  "task_created_at": {
    "show": false,
    "position": 0
  },
  "phone_number": {
    "show": false,
    "position": 0
  }
}

Response

Same response shape as POST /message-settings/get.

---

This page is generated from the OpenAPI spec.