BootView WebApi

<back to all web services

CreateCustomerBatchConfiguration

The following routes are available for this service:
POST/customers/{customerId}/customerbatchesCreates a new batch configuration for the given customer. Fails if this user does not have access to this customer or if either property is missing.
CreateCustomerBatchConfiguration Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer id
BatchTypeIdbodyintYesThe batch type
ConfigurationKeybodystringYesThe configuration key or name.
ConfigurationValuebodystringYesThe configuration value.
IsDeletedbodyboolNoWhether the batch configuration is deleted (visible) or not.

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /customers/{customerId}/customerbatches HTTP/1.1 
Host: api.paylock.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"customerId":"00000000000000000000000000000000","batchTypeId":0,"configurationKey":"String","configurationValue":"String","isDeleted":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

0