:doc:`WickrAdminAPI <../../wickr>` / Client / create_bot

**********
create_bot
**********



.. py:method:: WickrAdminAPI.Client.create_bot(**kwargs)

  

  Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wickr-2024-02-01/CreateBot>`_  


  **Request Syntax**
  ::

    response = client.create_bot(
        networkId='string',
        username='string',
        displayName='string',
        groupId='string',
        challenge='string'
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network where the bot will be created.

    

  
  :type username: string
  :param username: **[REQUIRED]** 

    The username for the bot. This must be unique within the network and follow the network's naming conventions.

    

  
  :type displayName: string
  :param displayName: 

    The display name for the bot that will be visible to users in the network.

    

  
  :type groupId: string
  :param groupId: **[REQUIRED]** 

    The ID of the security group to which the bot will be assigned.

    

  
  :type challenge: string
  :param challenge: **[REQUIRED]** 

    The password for the bot account.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'message': 'string',
          'botId': 'string',
          'networkId': 'string',
          'username': 'string',
          'displayName': 'string',
          'groupId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **message** *(string) --* 

        A message indicating the result of the bot creation operation.

        
      

      - **botId** *(string) --* 

        The unique identifier assigned to the newly created bot.

        
      

      - **networkId** *(string) --* 

        The ID of the network where the bot was created.

        
      

      - **username** *(string) --* 

        The username of the newly created bot.

        
      

      - **displayName** *(string) --* 

        The display name of the newly created bot.

        
      

      - **groupId** *(string) --* 

        The ID of the security group to which the bot was assigned.

        
  
  **Exceptions**
  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ValidationError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.BadRequestError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ResourceNotFoundError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ForbiddenError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.UnauthorizedError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.InternalServerError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.RateLimitError`

  