POST v1/api/SaveCommunicationOptions
Save Communication Options
Request Information
URI Parameters
None.
Body Parameters
CommunicationOptionsRequestDto
CommunicationOptionsRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| CommunicationType | CommunicationTypeEnum |
None. |
|
| CommunicationTypeValue | string |
None. |
|
| CommunicationCountryCode | string |
None. |
|
| UserId | string |
None. |
|
| CompanyCode | SBLICompanyEnum |
None. |
|
| UtcOffset | integer |
None. |
|
| DaylightSavingsRecognized | YorNEnum |
None. |
|
| CommunicationChannels | Collection of CommunicationChannelDto |
None. |
Request Formats
application/json
Sample:
REQUEST
{
"CommunicationType": "SMS",
"CommunicationTypeValue": "978-123-4578",
"CompanyCode": "SBLI",
"CommunicationChannels": [
{
"CommunicationChannel": "MARKETING",
"CommunicationSubChannel": "BASE",
"OptIn": "OPTEDIN",
},
]
}
Response Information
Resource Description
CommunicationOptionsResponseDto
CommunicationOptionsResponseDto| Name | Description | Type | Additional information |
|---|---|---|---|
| CommunicationOptionsRecord | Collection of CommunicationOptionsRecordDto |
None. |
Response Formats
application/json
Sample:
RESPONSE
{
"MessageId": "dc75ee23-b89d-41c8-943c-6439a4b6813f",
"FromNumber": null,
"ToNumber": "9781234578",
"NotifyId": "5dbd63b7-6e4a-4c71-a2cb-6b5722a68e48"
}