{"componentChunkName":"component---src-templates-docs-js","path":"/whatsapp/administration/block_users/block","result":{"data":{"site":{"siteMetadata":{"title":"broadcaster","docsLocation":"https://github.com","docsLocationType":"github","editable":false}},"mdx":{"fields":{"id":"1cdbd20f-9972-54cb-a51a-aedf8f5d7741","title":"Block and unblock users","slug":"/whatsapp/administration/block_users/block"},"body":"function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"Block and unblock users\",\n  \"order\": 1\n};\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, [\"components\"]);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"blockquote\", null, mdx(\"p\", {\n    parentName: \"blockquote\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Integration summary\")), mdx(\"ul\", {\n    parentName: \"blockquote\"\n  }, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Base URL:\"), \" \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services\")), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Token:\"), \" admin token, in the \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"Authorization: Bearer {{admin-token}}\"), \" header (\", mdx(\"a\", {\n    href: \"/whatsapp/authentication_token\"\n  }, \"how to generate it\"), \")\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Endpoints on this page:\"), mdx(\"ul\", {\n    parentName: \"li\"\n  }, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"POST /v1/block_users/{{waba_id}}/{{phone_number_id}}\"), \": Block users\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"PUT /v1/block_users/{{waba_id}}/{{phone_number_id}}\"), \": Unblock users\"))))), mdx(\"p\", null, \"Block and unblock WhatsApp users for a phone number in your WABA. You can identify each user by their phone number or BSUID.\"), mdx(\"section\", {\n    \"id\": \"blockusers\"\n  }, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"Block users\")), mdx(\"section\", {\n    \"id\": \"blockusers--request\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Request\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Block users\"), \" request:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"URL\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Method\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"POST\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"application/json\"))))), mdx(\"section\", {\n    \"id\": \"blockusers--headers\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Headers\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Block users\"), \" headers:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Content-Type\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"application/json\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Authorization\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Admin token. See \", mdx(\"a\", {\n    href: \"/whatsapp/authentication_token\"\n  }, \"Generate authentication token\"), \".\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"blockusers--parameters\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Parameters\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Block users\"), \" parameters:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"waba_id\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"WhatsApp Business Account ID.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"phone_number_id\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"ID of the phone number that blocks the users.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"blockusers--body\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Body\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Block users\"), \" body fields:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-userobject\"\n  }, \"block_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of users to block.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of user objects\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"blockusers--body--userobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"User object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"user\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The user's phone number or business-scoped user ID (BSUID).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"ul\", null, mdx(\"li\", null, \"Required.\"), mdx(\"li\", null, \"Can't be empty.\"))))))), mdx(\"section\", {\n    \"id\": \"blockusers--example\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Example\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Complete \", mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Block users\"), \" example:\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-bash\"\n  }, \"curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}' \\\\\\n--header 'Content-Type: application/json' \\\\\\n--header 'Authorization: Bearer {{admin-token}}' \\\\\\n--data '{\\n    \\\"block_users\\\": [\\n        {\\n            \\\"user\\\": \\\"521550123456\\\"\\n        },\\n        {\\n            \\\"user\\\": \\\"US.13491208655302741918\\\"\\n        }\\n    ]\\n}'\\n\"))), mdx(\"section\", {\n    \"id\": \"blockusers--response\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Response\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Block users\"), \" response:\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"If the request succeeds, the service returns HTTP 201.\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"messaging_product\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Always \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"\\\"whatsapp\\\"\"), \". Included to match Meta Cloud API responses.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-blockusersobject\"\n  }, \"block_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object with the users that were blocked and those that weren't.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"errors\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Top-level error returned by Meta when the request failed as a whole (as opposed to per-user failures, which appear under \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"block_users.failed_users\"), \"). Omitted on a fully successful response.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object\"))))), mdx(\"section\", {\n    \"id\": \"blockusers--response--blockusersobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Block users object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-addedusersobject\"\n  }, \"added_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of blocked users.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of added users objects\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-failedusersobject\"\n  }, \"failed_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of users that couldn't be blocked.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of failed users objects\"))))), mdx(\"section\", {\n    \"id\": \"blockusers--response--addedusersobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Added users object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"input\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Identifier sent in the request.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"wa_id\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"WhatsApp ID resolved by Meta.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")))), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"messaging_product\\\": \\\"whatsapp\\\",\\n    \\\"block_users\\\": {\\n        \\\"added_users\\\": [\\n            {\\n                \\\"input\\\": \\\"2721520198\\\",\\n                \\\"wa_id\\\": \\\"5212721520198\\\"\\n            }\\n        ],\\n        \\\"failed_users\\\": [\\n            {\\n                \\\"input\\\": \\\"2721520160\\\",\\n                \\\"errors\\\": [\\n                    {\\n                        \\\"code\\\": 131047,\\n                        \\\"message\\\": \\\"Re-engagement check failed\\\",\\n                        \\\"error_data\\\": {\\n                            \\\"details\\\": \\\"Failed to block due to re-engagement check failed\\\"\\n                        }\\n                    }\\n                ]\\n            }\\n        ]\\n    }\\n}\\n\")), mdx(\"br\", null), mdx(\"hr\", {\n    parentName: \"section\"\n  })), mdx(\"section\", {\n    \"id\": \"unblockusers\"\n  }, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"Unblock users\")), mdx(\"section\", {\n    \"id\": \"unblockusers--request\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Request\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Unblock users\"), \" request:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"URL\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Method\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"PUT\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"application/json\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--headers\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Headers\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Unblock users\"), \" headers:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Content-Type\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"application/json\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Authorization\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Admin token. See \", mdx(\"a\", {\n    href: \"/whatsapp/authentication_token\"\n  }, \"Generate authentication token\"), \".\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--parameters\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Parameters\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Unblock users\"), \" parameters:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"waba_id\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"WhatsApp Business Account ID.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"phone_number_id\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"ID of the phone number that unblocks the users.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--body\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Body\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Unblock users\"), \" body fields:\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-userobject\"\n  }, \"block_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of users to unblock.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of user objects\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--example\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Example\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Complete \", mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Unblock users\"), \" example:\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-bash\"\n  }, \"curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}' \\\\\\n--header 'Content-Type: application/json' \\\\\\n--header 'Authorization: Bearer {{admin-token}}' \\\\\\n--data '{\\n    \\\"block_users\\\": [\\n        {\\n            \\\"user\\\": \\\"2721520198\\\"\\n        }\\n    ]\\n}'\\n\"))), mdx(\"section\", {\n    \"id\": \"unblockusers--response\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Response\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Unblock users\"), \" response:\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"If the request succeeds, the service returns HTTP 200.\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-blockusersunblockobject\"\n  }, \"block_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object with the users that were unblocked and those that weren't.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--response--blockusersunblockobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Block users unblock object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-removedusersobject\"\n  }, \"removed_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of unblocked users.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of removed users objects\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-failedusersobject\"\n  }, \"failed_users\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of users that couldn't be unblocked.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of failed users objects\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--response--removedusersobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Removed users object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"input\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Identifier sent in the request.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"wa_id\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"WhatsApp ID resolved by Meta.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")))), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"block_users\\\": {\\n        \\\"removed_users\\\": [\\n            {\\n                \\\"input\\\": \\\"2721520198\\\",\\n                \\\"wa_id\\\": \\\"5212721520198\\\"\\n            }\\n        ],\\n        \\\"failed_users\\\": [\\n            {\\n                \\\"input\\\": \\\"US.13491208655302741918\\\",\\n                \\\"errors\\\": [\\n                    {\\n                        \\\"code\\\": 131047,\\n                        \\\"message\\\": \\\"Re-engagement check failed\\\",\\n                        \\\"error_data\\\": {\\n                            \\\"details\\\": \\\"Failed to block due to re-engagement check failed\\\"\\n                        }\\n                    }\\n                ]\\n            }\\n        ]\\n    }\\n}\\n\"))), mdx(\"section\", {\n    \"id\": \"unblockusers--response--failedusersobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Failed users object\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Used for both blocking and unblocking.\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"input\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Identifier sent in the request.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-errorsobject\"\n  }, \"errors\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of errors that prevented the operation.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of errors objects\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--response--errorsobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Errors object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"code\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Error code.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Number\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"message\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Error message.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/administration/block_users/block#h-errordataobject\"\n  }, \"error_data\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Error details.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object\"))))), mdx(\"section\", {\n    \"id\": \"unblockusers--response--errordataobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Error data object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"details\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Detailed reason why the user couldn't be blocked or unblocked.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\")))), mdx(\"br\", null), mdx(\"hr\", {\n    parentName: \"section\"\n  })));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#block-users","title":"Block users","items":[{"url":"#request","title":"Request"},{"url":"#headers","title":"Headers"},{"url":"#parameters","title":"Parameters"},{"url":"#body","title":"Body","items":[{"url":"#user-object","title":"User object"}]},{"url":"#example","title":"Example"},{"url":"#response","title":"Response","items":[{"url":"#block-users-object","title":"Block users object"},{"url":"#added-users-object","title":"Added users object"}]}]},{"url":"#unblock-users","title":"Unblock users","items":[{"url":"#request-1","title":"Request"},{"url":"#headers-1","title":"Headers"},{"url":"#parameters-1","title":"Parameters"},{"url":"#body-1","title":"Body"},{"url":"#example-1","title":"Example"},{"url":"#response-1","title":"Response","items":[{"url":"#block-users-unblock-object","title":"Block users unblock object"},{"url":"#removed-users-object","title":"Removed users object"},{"url":"#failed-users-object","title":"Failed users object"},{"url":"#errors-object","title":"Errors object"},{"url":"#error-data-object","title":"Error data object"}]}]}]},"timeToRead":1,"parent":{"__typename":"File","relativePath":"whatsapp/administration/block_users/block.md","fields":{"gitLogLatestAuthorName":"Irais Aguirre","gitLogLatestAuthorEmail":"irais.aguirre@conceptomovil.com","gitLogLatestDate":"6 hours ago"}},"frontmatter":{"metaTitle":null,"showMetadata":null,"editable":null,"showPreviousNext":null,"showToc":null}},"gitBranch":{"name":"20211019-2FACTOR_AUTH"},"gitCommit":{"hash":"9713e1925aeb8cad930f91b6bf05d0b5937b2bb5","date":"2026-11-13 06:39"}},"pageContext":{"id":"1cdbd20f-9972-54cb-a51a-aedf8f5d7741"}},"staticQueryHashes":["12478684","12478684","2882937274","2882937274","353167761","353167761"]}