Deprecate Flow

POST Method

The Deprecate Flow API allows you to mark the published flow as deprecated.

When a Flow enters the Deprecated state, it becomes unavailable for distribution to end-users. However, the deprecated Flow may remain on user's devices, and interactions with this Flow may still be detected.

You can also deprecate a flow, if a flow enters ‘Throttled’ or ‘Blocked’ state, based on WhatsApp monitoring determining that there is an issue.

Prerequisites

Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
A prerequisite for using Kaleyra WhatsApp APIs is to have an active WhatsApp plan on kaleyra platform.
To set up a WhatsApp account on kaleyra platform, see Manual Signup
and Embedded Signup.
An active WhatsApp for Business API plan that includes:
- A WhatsApp business number.
- An associated profile with the business number.
- A WhatsApp verified and approved profile.
- WABA ID must be onboarded on Kaleyra WhatsApp API V2 compatible.

Base URL

https://<api_domain>/v2/<SID>

API Domain and Value

api_domain	Value
IN pod	api.in.kaleyra.io
SG Pod	api.ap.kaleyra.io
EU Pod	api.eu.kaleyra.io

API request to deprecate WhatsApp Flow

To deprecate WhatsApp Flow, use the https://<api_domain>/v2/<sid>/whatsapp/<flow_id>/deprecate endpoint with the following request method.

Request Format

The following is the request format to deprecate WhatsApp Flow:

curl --location --request POST 'https://<api_domain>/v2/<sid>/whatsapp/<flow_id>/deprecate' \
--header 'api-key: <api-key>'

Sample Request Format

The following is the sample request format to deprecate a WhatsApp Flow:

curl --location --request POST 'https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/12XXXXXXXXXXXXX/deprecate' \
--header 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3 '

URL Parameters and Headers

Following is the list of parameters and headers to send the outgoing message request:

Data Type	Description	Example	Mandatory?
`sid`	String	Account SID (Security Identifier).	HXAP16XXXXXX97IN	Yes
`flow_id`	Integer	Flow ID is the ID received in the response of the Create Flow API. For more information on how to create a WhatsApp Flow ID, see Create Flow.	12XXXXXXXXXXXXX	Yes
`api-key`	String	API key generated from Kaleyra platform account.	Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3	Yes

Sample Success Response

The following success message appears with success flag set to true:

{
    "success": true
}

Sample Failure Response

The following are the failure responses:

401 Unauthorized
{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "error": "Incorrect SID or API key."
    }
}

401 Wrong account
{
    "code": "WA-401",
    "message": "API is not available for given customer.Please contact support for more info",
    "data": {},
    "error": "API is not available for given customer.Please contact support for more info"
}

400 Incorrect payload
{
    "code": "WA-400",
    "message": "Refer to correct payload format",
    "data": {},
    "error": {
        "payload": "Incorrect payload format"
    }
}

500 Internal Server Error
{
    "code": "WA-500",
    "message": "Please try again later",
    "data": {},
    "error": {
        "error": "Internal server error"
    }
}

{
    "code": "WA-401",
    "message": "The flow_id either does not exist or does not belong to the account.",
    "data": {},
    "error": {
        "flow_id": "The flow_id either does not exist or does not belong to the account."
    }
}

Sample Metadata Error:

{
    "error": {
        "code": 139003,
        "error_subcode": 4016008,
        "error_user_msg": "Flow is already deprecated",
        "error_user_title": "Invalid attempt to deprecate flow",
        "fbtrace_id": "Ae9xXXXXXXXXXXXXL4KNEBQ",
        "is_transient": false,
        "message": "Deprecating attempt failed",
        "type": "OAuthException"
    }
}

Updated about 14 hours ago