Participant APIs | REST

Version:
Download Open API Specification

Unregister a mobile number

https://api.wealthcare.com/participant/services/participant/communications/mobile/{tpaId}/{employerId}/{participantId}/{mobilePhoneNumber}

Unregisters a specified mobile phone number for a participant, effectively removing it from their communication preferences.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • participantId string Required

    Unique identifier for the participant whose features are being queried.

  • mobilePhoneNumber string Required

    Mobile phone number

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

  • validate integer <int32>

    Indicates whether the mobile phone number format should be validated. Use 1 to validate and 0 to skip validation.