ForSURE.settingspage.profile_management.profile_management_endpoints

baseURL = '/settings/profile'

Base URL for all requests

GET {baseURL}
async def get_profiles_list()

Get the available profiles. If none are defined yet, it will create one named 'New Profile'.

Returns

Successful response 
    [
        {
            "id": 14,
            "name": "Profile Name",
            "liveData": false
        },
        {
            "id": 27,
            "name": "Shopify",
            "liveData": true
        },
    ]

POST {baseURL}/add
async def add_profile()

Adds a new profile.

Parameters
  • profile: 
         {
         "name": "Profile Name",
         "liveData": false
     }
Returns

Successful response 
{
        "id": 14,
        "name": "Profile Name",
        "liveData": false
    }

DELETE {baseURL}/delete?profile_id={ID}
async def delete_profiles()

Deletes a profile.

Parameters
  • profile_id: int containing the profile ID
Returns

Successful response 
 {"success": true}

POST {baseURL}/rename
async def edit_profile()

Edits an existing profile.

Parameters
  • profile: 
         {
         "id": 14
         "name": "New Profile Name",
         "liveData": false
     }
Returns

Successful response 
{
        "id": 14,
        "name": "New Profile Name",
        "liveData": false
    }