Sets 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.

Authentication

api-keystring

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

Request

This endpoint expects an object.

agentEmailanyOptional

agent email. 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.

agentIdanyOptional

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

agentNameanyOptional

agent name

receivedFromanyOptional

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.

1	import requests
2
3	url = "https://api.brevo.com/v3/conversations/agentOnlinePing"
4
5	payload = {
6	"agentEmail": None,
7	"agentName": None,
8	"receivedFrom": None
9	}
10	headers = {
11	"api-key": "<apiKey>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

Authentication

Request

Response

Errors