BMUpdateButton API Operation (SOAP)
Last updated: Aug 15th, 7:00am
Updates a PayPal-hosted Payments Standard website button.
The Button Manager API is deprecated. For new integrations, see the associated topic.
| Button | See |
|---|---|
|
Buy Now |
|
|
Add to Cart |
|
|
Donate |
|
|
Automatic Billing Subscribe |
This operation replaces all fields in a button. Therefore, you must specify a value for each field that you want to include for the button, whether or not it changed.
BMUpdateButton request
The hosted button ID identifies the button to modify. The remaining request parameters specify the characteristics of your button.
BMUpdateButton request parameters
Field | Description |
|---|---|
| (Required) The ID of the hosted button to modify. |
| (Required) The kind to update. Value is:
Note: You cannot change the kind of button after the button has been created. |
| (Optional) The kind of button code to create. Value is:
Note: You cannot change the kind of button code after after the button has been created. |
| (Optional) The use of button you want to create. Value is:
Note: After the button is created, you cannot change its usage. |
| (Optional) HTML standard button variables Lists variables, where n is a digit between 0 and 999, inclusive; do not include leading zeros. Character length and limitations: 63 single-byte alphanumeric characters each |
| (Optional) Menu items. |
| (Optional) Text description for a menu item Lists variables, where n is a digit between 0 and 1, inclusive. |
| (Optional) The kind of button image. Value is:
Note: Specify either the kind of button image or the URL. |
| (Optional) The button's URL. Note: Specify either the kind of button image or the URL. |
| (Optional) The button text for a Buy Now button. Value is:
|
| (Optional) The button text for a Subscribe button. Value is:
|
| (Optional) The country in which the transaction occurs. By default, it is the merchant's country of registration with PayPal. |
| (Optional) The language in which to display the button text. It must be compatible with the country code. Character length and limitations: Two single-byte alphanumeric characters. |
Option details fields
Field | Description |
|---|---|
| (Optional) The menu name. |
| (Optional) Menu items. |
Option selection details fields
| (Optional) The menu item's name. |
| (Optional) The price associated with the first menu item. Note: If you specify a price, you cannot set a button variable to amount. |
Button language options
The button language must be compatible with the country identified by the country code.
Country | Button language options. |
|---|---|
All countries not identified below. |
|
Austria |
|
Belgium |
|
Canada |
|
China (worldwide) |
|
France |
|
Germany |
|
Hong Kong |
|
Italy |
|
Japan |
|
Mexico |
|
Netherlands |
|
Poland |
|
Spain |
|
Switzerland |
|
United States |
|
BMUpdateButton response
The response contains the hosted button ID and the code for both the HTML in a website and a link in an email.
BMUpdateButton response fields
Field | Description |
|---|---|
| HTML code for web pages. |
| Code for email links and links in other documents that support external links. |
| The ID of a PayPal-hosted button. |
BMUpdateButton 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?. |
| 11923 | Invalid Argument The button image value specified is invalid. | |
| 11924 | Invalid Argument The button image URL specified is invalid. | |
| 11925 | Invalid Argument The button type specified is invalid. | |
| 11926 | Invalid Data One of the parameters specified by using ButtonVar is invalid. | |
| 11927 | Invalid Argument The Buy Now button text specified is invalid. | |
| 11928 | Invalid Argument The email or merchant ID specified is invalid. | |
| 11929 | Invalid Data A cart button must have an item name and amount specified. | |
| 11931 | Invalid Argument The subscription button text specified is invalid. | |
| 11932 | Invalid Data You must specify a corresponding number of entries for option names and selections. | |
| 11933 | Invalid Data You cannot skip index numbers for option selections. Option selections must be specified sequentially. | |
| 11934 | Invalid Data You must specify the same number of entries for option prices and selections. | |
| 11936 | Invalid Data You cannot specify both an item price and prices for individual selections within an option. | |
| 11937 | Invalid Argument A text box name specified is invalid. Text box names must not exceed 64 characters. | |
| 11938 | Invalid Argument The button code value specified is invalid. | |
| 11940 | Invalid Argument An option name specified is invalid. Option names must not exceed 64 characters. | |
| 11941 | Invalid Argument An option selection value specified is invalid. Option selection values must not exceed 64 characters. | |
| 11942 | Invalid Argument An option price value specified is invalid. Make sure any punctuation marks are in the correct places. | |
| 11943 | Invalid Argument The button country value specified is invalid. | |
| 11945 | Invalid Data The button country and language code combination specified is invalid. | |
| 11947 | Invalid Argument The tax rate specified is invalid. Make sure any punctuation marks are in the correct places and value specified is in the range 0.0 to 100. | |
| 11948 | Invalid Argument The amount specified is invalid. Make sure any punctuation marks are in the correct places. | |
12210 | Invalid Argument The currency code value specified is invalid. | |
13117 | Invalid Argument Subtotal amount is not valid. | |
13118 | Invalid Argument Tax amount is not valid. | |
13119 | Invalid Argument Handling amount is not valid. | |
13120 | Invalid Argument Shipping amount is not valid. |