PUT | /customers/{customerId}/customerbatches/{id} | Updates an existing batch configuration for the given customer. Fails if this user does not have access to this customer or if the batch configuration doesn't exist. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | Guid | Yes | The batch configuration id |
CustomerId | path | Guid | Yes | The customer id |
BatchTypeId | body | int | Yes | The batch type |
ConfigurationKey | body | string | Yes | The configuration key or name. |
ConfigurationValue | body | string | Yes | The configuration value. |
IsDeleted | body | bool | No | Whether the batch configuration is deleted (visible) or not. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /customers/{customerId}/customerbatches/{id} HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
customerId: 00000000000000000000000000000000,
batchTypeId: 0,
configurationKey: String,
configurationValue: String,
isDeleted: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length 0