Skip to main content

Update organization data

PUT 

https://app.tolgee.io/v2/organizations/:id

Update organization data

Request

Path Parameters

    id int64required

Bodyrequired

    descriptionstring
    Example: This is a beautiful organization full of beautiful and clever people
    namestringrequired

    Possible values: >= 3 characters and <= 50 characters

    Example: Beautiful organization
    slugstring

    Possible values: >= 3 characters and <= 60 characters, Value must match regular expression ^[a-z0-9-]*[a-z]+[a-z0-9-]*$

    Example: btforg

Responses

OK

Schema
    avatar object
    largestringrequired
    thumbnailstringrequired
    basePermissions objectrequired

    Current user's direct permission

    permittedLanguageIdsint64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    Example: [200001,200004]
    scopesstring[]required

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage, tasks.view, tasks.edit]

    Example: ["KEYS_EDIT","TRANSLATIONS_VIEW"]
    stateChangeLanguageIdsint64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    Example: [200001,200004]
    translateLanguageIdsint64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    Example: [200001,200004]
    typestring

    The user's permission type. This field is null if uses granular permissions

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    viewLanguageIdsint64[]

    List of languages user can view. If null, all languages view is permitted.

    Example: [200001,200004]
    currentUserRolestring

    The role of currently authorized user.

    Can be null when user has direct access to one of the projects owned by the organization.

    Possible values: [MEMBER, OWNER]

    descriptionstring
    Example: This is a beautiful organization full of beautiful and clever people
    idint64required
    namestringrequired
    Example: Beautiful organization
    slugstringrequired
    Example: btforg

Authorization: http

name: SuperJwtTokentype: httpdescription: Super JWT token is required for sensitive operations when user has set 2FA. You can obtain super JWT token via `/v2/user/generate-super-token` endpoint. But be careful! Super JWT Token has super powers!scheme: bearerbearerFormat: JWT
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://app.tolgee.io/v2/organizations/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n \"description\": \"This is a beautiful organization full of beautiful and clever people\",\n \"name\": \"Beautiful organization\",\n \"slug\": \"btforg\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://app.tolgee.io
Auth
Parameters
— pathrequired
Body required
{
  "description": "This is a beautiful organization full of beautiful and clever people",
  "name": "Beautiful organization",
  "slug": "btforg"
}
ResponseClear

Click the Send API Request button above and see the response here!