The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
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": false,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}Request to add a new team account user
The email address of the team account
First name of the team account
Last name of the team account
The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint
Set this to true, if you are adding an SSO user
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
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.
The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.
The content level permissions for the newly added team account
The content permission of the team account
The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.
The access level of the team account. With the access level, you will be able to set the permissions at a granular level. For example, you can limit the user to view articles only for a particular language/category/version.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.
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": false,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}Request to add a new team account user
The email address of the team account
First name of the team account
Last name of the team account
The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint
Set this to true, if you are adding an SSO user
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
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.
The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.
The content level permissions for the newly added team account
The content permission of the team account
The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.
The access level of the team account. With the access level, you will be able to set the permissions at a granular level. For example, you can limit the user to view articles only for a particular language/category/version.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.
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": false,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}Request to add a new team account user
The email address of the team account
First name of the team account
Last name of the team account
The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint
Set this to true, if you are adding an SSO user
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
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.
The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.
The content level permissions for the newly added team account
The content permission of the team account
The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.
The access level of the team account. With the access level, you will be able to set the permissions at a granular level. For example, you can limit the user to view articles only for a particular language/category/version.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.
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": false,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}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,
"scheme_name": null,
"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
}Request to add a new team account user
The email address of the team account
First name of the team account
Last name of the team account
The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint
Set this to true, if you are adding an SSO user
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
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.
The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.
The content level permissions for the newly added team account
The content permission of the team account
The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.
The access level of the team account. With the access level, you will be able to set the permissions at a granular level. For example, you can limit the user to view articles only for a particular language/category/version.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.
Success
New team account created
{
"result": {
"id": "40d55ebb-d2ab-4327-99d0-0e166f8ce6c2"
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Customer API response data
Newly added user Id
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
The user is an exixsting team member. Kindly change your mail Id to add a new to your team account.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "User already associated with the project as a reader or team member.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly add the invitedBy field in the body of the content. You can find the invitedBy Id in the /V2/team/email-exists.
{
"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": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.