Sync WhatsApp flow from Meta

POST/v1/flows/{flowID}/sync

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

flowIDstringrequired

Responses

200OK

builder_jsonBuilderJSONrequired

Show properties

flowFlowDefinitionrequired

Show properties

idstringrequired

namestringrequired

screensFlowScreen[] | nullrequired

Show properties

Array of FlowScreen

actionsFlowAction[] | nullrequired

Show properties

Array of FlowAction

labelstringrequired

targetstring

typestringrequired

urlstring

componentsFlowComponent[] | nullrequired

Show properties

Array of FlowComponent

helper_textstring

idstringrequired

labelstring

optionsFlowOption[] | null

Show properties

Array of FlowOption

idstringrequired

labelstringrequired

placeholderstring

requiredboolean

textstring

typestringrequired

idstringrequired

titlestringrequired

modestringrequired

builder_versioninteger<int32>required

categorystringrequired

channel_idstring

data_api_versionstringrequired

flow_jsonanyrequired

has_local_changesbooleanrequired

idstringrequired

json_versionstringrequired

meta_flow_idstring

namestringrequired

preview_urlstring

statusstringrequired

validation_errorsanyrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

409Conflict

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/flows/string/sync"

const response = await fetch("/v1/flows/string/sync", {
  method: "POST"
});

import requests

response = requests.post(
    "/v1/flows/string/sync",
)

Response

{
  "builder_json": {
    "flow": {
      "id": "string",
      "name": "string",
      "screens": [
        {
          "actions": [
            {
              "label": "string",
              "target": "string",
              "type": "string",
              "url": "string"
            }
          ],
          "components": [
            {
              "helper_text": "string",
              "id": "string",
              "label": "string",
              "options": [
                {
                  "id": "string",
                  "label": "string"
                }
              ],
              "placeholder": "string",
              "required": true,
              "text": "string",
              "type": "string"
            }
          ],
          "id": "string",
          "title": "string"
        }
      ]
    },
    "mode": "string"
  },
  "builder_version": 0,
  "category": "string",
  "channel_id": "string",
  "data_api_version": "string",
  "flow_json": "string",
  "has_local_changes": true,
  "id": "string",
  "json_version": "string",
  "meta_flow_id": "string",
  "name": "string",
  "preview_url": "string",
  "status": "string",
  "validation_errors": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}