Sets agent’s status to online for 2-3 minutes

POST

https://api.brevo.com/v3/conversations/agentOnlinePing

Sets the agent’s status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either agentId alone, or all three of agentEmail + agentName + receivedFrom.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

This endpoint expects an object.

agentEmailstringOptionalformat: "email"

Agent’s email address. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically.

Agent's email address. When sending online pings from a standalone system, it's hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there's no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically.

agentIdstringOptional

Agent ID. It can be found on the agent’s page or received from a webhook. Alternatively, you can use agentEmail + agentName + receivedFrom instead (all 3 fields required).

Agent ID. It can be found on the agent's page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).

agentNamestringOptional

Agent's name.

receivedFromstringOptional

Mark your messages to distinguish messages created by you from the others.

Response

Status of the agent was set successfully. Response body will be empty.

Errors

400

Bad Request Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.conversations.setsAgentsStatusToOnlineFor23Minutes({
8	agentId: "d9nKoegKSjmCtyK78",
9	});
10	}
11	main();