PUT api/me/services/phone
Updates your virtual phone number service settings, replacing them entirely with the given information
Request Information
URI Parameters
None.
Body Parameters
Updated virtual phone service settings
VirtualPhoneSettingsDTO| Name | Description | Type | Additional information |
|---|---|---|---|
|
The incoming email address associated with the account, if any |
string |
None. |
|
| PlainEmail |
Whether the email sent out should be plain text or not |
boolean |
Required |
| CallbackURL |
URL that should be called when incoming SMS are received, if any |
string |
None. |
Request Formats
application/json, text/json
{
"Email": "sample string 1",
"PlainEmail": true,
"CallbackURL": "sample string 3"
}
Response Information
Resource Description
Service status information
VirtualPhoneServiceStatusDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| VirtualPhone |
The virtual phone number associated with the account, if any |
string |
None. |
| VirtualPhonePrefix |
The virtual phone prefix associated with the account, if any |
string |
None. |
|
The incoming email address associated with the account, if any |
string |
None. |
|
| PlainEmail |
Whether the email should be plain text or not |
boolean |
None. |
| CallbackURL |
URL that should be called when incoming SMS are received, if any |
string |
None. |
| ID |
Service type ID |
integer |
None. |
| Name |
Name of service |
string |
None. |
| Status |
Service status |
ServiceStatus |
None. |
| StatusDescription |
Service status description |
string |
None. |
| Since |
When the service began |
date |
None. |
| Until |
When the service stops |
date |
None. |
Response Formats
application/json, text/json
{
"VirtualPhone": "sample string 1",
"VirtualPhonePrefix": "sample string 2",
"Email": "sample string 3",
"PlainEmail": true,
"CallbackURL": "sample string 5",
"ID": 6,
"Name": "sample string 7",
"Status": 0,
"StatusDescription": "None",
"Since": "2025-12-16T03:27:11.4022847+00:00",
"Until": "2025-12-16T03:27:11.4022847+00:00"
}