Cancel an Alias of a Virtual Account

This service allows you to deactivate an alias that you are no longer using.

Info

You must have at least one alias associated with your account at all times.

Path Params
string
required

The unique identifier of the virtual account associated with the alias you want to cancel. This must be the exact externalId value of the virtual account.

Body Params
string
enum
required

The type of alias to be associated, can be E for email or P for phone number.

Allowed:
string
required

Value indicating the type of alias to be configured—either an email address or a phone number.

Headers
string
required

Bearer access token for authentication. This token is obtained from the Get Access Token or Refresh Access Token endpoints.

Responses

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json