Put
/v2/Teams/{userId}/portal
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters
userId
stringRequired

The ID of the team account for which the portal role has to be updated

Body parameters
Show example
object
associated_portal_role_id
string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1
is_invitation_id
boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

object
associated_portal_role_id
string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1
is_invitation_id
boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

object
associated_portal_role_id
string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1
is_invitation_id
boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

object
associated_portal_role_id
string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1
is_invitation_id
boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

Responses
200
400
Show example

Success

Collapse all
object
result
boolean

Customer API response data

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
warnings
Array of object (BaseWarning)

Warnings in the customer API response

object
information
Array of object (BaseInformation)

Information passed by the customer API response

object