{"_id":"5bcf3922e8455d049c357e2c","category":{"_id":"5bcf3922e8455d049c357e12","version":"5bcf3922e8455d049c357ed7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-12T15:22:00.041Z","from_sync":false,"order":4,"slug":"coupon","title":"Catalog"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5bcf3922e8455d049c357ed7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b8ec6a1f8dd7c0003386069","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5bcf3922e8455d049c357e0e","5bcf3922e8455d049c357e0f","5bcf3922e8455d049c357e10","5bcf3922e8455d049c357e11","5bcf3922e8455d049c357e12","5bcf3922e8455d049c357e13","5bcf3922e8455d049c357e14","5bcf3922e8455d049c357e15","5bcf3922e8455d049c357e16","5bcf3922e8455d049c357e17","5bcf3922e8455d049c357e18"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27.2 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-12T15:20:51.305Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"code":"","language":"text"}]},"settings":"","auth":"optional","params":[],"url":""},"isReference":true,"order":8,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/catalog/custom-parameters/:custom-parameter-id</span>\n\n<hr>\n\n##Documentation\nThe Update Custom Parameter enables you to modify existing custom parameters in your BlueSnap account.\n\n###Request Content\n`custom-parameter` <span style=\"color:#F37500\">**required**</span>, contains the following properties (see [custom-parameter](doc:custom-parameter)):\n `custom-param-title` *string* <span style=\"color:#F37500\">**required**</span>\n `active` *boolean* optional\n `mandatory` *boolean* optional\n `custom-param-settings` *container* <span style=\"color:#F37500\">**required**</span>, contains the following properties (see [custom-param-settings](doc:custom-param-settings)):\n `custom-param-type` *string* <span style=\"color:#F37500\">**required**</span>\n `short-text-type` *container* optional (see [short-text-type](doc:short-text-type))\n `visual-settings` *container* optional (see [visual-settings](doc:visual-settings))\n `fixed-selection-type` *container* optional (see [fixed-selection-type](doc:fixed-selection-type))\n `merchant-value-type` *container* optional (see [merchant-value-type](doc:merchant-value-type))\n\n###Response Details\nIf successful, the response HTTP status code is 204 No Content.\nThere is no content in the response body.\nFor details about possible errors, see: [General Errors](doc:general-errors) and [Catalog Errors](doc:catalog-errors).\n\n<hr>\n\n##Examples\n\n###Request Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/catalog/custom-parameters/16561 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<custom-parameter xmlns=\\\"http://ws.plimus.com\\\">\\n <custom-param-title>Where did you hear about us?</custom-param-title>\\n <active>true</active>\\n <mandatory>true</mandatory>\\n <custom-param-settings>\\n <custom-param-type>SHORT-TEXT</custom-param-type>\\n <short-text-type>\\n <maximum-length>2000</maximum-length>\\n <minimum-length>7</minimum-length>\\n <regex-validation>[a-zA-Z]</regex-validation>\\n </short-text-type>\\n <visual-settings>\\n <title-alignment>LEFT</title-alignment>\\n </visual-settings>\\n </custom-param-settings>\\n</custom-parameter>'\",\n \"language\": \"curl\",\n \"name\": \"Update Custom Parameter Request\"\n }\n ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"HTTP/ 1.1 204 No Content\",\n \"language\": \"xml\",\n \"name\": \"Update Custom Parameter Response\"\n }\n ]\n}\n[/block]","excerpt":"","slug":"update-custom-parameter","type":"endpoint","title":"Update Custom Parameter"}putUpdate Custom Parameter
Definition
https://sandbox.bluesnap.com/services/2/catalog/custom-parameters/:custom-parameter-id
Documentation
The Update Custom Parameter enables you to modify existing custom parameters in your BlueSnap account.
Request Content
custom-parameter required, contains the following properties (see custom-parameter):
custom-param-title string required
active boolean optional
mandatory boolean optional
custom-param-settings container required, contains the following properties (see custom-param-settings):
custom-param-type string required
short-text-type container optional (see short-text-type)
visual-settings container optional (see visual-settings)
fixed-selection-type container optional (see fixed-selection-type)
merchant-value-type container optional (see merchant-value-type)
Response Details
If successful, the response HTTP status code is 204 No Content.
There is no content in the response body.
For details about possible errors, see: General Errors and Catalog Errors.
Examples
Request Example
curl -v -X PUT https://sandbox.bluesnap.com/services/2/catalog/custom-parameters/16561 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<custom-parameter xmlns="http://ws.plimus.com">
<custom-param-title>Where did you hear about us?</custom-param-title>
<active>true</active>
<mandatory>true</mandatory>
<custom-param-settings>
<custom-param-type>SHORT-TEXT</custom-param-type>
<short-text-type>
<maximum-length>2000</maximum-length>
<minimum-length>7</minimum-length>
<regex-validation>[a-zA-Z]</regex-validation>
</short-text-type>
<visual-settings>
<title-alignment>LEFT</title-alignment>
</visual-settings>
</custom-param-settings>
</custom-parameter>'HTTP/ 1.1 204 No Content