On this page
No Headings
BMManageButtonStatus API Operation (SOAP)
Last updated: June 10, 2026
API
Changes the status of a hosted button.
Important:
The Button Manager API is deprecated. For new integrations, see the associated topic.
| Button | See |
|---|---|
| Buy Now | PayPal Checkout Overview |
| Add to Cart | Solution Providers |
| Donate | Create a Donate button |
| Automatic Billing Subscribe | Subscriptions Overview |
Currently, you can only delete a button.
BMManageButtonStatus request
The request specifies the hosted button's ID and the status to which to set the button.
BMManageButtonStatus request parameters
| Field | Description |
|---|---|
HostedButtonID | xs:string(Required) The ID of the hosted button whose status you want to change. |
ButtonStatus | ebl:ButtonStatusType(Required) The new status of the button. Value is:
|
BMManageButtonStatus response
The response does not include any fields that are specific to the BMManageButtonStatus API operation.
BMManageButtonStatus errors
| Error code | Short and long messages | User action |
|---|---|---|
| 10001 | Internal Error Internal Error | To learn more about possible causes and corrective actions, see What is API error code 10001?. |
| 11950 | Invalid Data A hosted button ID must be specified. | |
| 11951 | Invalid Argument The hosted button ID specified is invalid. | |
| 11951 | Invalid Argument The hosted button ID specified is invalid. | |
| 11992 | Invalid Argument You do not have permissions to access this button. Verify the hosted button ID and try the request again. | |
| 11993 | Invalid Argument The button status value specified is not valid. |