MyAccount Profiles
A MyAccount profile controls what a customer can see and do in the self-service portal. See the MyAccount Profiles guide for how they are used.
Methods
Section titled “Methods”Retrieve Single MyAccount Profile
Section titled “Retrieve Single MyAccount Profile”/backend/api/v1/myAccountCustomerProfiles/ID - fetch the profile with the specified ID.
List MyAccount Profiles
Section titled “List MyAccount Profiles”/backend/api/v1/myAccountCustomerProfiles/ - list all profiles.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include profiles with a higher ID |
createdSince | datetime | No | Only include profiles created since the given time |
updatedSince | datetime | No | Only include profiles updated since the given time |
/backend/api/v1/myAccountCustomerProfiles/ - add a new profile. The newly-added profile will be returned.
/backend/api/v1/myAccountCustomerProfiles/ID - update the profile with the specified ID. The modified profile will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/myAccountCustomerProfiles/ID - delete the profile with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| name | My Account Profile Name | Text | Name of the MyAccount profile for identification purposes |
| description | Description | Text | Optional description explaining the purpose of this MyAccount profile |
| availability | Availability | Preset Value | Availability setting for this profile |
| customerID | Customer | Text | The ID of the customer this MyAccount profile is restricted to |
| customerGroups | Customer Groups | Text | Array of customer group names this profile applies to |
| myAccountFlags | MyAccount Flags | Preset Value(s) | Array of MyAccount flag names enabled for this profile |
| myNumbers | MyNumbers | Preset Value(s) | Array of MyNumbers feature names available in this profile |
| myCampaigns | MyCampaigns | Preset Value(s) | Array of MyCampaigns feature names available in this profile |
| myCallsEnabled | My Calls Enabled | Text | Boolean flag to enable My Calls reporting |
| myCallsDailyCDRAccess | My Calls Daily CDR Access | Text | Boolean flag for daily CDR report access |
| myCallsUseBackendDescriptions | My Calls Use Backend Descriptions | Text | Boolean flag to include backend-managed sites, descriptions and campaigns |
| id | MyAccount Profile ID | Text | The unique identifier for this MyAccount profile |