Conversations

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.

post/conversations/agentOnlinePing

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/conversations/agentOnlinePing
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Request body

agentIdstring

agent ID. It can be found on 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).

receivedFromstring

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

agentEmailstring email

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.

agentNamestring

agent name.

Example request

{
  "agentId": "d9nKoegKSjmCtyK78",
  "receivedFrom": "SuperAwesomeHelpdesk",
  "agentEmail": "liz@getwear.com",
  "agentName": "Liz"
}

Response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.