Chat icon

Chat

Interact with the Chat API

Actions253

Custom Scheduled Message Type → Update

AI-generated

Summary

Updates an existing custom scheduled message type by its ID, allowing modification of its active status, description, key, label, locale, and position.

Inputs

  • accountId (required) — Select the Approach account to use for the request.
  • customScheduledMessageTypeId (required) — The ID of the custom scheduled message type to update.
  • updateFields — Collection of fields to update on the type. Only the provided fields will be changed; omitted fields retain their current values.

Output shape

object

Returns the updated custom scheduled message type resource as provided by the Approach API (typically the full type record after applying the changes).

Examples

Example 1: Activate a type and change its label for Portuguese (Brazil)

accountId: selected account; customScheduledMessageTypeId: 42; updateFields: { is_active: true, labelText: 'Mensagem de acompanhamento', locale: 'pt-BR' }

Links

Discussion