Contents x
    Adds a new Team Account
    • 26 Sep 2023
    • 16 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Adds a new Team Account

    • Updated on 26 Sep 2023
    • 16 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    Post
    /v2/Teams
    Security
    API Key
    Header parameter nameapi_token
    Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
    Body parameters
    Team Account - Add a new team account with content permission level None.

    Here you can add new team account with content permission and access level as None.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 0,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Category.

    Here you can add new team account with content permission and access level to Category.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "4f44c7e-fcbe-4797-b144-1a7ca2508444",
            "category_id": "8345c7e-fcbe-4797-b144-1a7ca25034",
            "language_code": "en"
          }
        ],
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Language.

    Here you can add new team account with content permission and access level to Language.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 4,
        "categories": null,
        "project_versions": null,
        "languages": [
          {
            "project_version_id": "232c7e-fcbe-4797-b144-1a7ca250345",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Project.

    Here you can add new team account with content permission and access level to Project.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 3,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Version.

    Here you can add new team account with content permission and access level to Version.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 2,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Expand All
    object

    Request to add a new team account user

    email_id
    string (email) Required

    The email address of the team account

    Min length1
    first_name
    string

    First name of the team account

    last_name
    string

    Last name of the team account

    invited_by
    string Required

    The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

    Min length1
    is_sso_user
    boolean

    Set this to true, if you are adding an SSO user

    skip_sso_invitation_email
    boolean

    Set this to true, if you would like to avoid sending an invitation email to the newly added team account.

    This property is applicable only when adding a SSO user.

    associated_portal_role_id
    string Required

    The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

    Min length1
    content_permissions
    Array of object (ContentPermissionCustomer) Required

    The content level permissions for the newly added team account

    object

    The content permission of the team account

    associated_content_role_id
    string Required

    The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

    Min length1
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    The access scope of the user

    access_level
    integer (int32) Required

    This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

    Valid values[0,1,2,3,4,5,6]
    categories
    Array of object (CategoryScopeCustomer)

    A list of category scope objects.

    This is only required if the access level is set 1 - Category

    object
    project_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    project_versions
    Array of string

    A list of project versions

    This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer)

    A list of language scope objects

    This is only required if the access level is set to 4 - Language

    object
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    associated_groups
    Array of string

    A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

    string
    Team Account - Add a new team account with content permission level None.

    Here you can add new team account with content permission and access level as None.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 0,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Category.

    Here you can add new team account with content permission and access level to Category.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "4f44c7e-fcbe-4797-b144-1a7ca2508444",
            "category_id": "8345c7e-fcbe-4797-b144-1a7ca25034",
            "language_code": "en"
          }
        ],
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Language.

    Here you can add new team account with content permission and access level to Language.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 4,
        "categories": null,
        "project_versions": null,
        "languages": [
          {
            "project_version_id": "232c7e-fcbe-4797-b144-1a7ca250345",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Project.

    Here you can add new team account with content permission and access level to Project.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 3,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Version.

    Here you can add new team account with content permission and access level to Version.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 2,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Expand All
    object

    Request to add a new team account user

    email_id
    string (email) Required

    The email address of the team account

    Min length1
    first_name
    string

    First name of the team account

    last_name
    string

    Last name of the team account

    invited_by
    string Required

    The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

    Min length1
    is_sso_user
    boolean

    Set this to true, if you are adding an SSO user

    skip_sso_invitation_email
    boolean

    Set this to true, if you would like to avoid sending an invitation email to the newly added team account.

    This property is applicable only when adding a SSO user.

    associated_portal_role_id
    string Required

    The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

    Min length1
    content_permissions
    Array of object (ContentPermissionCustomer) Required

    The content level permissions for the newly added team account

    object

    The content permission of the team account

    associated_content_role_id
    string Required

    The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

    Min length1
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    The access scope of the user

    access_level
    integer (int32) Required

    This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

    Valid values[0,1,2,3,4,5,6]
    categories
    Array of object (CategoryScopeCustomer)

    A list of category scope objects.

    This is only required if the access level is set 1 - Category

    object
    project_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    project_versions
    Array of string

    A list of project versions

    This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer)

    A list of language scope objects

    This is only required if the access level is set to 4 - Language

    object
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    associated_groups
    Array of string

    A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

    string
    Team Account - Add a new team account with content permission level None.

    Here you can add new team account with content permission and access level as None.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 0,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Category.

    Here you can add new team account with content permission and access level to Category.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "4f44c7e-fcbe-4797-b144-1a7ca2508444",
            "category_id": "8345c7e-fcbe-4797-b144-1a7ca25034",
            "language_code": "en"
          }
        ],
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Language.

    Here you can add new team account with content permission and access level to Language.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 4,
        "categories": null,
        "project_versions": null,
        "languages": [
          {
            "project_version_id": "232c7e-fcbe-4797-b144-1a7ca250345",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Project.

    Here you can add new team account with content permission and access level to Project.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 3,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Version.

    Here you can add new team account with content permission and access level to Version.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 2,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Expand All
    object

    Request to add a new team account user

    email_id
    string (email) Required

    The email address of the team account

    Min length1
    first_name
    string

    First name of the team account

    last_name
    string

    Last name of the team account

    invited_by
    string Required

    The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

    Min length1
    is_sso_user
    boolean

    Set this to true, if you are adding an SSO user

    skip_sso_invitation_email
    boolean

    Set this to true, if you would like to avoid sending an invitation email to the newly added team account.

    This property is applicable only when adding a SSO user.

    associated_portal_role_id
    string Required

    The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

    Min length1
    content_permissions
    Array of object (ContentPermissionCustomer) Required

    The content level permissions for the newly added team account

    object

    The content permission of the team account

    associated_content_role_id
    string Required

    The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

    Min length1
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    The access scope of the user

    access_level
    integer (int32) Required

    This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

    Valid values[0,1,2,3,4,5,6]
    categories
    Array of object (CategoryScopeCustomer)

    A list of category scope objects.

    This is only required if the access level is set 1 - Category

    object
    project_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    project_versions
    Array of string

    A list of project versions

    This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer)

    A list of language scope objects

    This is only required if the access level is set to 4 - Language

    object
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    associated_groups
    Array of string

    A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

    string
    Team Account - Add a new team account with content permission level None.

    Here you can add new team account with content permission and access level as None.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 0,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Category.

    Here you can add new team account with content permission and access level to Category.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "4f44c7e-fcbe-4797-b144-1a7ca2508444",
            "category_id": "8345c7e-fcbe-4797-b144-1a7ca25034",
            "language_code": "en"
          }
        ],
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Language.

    Here you can add new team account with content permission and access level to Language.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 4,
        "categories": null,
        "project_versions": null,
        "languages": [
          {
            "project_version_id": "232c7e-fcbe-4797-b144-1a7ca250345",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Project.

    Here you can add new team account with content permission and access level to Project.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 3,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Team Account - Add a new team account with content permission level as Version.

    Here you can add new team account with content permission and access level to Version.

    {
  "email_id": "peterjone@mail.com",
  "first_name": "Peter",
  "last_name": "Jone",
  "invited_by": "844fb5c7e-fcbe-4797-b144-1a7ca2508f43",
  "is_sso_user": true,
  "skip_sso_invitation_email": true,
  "associated_portal_role_id": "8db42c7e-fcbe-4797-b144-1a7ca2508453",
  "content_permissions": [
    {
      "associated_content_role_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "access_scope": {
        "access_level": 2,
        "categories": null,
        "project_versions": null,
        "languages": null
      }
    }
  ],
  "associated_groups": null
}
    Expand All
    object

    Request to add a new team account user

    email_id
    string (email) Required

    The email address of the team account

    Min length1
    first_name
    string

    First name of the team account

    last_name
    string

    Last name of the team account

    invited_by
    string Required

    The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

    Min length1
    is_sso_user
    boolean

    Set this to true, if you are adding an SSO user

    skip_sso_invitation_email
    boolean

    Set this to true, if you would like to avoid sending an invitation email to the newly added team account.

    This property is applicable only when adding a SSO user.

    associated_portal_role_id
    string Required

    The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

    Min length1
    content_permissions
    Array of object (ContentPermissionCustomer) Required

    The content level permissions for the newly added team account

    object

    The content permission of the team account

    associated_content_role_id
    string Required

    The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

    Min length1
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    The access scope of the user

    access_level
    integer (int32) Required

    This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

    Valid values[0,1,2,3,4,5,6]
    categories
    Array of object (CategoryScopeCustomer)

    A list of category scope objects.

    This is only required if the access level is set 1 - Category

    object
    project_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    project_versions
    Array of string

    A list of project versions

    This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer)

    A list of language scope objects

    This is only required if the access level is set to 4 - Language

    object
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    associated_groups
    Array of string

    A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

    string
    Responses
    200

    Success

    Successfully added new team account

    New team account created

    {
  "result": {
    "id": "40d55ebb-d2ab-4327-99d0-0e166f8ce6c2"
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    result
    object (AddUserData)
    id
    string

    Newly added user Id

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    400

    Bad Request

    Existing team member

    The user is an exixsting team member. Kindly change your mail Id to add a new to your team account.

    {
  "result": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "User aleady associated with the project as a reader or team member.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Invited By field is missing.

    Kindly add the invitedBy field in the body of the content. You can find the invitedBy Id in the /V2/team/email-exists.

    {
  "result": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The InvitedBy field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Expand All
    object
    result
    object (AddUserData)
    id
    string

    Newly added user Id

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    Was this article helpful?
    What's Next