An email address was updated by the Program API. This event is triggered when any value is passed for the email parameter, even when the value is the same as the old value. Changes made in the CST also trigger this event.
- Code —
ECHG - Event trigger — The
emailfield is updated. - Processes — These processes contain the event trigger:
- Update Account endpoint
- Customer Service Tool
Fields
All fields are strings. Your field names may vary. Default fields are included in the default webhook template. See Default and optional fields for more information.
| Field | Default | Description |
|---|---|---|
| avail_cash | For debit accounts, the |
|
| avail_credit | For credit accounts, the available credit limit to spend. Example: |
|
| balance_id | X | The balance ID, also called the |
| ch_group_id | Corporate Hierarchy group identifier. Example: |
|
| credit_balance | For credit accounts, the total amount of unpaid purchases and advances. Example: |
|
| X | New email address. Example: |
|
| extcustid | Identifier used to associate multiple accounts under the same customer. This identifier is supplied by the provider, not SoFi Tech Solutions. Example: |
|
| msg_event_id | Unique system-generated identifier for this message. Example: |
|
| msg_id | The four-letter code to identify this event. Example: |
|
| open_to_buy | X | The available balance to spend. Example: |
| pmt_ref_no | X | SoFi Tech Solutions 12-digit payment reference number (PRN) for the account. Example: |
| prod_id | X | The product ID of the account. Example: |
| prog_id | X | The program ID of the account. Example: |
| timestamp | X | Timestamp for when this event was created, in system time. Format: |
| type | X | The name of this event: |
| user_data | Populated according to your use case and needs by arrangement with SoFi Tech Solutions. |
Example
# email_addr_change example:
{
"avail_cash": "143.11",
"avail_credit": "432.00",
"balance_id": "20211",
"credit_balance": "325.00",
"email": "[email protected]",
"extcustid": "acv#-@45!sbsxm%-",
"msg_event_id": "243693",
"msg_id": "ECHG",
"open_to_buy": "500.00",
"pmt_ref_no": "999101003022",
"prod_id": "1701",
"prog_id": "305",
"timestamp": "2025-01-31 17:20:33 MST",
"type": "email_addr_change"
}