API Documentation

Update Agent Settings

Configure your agent's appearance, behaviour, and lead collection settings.

Endpoint

PUT https://www.chatzuri.com/api/v1/update-agent-settings

Settings Fields

Field	Type	Description
welcomeMessage	string	The first message shown to visitors
primaryColor	string	Hex color for the chat widget (e.g. #10b981)
chatIcon	string	URL of the chat widget icon image
collectLeads	boolean	Whether to collect visitor contact info
leadFields	string[]	Fields to collect: name, email, phone

Example Request

const res = await fetch('https://www.chatzuri.com/api/v1/update-agent-settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <Your-Secret-Key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    agentId: '<Your-Agent-ID>',
    settings: {
      welcomeMessage: 'Hello! How can I help you today?',
      primaryColor: '#10b981',
      chatIcon: 'https://example.com/icon.png',
      collectLeads: true,
      leadFields: ['name', 'email', 'phone']
    }
  })
});

const data = await res.json();
console.log(data); // { success: true }

Response

{
  "success": true
}

Error Handling

How to handle API errors gracefully

If there are any errors during the API request, appropriate HTTP status codes will be returned along with error messages in the response body.

That's it! You should now be able to create a agent using the create API.

Remember to implement proper error logging and user notifications in your application

400

Bad Request

401

Unauthorized

500

Server Error

Next: Get Leads