Chat icon

Chat

Interact with the Chat API

Actions253

Custom Scheduled Message Type → Create

AI-generated

Summary

Creates a new custom scheduled message type for the selected Approach account.

Inputs

  • accountId (required) — Select the account to use.
  • labelText (required) — Label for the scheduled message type
  • locale — Locale used for label and description
  • additionalFields.is_active — Whether the type is active
  • additionalFields.descriptionText — Description for the selected locale
  • additionalFields.key — Optional unique key. If empty, the API generates one from the label.
  • additionalFields.position — Sort position for this type

Output shape

object

Returns the created custom scheduled message type object, including its ID and the provided fields.

Examples

Example 1: Create an active scheduled message type with label 'Follow‑up' and Portuguese (Brazil) locale.

Set accountId to the desired account, labelText='Follow‑up', locale='pt-BR', and leave additionalFields at their defaults (is_active true, position 0).

Links

Discussion