ACME API Documentation logo

Set Auto Response

Automatically send message auto responses

POSThttps://api.acme.com/api/messages/autoresponse
Available on Business, Enterprise plans.

Automatically send message auto responses to the correspondent. This is useful if your customer service support desk is not currently available.

If active, the auto response is used for all social networks for a given User Profile.

Header Parameters

Authorizationstringrequired
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
Profile-Keystring
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

Body Parameters

autoResponseActivebooleandefault: false

Whether the auto response is active.

autoResponseWaitSecondsnumberdefault: 86400

The number of seconds to wait before sending the auto response again to the correspondent. Default is 86,400 seconds (24 hours).

autoResponseMessagestring

The auto response message.

Default: "Thank you for contacting us. A customer care agent will get back to you soon."

Send an empty "" string to reset the message to the default.

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"autoResponseActive": true, "autoResponseWaitSeconds": 30, "autoResponseMessage": "Howdy!"' \
-X POST https://api.acme.com/api/messages/autoresponse
{
    "status": "success",
    "updated": {
        "autoResponseActive": true,
        "autoResponseMessage": "Howdy!",
        "autoResponseWaitSeconds": 30
    }
}