| POST | /customers/{customerId}/noticeprograms | Creates a new notice program 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 |
| Description | body | string | Yes | The label to show, or the program name. |
| IsActive | body | bool | Yes | Whether the notice program is active (available) or not. |
| SendNotification | body | bool | Yes | Whether the notice program can send notice notifications or not. |
| IsInvoiceable | body | bool | Yes | Whether the notice program can be used for invoicing 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}/noticeprograms HTTP/1.1
Host: api.paylock.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"customerId":"00000000000000000000000000000000","description":"String","isActive":false,"sendNotification":false,"isInvoiceable":false}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length 0