WickrAdminAPI / Client / update_bot

update_bot

WickrAdminAPI.Client.update_bot(**kwargs)

Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot’s display name, security group, password, or suspension status.

See also: AWS API Documentation

Request Syntax

response = client.update_bot(
    networkId='string',
    botId='string',
    displayName='string',
    groupId='string',
    challenge='string',
    suspend=True|False
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network containing the bot to update.

  • botId (string) –

    [REQUIRED]

    The unique identifier of the bot to update.

  • displayName (string) – The new display name for the bot.

  • groupId (string) – The ID of the new security group to assign the bot to.

  • challenge (string) – The new password for the bot account.

  • suspend (boolean) – Set to true to suspend the bot or false to unsuspend it. Omit this field for standard updates that don’t affect suspension status.

Return type:

dict

Returns:

Response Syntax

{
    'message': 'string'
}

Response Structure

  • (dict) –

    • message (string) –

      A message indicating the result of the bot update operation.

Exceptions

  • WickrAdminAPI.Client.exceptions.ValidationError

  • WickrAdminAPI.Client.exceptions.BadRequestError

  • WickrAdminAPI.Client.exceptions.ResourceNotFoundError

  • WickrAdminAPI.Client.exceptions.ForbiddenError

  • WickrAdminAPI.Client.exceptions.UnauthorizedError

  • WickrAdminAPI.Client.exceptions.InternalServerError

  • WickrAdminAPI.Client.exceptions.RateLimitError