Participant APIs | REST

Refresh Cache
Selected Version:
Download Open API Specification

Retrieve consent status for a participant phone number

https://qa.api.wealthcare.com/participant/services/participant/communications/mobile/campaigns/{tpaId}/consents/{phoneNumber}

This operation retrieves the consent status associated with a specific participant's phone number, identified by the TPA ID. It is useful for verifying whether a participant has consented to receive communications via their mobile number.

Request

  • tpaId string Required

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

  • phoneNumber string Required

    A participant phone number

Response

  • Status string

    The consent status for the phone number.

AI Assistant Preview

Generating response...