POST | /customers/{customerId}/customerbatches | Creates 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. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"customerId":"00000000-0000-0000-0000-000000000000","batchTypeId":0,"configurationKey":"String","configurationValue":"String","isDeleted":false}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length 0