Patch Communications Preferences
patch
/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}
This operation updates communication details for provided Account Id and Person Id combination.
Request
Path Parameters
-
accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.Example:
0833559999
-
personId(required): string
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:
3903069999
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:0833559999
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put -
notificationTypeList: array
notificationTypeList
-
personId: string
Maximum Length:
10
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:3903069999
Nested Schema : items
Type:
Show Source
object
-
isOptedOut: boolean
opt out
-
isOptOutAllowed: boolean
opt out allow
-
notificationOption: array
notificationOption
If the notification type is a subscription, an optional list of notification option extension fields to capture
-
notificationPreferenceList: array
notificationPreferenceList
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
-
notificationType: string
Maximum Length:
30
Notification Type displays the code for the notification preferences for the customer in context.Example:ZZBUG23605115
-
notificationTypeDescription: string
Maximum Length:
100
Notification Type displays the description for the notification preferences for the customer in context.Example:Test for Bug 23605115
-
optOutPreferenceId: string
Maximum Length:
14
Communication Preference -
subscriptionOrPush: string
Allowed Values:
[ "C1PU", "C1SU" ]
Subscription/Push defines if a notification is a push or a subscription type notification. * `C1PU` - Push, * `C1SU` - SubscriptionExample:C1PU
Nested Schema : notificationOption
Type:
array
If the notification type is a subscription, an optional list of notification option extension fields to capture
Show Source
Nested Schema : notificationPreferenceList
Type:
array
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
Show Source
Nested Schema : items
Type:
Show Source
object
-
dataType: string
Maximum Length:
106
Data type lookup field for the option value.Example:NUMB
-
label: string
Maximum Length:
60
Label of the option if allowed for the subscription notification type.Example:Days Before
-
precision: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Precision, if numericExample:1
-
required: string
Allowed Values:
[ "N ", "Y " ]
Required Y or N flag * `N ` - No, * `Y ` - YesExample:N
-
scale: number
Minimum Value:
-999
Maximum Value:999
Scale, if numericExample:0
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence if the notification type is a subscription that allows for an option to be set.Example:10
-
sign: boolean
Sign, if numericExample:
false
-
transactionalBOXpath: string
Maximum Length:
4000
Path to the option value being stored.Example:dueInfo/numberOfDaysBeforeDue
-
validValue: array
validValue
-
value: string
Maximum Length:
254
Value of the option that is set for the customer subscription.Example:3
Nested Schema : items
Type:
Show Source
object
-
label: string
Maximum Length:
10
LABEL -
value: string
Maximum Length:
254
Value of the option that is set for the customer subscription.Example:3
Nested Schema : items
Type:
Show Source
object
-
contactDetailId: string
Maximum Length:
10
Person contact details IDExample:3904719666
-
contactDetailValue: string
Maximum Length:
254
Person contact details valueExample:1234567
-
deliveryType: string
Allowed Values:
[ "EMAI", "FAX ", "IVR ", "SMS " ]
Delivery type * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMSExample:SMS
-
deliveryTypeDescription: string
Maximum Length:
60
Delivery type descriptionExample:SMS
-
keepPreference: boolean
Allow Communication Preference
-
nickname: string
Maximum Length:
100
Person contact details nickname -
notificationPreferenceId: string
Maximum Length:
14
Communication Preference
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:0833559999
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put -
notificationTypeList: array
notificationTypeList
-
personId: string
Maximum Length:
10
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:3903069999
Nested Schema : items
Type:
Show Source
object
-
isOptedOut: boolean
opt out
-
isOptOutAllowed: boolean
opt out allow
-
notificationOption: array
notificationOption
If the notification type is a subscription, an optional list of notification option extension fields to capture
-
notificationPreferenceList: array
notificationPreferenceList
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
-
notificationType: string
Maximum Length:
30
Notification Type displays the code for the notification preferences for the customer in context.Example:ZZBUG23605115
-
notificationTypeDescription: string
Maximum Length:
100
Notification Type displays the description for the notification preferences for the customer in context.Example:Test for Bug 23605115
-
optOutPreferenceId: string
Maximum Length:
14
Communication Preference -
subscriptionOrPush: string
Allowed Values:
[ "C1PU", "C1SU" ]
Subscription/Push defines if a notification is a push or a subscription type notification. * `C1PU` - Push, * `C1SU` - SubscriptionExample:C1PU
Nested Schema : notificationOption
Type:
array
If the notification type is a subscription, an optional list of notification option extension fields to capture
Show Source
Nested Schema : notificationPreferenceList
Type:
array
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
Show Source
Nested Schema : items
Type:
Show Source
object
-
dataType: string
Maximum Length:
106
Data type lookup field for the option value.Example:NUMB
-
label: string
Maximum Length:
60
Label of the option if allowed for the subscription notification type.Example:Days Before
-
precision: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Precision, if numericExample:1
-
required: string
Allowed Values:
[ "N ", "Y " ]
Required Y or N flag * `N ` - No, * `Y ` - YesExample:N
-
scale: number
Minimum Value:
-999
Maximum Value:999
Scale, if numericExample:0
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence if the notification type is a subscription that allows for an option to be set.Example:10
-
sign: boolean
Sign, if numericExample:
false
-
transactionalBOXpath: string
Maximum Length:
4000
Path to the option value being stored.Example:dueInfo/numberOfDaysBeforeDue
-
validValue: array
validValue
-
value: string
Maximum Length:
254
Value of the option that is set for the customer subscription.Example:3
Nested Schema : items
Type:
Show Source
object
-
label: string
Maximum Length:
10
LABEL -
value: string
Maximum Length:
254
Value of the option that is set for the customer subscription.Example:3
Nested Schema : items
Type:
Show Source
object
-
contactDetailId: string
Maximum Length:
10
Person contact details IDExample:3904719666
-
contactDetailValue: string
Maximum Length:
254
Person contact details valueExample:1234567
-
deliveryType: string
Allowed Values:
[ "EMAI", "FAX ", "IVR ", "SMS " ]
Delivery type * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMSExample:SMS
-
deliveryTypeDescription: string
Maximum Length:
60
Delivery type descriptionExample:SMS
-
keepPreference: boolean
Allow Communication Preference
-
nickname: string
Maximum Length:
100
Person contact details nickname -
notificationPreferenceId: string
Maximum Length:
14
Communication Preference
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1ComPrefer
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:0833559999
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put -
notificationTypeList: array
notificationTypeList
-
personId: string
Maximum Length:
10
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:3903069999
Nested Schema : items
Type:
Show Source
object
-
isOptedOut: boolean
opt out
-
isOptOutAllowed: boolean
opt out allow
-
notificationOption: array
notificationOption
If the notification type is a subscription, an optional list of notification option extension fields to capture
-
notificationPreferenceList: array
notificationPreferenceList
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
-
notificationType: string
Maximum Length:
30
Notification Type displays the code for the notification preferences for the customer in context.Example:ZZBUG23605115
-
notificationTypeDescription: string
Maximum Length:
100
Notification Type displays the description for the notification preferences for the customer in context.Example:Test for Bug 23605115
-
optOutPreferenceId: string
Maximum Length:
14
Communication Preference -
subscriptionOrPush: string
Allowed Values:
[ "C1PU", "C1SU" ]
Subscription/Push defines if a notification is a push or a subscription type notification. * `C1PU` - Push, * `C1SU` - SubscriptionExample:C1PU
Nested Schema : notificationOption
Type:
array
If the notification type is a subscription, an optional list of notification option extension fields to capture
Show Source
Nested Schema : notificationPreferenceList
Type:
array
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
Show Source
Nested Schema : items
Type:
Show Source
object
-
dataType: string
Maximum Length:
106
Data type lookup field for the option value.Example:NUMB
-
label: string
Maximum Length:
60
Label of the option if allowed for the subscription notification type.Example:Days Before
-
precision: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Precision, if numericExample:1
-
required: string
Allowed Values:
[ "N ", "Y " ]
Required Y or N flag * `N ` - No, * `Y ` - YesExample:N
-
scale: number
Minimum Value:
-999
Maximum Value:999
Scale, if numericExample:0
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence if the notification type is a subscription that allows for an option to be set.Example:10
-
sign: boolean
Sign, if numericExample:
false
-
transactionalBOXpath: string
Maximum Length:
4000
Path to the option value being stored.Example:dueInfo/numberOfDaysBeforeDue
-
validValue: array
validValue
-
value: string
Maximum Length:
254
Value of the option that is set for the customer subscription.Example:3
Nested Schema : items
Type:
Show Source
object
-
label: string
Maximum Length:
10
LABEL -
value: string
Maximum Length:
254
Value of the option that is set for the customer subscription.Example:3
Nested Schema : items
Type:
Show Source
object
-
contactDetailId: string
Maximum Length:
10
Person contact details IDExample:3904719666
-
contactDetailValue: string
Maximum Length:
254
Person contact details valueExample:1234567
-
deliveryType: string
Allowed Values:
[ "EMAI", "FAX ", "IVR ", "SMS " ]
Delivery type * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMSExample:SMS
-
deliveryTypeDescription: string
Maximum Length:
60
Delivery type descriptionExample:SMS
-
keepPreference: boolean
Allow Communication Preference
-
nickname: string
Maximum Length:
100
Person contact details nickname -
notificationPreferenceId: string
Maximum Length:
14
Communication Preference
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.