BootView WebApi

<back to all web services

UpdateCustomerNoticeType

The following routes are available for this service:
PUT/customers/{customerId}/noticeprograms/{programId}/noticetypes/{id}Updates an existing notice type for the given customer's given notice program. Fails if this user does not have access to this customer or if the notice type or notice program doesn't exist.
UpdateCustomerNoticeType Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe notice program id
CustomerIdpathGuidYesThe customer id
ProgramIdpathintYesThe notice program id
NamebodystringYesThe label to show, or the reason.
IsActivebodyboolYesWhether the notice type is active (available) or not.
SequencebodyintNoThis notice type's place in the seqence of other notice types within a notice program.
HiatusbodyintYesThe length, in days before another notice should be issued.
IsRealTimeNoticebodyboolNoWhether or not this notice type is a 'real-time' synchronized notice (i.e. events about it are sent between data partners as they happen).
IsEmailableNoticebodyboolNoWhether or not this notice type is emailable (i.e. email our partner when a notice of this type happens).

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/UpdateCustomerNoticeType HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	customerId: 00000000000000000000000000000000,
	programId: 0,
	name: String,
	isActive: False,
	sequence: 0,
	hiatus: 0,
	isRealTimeNotice: False,
	isEmailableNotice: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

0