{
  "messaging_product": "whatsapp",
  "block_users": {
    "removed_users": [
      {
        "input": "+12025550101",
        "wa_id": "12025550101",
        "user_id": "US.123456789012345"
      }
    ],
    "failed_users": []
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

WhatsApp Blocked Users

Unblock users

Removes users from the blocklist so they can send messages to the specified WhatsApp business phone number again. You must have management permissions for this business phone number. YCloud synchronizes the operation with Meta’s WhatsApp platform.

Provide at least one non-empty list: users for phone numbers in E.164 format or userIds for WhatsApp Business-scoped user IDs (BSUIDs). You can provide both lists, with at most 100 entries in total. Check block_users.removed_users for successful results and block_users.failed_users for per-user failures.

POST

https://api.ycloud.com/v2

/

whatsapp

/

{businessPhoneNumber}

/

unblockUsers

{
  "messaging_product": "whatsapp",
  "block_users": {
    "removed_users": [
      {
        "input": "+12025550101",
        "wa_id": "12025550101",
        "user_id": "US.123456789012345"
      }
    ],
    "failed_users": []
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

businessPhoneNumber

string

required

The WhatsApp business phone number in E.164 format.

Example:

"+16315551111"

Body

application/json

Option 1
Option 2

Users to block or unblock. Provide at least one non-empty list of phone numbers or WhatsApp Business-scoped user IDs (BSUIDs). You can provide both lists. The combined number of entries in users and userIds must not exceed 100.

users

string[]

required

User phone numbers in E.164 format. These share the 100-entry request limit with userIds.

Required array length: 1 - 100 elements

Example:

["+12025550101"]

userIds

string[]

WhatsApp Business-scoped user IDs (BSUIDs), including parent BSUIDs. Values are trimmed and normalized to uppercase. These share the 100-entry request limit with users.

Maximum array length: 100

Example:

["US.123456789012345"]

Response

Successfully processed the unblock request. Check the result for each user.

messaging_product

string

Messaging product used for the operation.

Example:

"whatsapp"

block_users

object

Show child attributes

errors

object

The original error object returned by WhatsApp. See Handling Errors, Cloud API Error Codes.

Show child attributes