Skip to main content

Updating Browser Profile

Description: This method updates an existing browser profile.

Request parameters:

ParameterTypeFormatDefaultDescription
profileIdstringuuid(required)Unique identifier of the edited profile (required).
workspaceIdintegerint64-1Workspace identifier. -1 means the default workspace.
folderIdstringuuid(empty)New folder which the profile will be moved to (optional).
namestring(empty)New profile name.
notesstring(empty)New profile notes (optional).
tagsstring(empty)New profile tags separated by spaces (optional).
note

The ID of the profile to update should be specified inside curly braces { } in the URL path.

Example request:

PUT
CURL:

curl 'http://localhost:8160/v1/profiles/{profileId}?workspaceId=-1&folderId=a2f76986-8064-4c2f-b109-64a84b4ce137&name=NewName&notes=Note123&tags=tag1 tag2' \
--request PUT \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("http://localhost:8160/v1/profiles/{profileId}?workspaceId=-1&folderId=a2f76986-8064-4c2f-b109-64a84b4ce137&name=NewName&notes=Note123&tags=tag1 tag2"),
Headers =
{
{ "Api-Token", "YOUR_SECRET_TOKEN" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}

Cube:

http://localhost:8160/v1/profiles/{profileId}?workspaceId=-1&folderId=a2f76986-8064-4c2f-b109-64a84b4ce137&name=NewName&notes=Note123&tags=tag1 tag2

Additionally:
User-Agent: {-Profile.UserAgent-}
Api-Token: Token from UserArea2.

Response API:

Response codeResult
200 OKSuccess
500 ErrorInternal Server Error

Success Response (200 OK):

No content returned on successful update.

Error Response (500):

{
"message": null
}