All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| ConversationsAgentOnlinePingPost | Post /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes |
| ConversationsMessagesIdDelete | Delete /conversations/messages/{id} | Delete a message sent by an agent |
| ConversationsMessagesIdGet | Get /conversations/messages/{id} | Get a message |
| ConversationsMessagesIdPut | Put /conversations/messages/{id} | Update a message sent by an agent |
| ConversationsMessagesPost | Post /conversations/messages | Send a message as an agent |
| ConversationsPushedMessagesIdDelete | Delete /conversations/pushedMessages/{id} | Delete an automated message |
| ConversationsPushedMessagesIdGet | Get /conversations/pushedMessages/{id} | Get an automated message |
| ConversationsPushedMessagesIdPut | Put /conversations/pushedMessages/{id} | Update an automated message |
| ConversationsPushedMessagesPost | Post /conversations/pushedMessages | Send an automated message to a visitor |
ConversationsAgentOnlinePingPost(ctx, body) 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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Body12 | Agent fields. |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsMessagesIdDelete(ctx, id) Delete a message sent by an agent
Only agents’ messages can be deleted.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of the message |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsMessage ConversationsMessagesIdGet(ctx, id) Get a message
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of the message |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsMessage ConversationsMessagesIdPut(ctx, id, optional) Update a message sent by an agent
Only agents’ messages can be edited.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of the message | |
| optional | *ConversationsMessagesIdPutOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ConversationsMessagesIdPutOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of Body9| |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsMessage ConversationsMessagesPost(ctx, body) Send a message as an agent
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Body8 | Message fields. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsPushedMessagesIdDelete(ctx, id) Delete an automated message
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of the message |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsMessage ConversationsPushedMessagesIdGet(ctx, id) Get an automated message
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of the message sent previously |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsMessage ConversationsPushedMessagesIdPut(ctx, id, body) Update an automated message
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID of the message | |
| body | Body11 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConversationsMessage ConversationsPushedMessagesPost(ctx, body) Send an automated message to a visitor
Example of automated messages: order status, announce new features in your web app, etc.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Body10 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]