Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateWhatsAppFlow

Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON.

Request Syntax


POST /v1/whatsapp/flow/update HTTP/1.1
Content-type: application/json

{
   "categories": [ "string" ],
   "flowId": "string",
   "flowName": "string",
   "id": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

categories

The updated categories for the Flow.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 9 items.

Required: No

flowId

The unique identifier of the Flow to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [0-9]+

Required: Yes

flowName

The updated name for the Flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

id

The ID of the WhatsApp Business Account associated with this Flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 115.

Pattern: .*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedByMetaException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

DependencyException

Thrown when performing an action because a dependency would be broken.

HTTP Status Code: 502

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

InvalidParametersException

One or more parameters provided to the action are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ThrottledRequestException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400