Manage the welcome message for a Business Account

This article walks you through the steps for managing the welcome message for a Business Account using Business Messaging API.

Introduction

Welcome messages are the first interaction users have when they initiate contact with your Business Account. They set the tone for your communication and help establish a positive user experience. With the Business Messaging API, you can create a new welcome message or modify the default one to suit your brand's voice. Each Business Account can have one customized welcome message.

You can use Business Messaging API to greet users in a personalized and engaging way, fostering stronger connections and enhancing the overall user experience.

Prerequisites

• You've gained access to TikTok API for Business. See Get Started - Step by step workflow for details.
• To manage the welcome message for a Business Account, you need relevant permissions. See API Reference to find out permissions required for endpoints (including the endpoints listed in the "Steps" section) and see Update app permissions to find out how to configure permissions.
• You have followed the steps in Authorization and Authentication to obtain a TikTok account access token and the Application specific unique ID for the Business Account.

Steps

To manage the welcome message for a Business Account, follow these steps:

Option 1: Create a new welcome message

1. Set up a new welcome message using /business/message/auto_message/create/. - Set auto_message_type to WELCOME_MESSAGE and specify the welcome_message object.

2. Verify the status of the welcome message using /business/message/auto_message/get/. - Set auto_message_type to WELCOME_MESSAGE and confirm that the audit_status of the message is APPROVED and operation_status is ENABLE.
   

   Note: If audit_status of the welcome message is REVIEWING, you need to wait for some time before rechecking the review status. The exact waiting time may vary depending on the content and other factors, but normally ranges from a few seconds to 2-3 hours.

3. Handle potential issues. - If audit_status is REJECTED:

   1. Update the welcome message using /business/message/auto_message/update/.
   2. Recheck the status with /business/message/auto_message/get/. - If operation_status is DISABLE: - Enable the welcome message setting using /business/message/auto_message/status/update/ and set operation_status to ENABLE.

Option 2: Modify the default welcome message

1. Enable the default welcome message. - Call /business/message/auto_message/status/update/ and set operation_status to ENABLE.
   

   Note: If you enable the welcome message for a Business Account for the first time, the default welcome message will be: "Hi there,\nThanks for contacting {{display_name}}! Feel free to ask a question here or leave us a message and we'll get back to you shortly.\n\nThank you!"

2. Retrieve the default message using /business/message/auto_message/get/.

3. Update the message using /business/message/auto_message/update/.

4. Verify the status of the updated welcome message. - Call /business/message/auto_message/get/ again. Confirm that the audit_status of the updated message is APPROVED and operation_status is ENABLE.