BootView WebApi

<back to all web services

CreateCustomerNoticeProgram

The following routes are available for this service:
POST/customers/{customerId}/noticeprogramsCreates 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.
CreateCustomerNoticeProgram Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer id
DescriptionbodystringYesThe label to show, or the program name.
IsActivebodyboolYesWhether the notice program is active (available) or not.
SendNotificationbodyboolYesWhether the notice program can send notice notifications or not.
IsInvoiceablebodyboolYesWhether 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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/CreateCustomerNoticeProgram HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000,
	description: String,
	isActive: False,
	sendNotification: False,
	isInvoiceable: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

0