Перейти к основному содержимому

Обновление папки профиля

Описание: Этот метод можно использовать для обновления имени папки профиля.

Параметры запроса:

ParameterTypeFormatDefaultDescription
profileFolderIdstringuuidУникальный идентификатор папки профиля, которую нужно обновить.
namestringНовое имя папки профиля.
workspaceIdintegerint64-1Идентификатор рабочего пространства, связанного с папкой профиля. По умолчанию -1, если не указан.
примечание

ID редактируемой папки профиля должен быть указан в фигурных скобках { } в пути URL.

Пример запроса:

PUT
CURL:

curl 'http://localhost:8160/v1/profile_folders/{profileFolderId}?name=&workspaceId=-1' \
--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/profile_folders/{profileFolderId}?name=&workspaceId=-1"),
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/profile_folders/{profileFolderId}?name=&workspaceId=-1

Дополнительно:
User-Agent: {-Profile.UserAgent-}
Api-Token: Токен из UserArea2.

Ответ API:

Response codeResult
200 OKУспех
500 ErrorВнутренняя ошибка сервера

Успешный ответ (200 OK):

При успешном обновлении содержимое не возвращается.

Ответ с ошибкой (500):

{
"message": null
}