The correspondenceDetails parameter of the Submit Case endpoint contains these fields as key/value pairs.
| Parameter | Req | Description | Example |
|---|---|---|---|
selectedChannel | X | String. The communication channel to update. Valid values are case-sensitive: Email or Mail | Email |
emailAddress | String. The account holder's email address. Required if selectedChannel: Email. | [email protected] | |
address | JSON object. The account holder's mailing address. Required if selectedChannel: Mail. Object contains the fields below. | See Examples | |
line1 | String. The first line of the account holder's mailing address. Required if selectedChannel: Mail. | 123 Crimson St | |
line2 | String. The second line of the account holder's mailing address. | Apt B6 | |
line3 | String. The third line of the account holder's mailing address. | ATTN: Supervisor | |
city | String. The city for the account holder's mailing address. Required if selectedChannel: Mail. | Seattle | |
state | String. The two-character state of the account holder's mailing address. | WA | |
zip | String. The postal code of the account holder's mailing address. Required if selectedChannel: Mail. 5 digits or 5-4 digits | 98109-0032 | |
country | String. The country of the account holder's mailing address. Required if selectedChannel: Mail. | USA |
Examples
If selectedChannel: Email
'correspondenceDetails': '{"selectedChannel": "Email", "emailAddress": "[email protected]"}'
If selectedChannel: Mail
'correspondenceDetails': '{"selectedChannel": "Mail", "address": {"line1": "123 Crimson St", "line2": "Apt B6", "line3": "ATTN: Supervisor", "city": "Seattle", "state": "WA", "zip": "98109-0032", "country": "USA"}}'