How to set up user emails with the BoldChat API?

You can use the BoldChat API to update user emails without logging in to BoldChat.

Important: you must have the following account information to make a successful API call:

Your account ID (AID) that you can get by logging in to setup.boldchat.com.

In the example below, AID is 2648701413998819186

An API settings ID that you can create in the Setup > Account Setup > APIs > API Settings menu in the BoldChat Operator Client.

In the examples below, the API settings ID is 4156437641927623076

For your convenience, we have provided a sample API test page that you can use at https://developer.bold360.com/help/EN/Bold360API/Bold360API/jsonpapi.html

To change user email addresses, do the following:

  1. Retrieve LoginIDs with the getOperators API call as described in https://developer.bold360.com/help/EN/Bold360API/Bold360API/c_data_extraction_list_data_getOperators.html

    The following is an example API call:

    https://api.boldchat.com/aid/2648701413998819186/data/rest/json/v1/getOperators?auth=2648701413998819186:4156437641927623076:1569829495.....4c76

    Sample response:

    {	
        "Status": "success",	
        "Truncated": false,	
        "Data": [	
            {	
                "LoginID": "2624038010865729044",	
                "UserName": "jsmith",	
                "ChatName": null,	
                "Name": "John Smith",	
                "Email": "jsmith@company.com",	
                "EmailName": null,	
                "SSONameID": null,	
                "Disabled": null,	
                "PermissionGroupID": "2624011959449693646",	
                "Departments": [	
                    {	
                        "AssignmentPriority": 4,	
                        "Priority": null,	
                        "DepartmentID": "2624050121264430460"	
                    }	
                ],	
                "SmsService": {	
                    "Capacity": 0,	
                    "Available": false	
                },	
                "EmailService": {	
                    "Capacity": 0,	
                    "Available": false	
                },	
                "TicketService": {	
                    "Capacity": 0,	
                    "Available": false	
                },	
                "ChatService": {	
                    "Capacity": 0,	
                    "Available": false	
                },	
                "TwitterService": {	
                    "Capacity": 0,	
                    "Available": false	
                }	
            },	
        ]	
    }
  2. Update the email address with the editOperator API call of a user as described in https://developer.bold360.com/help/EN/Bold360API/Bold360API/c_provisioning_operator_editOperator.html

    The following is an example API call:

    https://api.boldchat.com/aid/2648701413998819186/data/rest/json/v1/editOperator?auth=2648701413998819186:4156437641927623076:1569831474018.....0459404&OperatorID=2624038010865729044&Email=john2.smith@company.com

    Sample response:

    {	
        "Status": "success"	
    }
  3. Repeat updating the email address of all users necessary.