brevo-messaging - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /brevo-messaging | Type: Application | PCID required: Yes

Tools

Tool	Description
`brevo_messaging_create_conversations_agent_online_ping`	Sets agent’s status to online for 2-3 minutes
`brevo_messaging_create_conversations_messages`	Send a message as an agent
`brevo_messaging_create_conversations_pushed_messages`	Send an automated message to a visitor
`brevo_messaging_create_sms_campaign`	Creates an SMS campaign
`brevo_messaging_create_whats_app_campaign`	Create and Send a WhatsApp campaign
`brevo_messaging_create_whats_app_template`	Create a WhatsApp template
`brevo_messaging_delete_conversations_messages_by_id`	Delete a message sent by an agent
`brevo_messaging_delete_conversations_pushed_messages_by_id`	Delete an automated message
`brevo_messaging_delete_sms_campaign`	Delete an SMS campaign
`brevo_messaging_delete_whats_app_campaign`	Delete a WhatsApp campaign
`brevo_messaging_get_conversations_messages_by_id`	Get a message
`brevo_messaging_get_conversations_pushed_messages_by_id`	Get an automated message
`brevo_messaging_get_sms_campaign`	Get an SMS campaign
`brevo_messaging_get_sms_campaigns`	Returns the information for all your created SMS campaigns
`brevo_messaging_get_sms_events`	Get all your SMS activity (unaggregated events)
`brevo_messaging_get_transac_aggregated_sms_report`	Get your SMS activity aggregated over a period of time
`brevo_messaging_get_transac_sms_report`	Get your SMS activity aggregated per day
`brevo_messaging_get_whats_app_campaign`	Get a WhatsApp campaign
`brevo_messaging_get_whats_app_campaigns`	Return all your created WhatsApp campaigns
`brevo_messaging_get_whats_app_config`	Get your WhatsApp API account information
`brevo_messaging_get_whats_app_templates`	Return all your created WhatsApp templates
`brevo_messaging_get_whatsapp_event_report`	Get all your WhatsApp activity (unaggregated events)
`brevo_messaging_request_sms_recipient_export`	Export an SMS campaign’s recipients
`brevo_messaging_send_async_transactional_sms`	Send SMS message asynchronously to a mobile number
`brevo_messaging_send_sms_campaign_now`	Send your SMS campaign immediately
`brevo_messaging_send_sms_report`	Send an SMS campaign’s report
`brevo_messaging_send_test_sms`	Send a test SMS campaign
`brevo_messaging_send_transac_sms`	Send SMS message to a mobile number
`brevo_messaging_send_whats_app_template_approval`	Send your WhatsApp template for approval
`brevo_messaging_send_whatsapp_message`	Send a WhatsApp message
`brevo_messaging_update_conversations_messages_by_id`	Update a message sent by an agent
`brevo_messaging_update_conversations_pushed_messages_by_id`	Update an automated message
`brevo_messaging_update_conversations_visitor_group`	Set visitor group assignment
`brevo_messaging_update_sms_campaign`	Update an SMS campaign
`brevo_messaging_update_sms_campaign_status`	Update a campaign’s status
`brevo_messaging_update_whats_app_campaign`	Update a WhatsApp campaign

brevo_messaging_create_conversations_agent_online_ping

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

Parameter	Type	Required	Default	Description
`agentEmail`	string	No	—	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.
`agentId`	string	No	—	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).
`agentName`	string	No	—	Agent’s name.
`receivedFrom`	string	No	—	Mark your messages to distinguish messages created by you from the others.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "agentEmail": {
      "type": "string",
      "description": "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."
    },
    "agentId": {
      "type": "string",
      "description": "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)."
    },
    "agentName": {
      "type": "string",
      "description": "Agent's name."
    },
    "receivedFrom": {
      "type": "string",
      "description": "Mark your messages to distinguish messages created by you from the others."
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_create_conversations_messages

Send a message as an agent Parameters:

Parameter	Type	Required	Default	Description
`agentEmail`	string	No	—	Agent’s email address. When sending messages 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.
`agentId`	string	No	—	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).
`agentName`	string	No	—	Agent’s name.
`receivedFrom`	string	No	—	Mark your messages to distinguish messages created by you from the others.
`text`	string	Yes	—	Message text.
`visitorId`	string	Yes	—	Visitor’s ID received <a href=“https://developers.brevo.com/docs/conversations-webhooks”>from a webhook</a> or generated by you to <a href=“https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users”>bind an existing user account to Conversations</a>.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "agentEmail": {
      "type": "string",
      "description": "Agent's email address. When sending messages 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."
    },
    "agentId": {
      "type": "string",
      "description": "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)."
    },
    "agentName": {
      "type": "string",
      "description": "Agent's name."
    },
    "receivedFrom": {
      "type": "string",
      "description": "Mark your messages to distinguish messages created by you from the others."
    },
    "text": {
      "type": "string",
      "description": "Message text."
    },
    "visitorId": {
      "type": "string",
      "description": "Visitor's ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind an existing user account to Conversations</a>."
    }
  },
  "required": [
    "PCID",
    "text",
    "visitorId"
  ]
}

brevo_messaging_create_conversations_pushed_messages

Send an automated message to a visitor Parameters:

Parameter	Type	Required	Default	Description
`agentId`	string	No	—	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>.
`groupId`	string	No	—	Group ID. It can be found on the group’s page.
`text`	string	Yes	—	Message text.
`visitorId`	string	Yes	—	Visitor’s ID received <a href=“https://developers.brevo.com/docs/conversations-webhooks”>from a webhook</a> or generated by you to <a href=“https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users”>bind an existing user account to Conversations</a>.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "agentId": {
      "type": "string",
      "description": "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>."
    },
    "groupId": {
      "type": "string",
      "description": "Group ID. It can be found on the group's page."
    },
    "text": {
      "type": "string",
      "description": "Message text."
    },
    "visitorId": {
      "type": "string",
      "description": "Visitor's ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind an existing user account to Conversations</a>."
    }
  },
  "required": [
    "PCID",
    "text",
    "visitorId"
  ]
}

brevo_messaging_create_sms_campaign

Creates an SMS campaign Parameters:

Parameter	Type	Required	Default	Description
`content`	string	Yes	—	Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS.
`name`	string	Yes	—	Name of the campaign
`organisationPrefix`	string	No	—	A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.
`recipients`	object	No	—	The recipients value
`scheduledAt`	string	No	—	UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
`sender`	string	Yes	—	Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters
`unicodeEnabled`	boolean	No	—	Format of the message. It indicates whether the content should be treated as unicode or not.
`unsubscribeInstruction`	string	No	—	Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "content": {
      "type": "string",
      "description": "Content of the message. The **maximum characters used per SMS is 160**, if used more than that, it will be counted as more than one SMS."
    },
    "name": {
      "type": "string",
      "description": "Name of the campaign"
    },
    "organisationPrefix": {
      "type": "string",
      "description": "A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**"
    },
    "recipients": {
      "type": "object",
      "description": "The recipients value",
      "properties": {
        "exclusionListIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "List ids which have to be excluded from a campaign"
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Lists Ids to send the campaign to. **REQUIRED if scheduledAt is not empty**"
        }
      },
      "required": [
        "listIds"
      ]
    },
    "scheduledAt": {
      "type": "string",
      "description": "UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**"
    },
    "sender": {
      "type": "string",
      "description": "Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**"
    },
    "unicodeEnabled": {
      "type": "boolean",
      "description": "Format of the message. It indicates whether the content should be treated as unicode or not."
    },
    "unsubscribeInstruction": {
      "type": "string",
      "description": "Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**"
    }
  },
  "required": [
    "PCID",
    "content",
    "name",
    "sender"
  ]
}

brevo_messaging_create_whats_app_campaign

Create and Send a WhatsApp campaign Parameters:

Parameter	Type	Required	Default	Description
`name`	string	Yes	—	Name of the WhatsApp campaign creation
`recipients`	object	Yes	—	Segment ids and List ids to include/exclude from campaign
`scheduledAt`	string	Yes	—	Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.For example: 2017-06-01T12:30:00+02:00**
`templateId`	integer	Yes	—	Id of the WhatsApp template in approved state

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "Name of the WhatsApp campaign creation"
    },
    "recipients": {
      "type": "object",
      "description": "Segment ids and List ids to include/exclude from campaign",
      "properties": {
        "excludedListIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "List ids to exclude from the campaign"
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "**Mandatory if scheduledAt is not empty**. List Ids to send the campaign to"
        },
        "segments": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "**Mandatory if listIds are not used**. Segment ids to send the campaign to."
        }
      }
    },
    "scheduledAt": {
      "type": "string",
      "description": "Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00**"
    },
    "templateId": {
      "type": "integer",
      "description": "Id of the WhatsApp template in **approved** state"
    }
  },
  "required": [
    "PCID",
    "name",
    "recipients",
    "scheduledAt",
    "templateId"
  ]
}

brevo_messaging_create_whats_app_template

Create a WhatsApp template Parameters:

Parameter	Type	Required	Default	Description
`bodyText`	string	Yes	—	Body of the template. Maximum allowed characters are 1024
`category`	string	Yes	—	Category of the template
`headerText`	string	No	—	Text content of the header in the template. Maximum allowed characters are 45 Use this field to add text content in template header and if mediaUrl is empty
`language`	string	Yes	—	Language of the template. For Example : en for English
`mediaUrl`	string	No	—	Absolute url of the media file (no local file) for the header. Use this field in you want to add media in Template header and headerText is empty Allowed extensions for media files are: #### jpeg \| png \| mp4 \| pdf
`name`	string	Yes	—	Name of the template
`source`	string	No	—	source of the template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "bodyText": {
      "type": "string",
      "description": "Body of the template. **Maximum allowed characters are 1024**"
    },
    "category": {
      "type": "string",
      "description": "Category of the template",
      "enum": [
        "MARKETING",
        "UTILITY"
      ]
    },
    "headerText": {
      "type": "string",
      "description": "Text content of the header in the template.  **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty**"
    },
    "language": {
      "type": "string",
      "description": "Language of the template. For Example : **en** for English"
    },
    "mediaUrl": {
      "type": "string",
      "description": "Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf"
    },
    "name": {
      "type": "string",
      "description": "Name of the template"
    },
    "source": {
      "type": "string",
      "description": "source of the template",
      "enum": [
        "Automation",
        "Conversations"
      ]
    }
  },
  "required": [
    "PCID",
    "bodyText",
    "category",
    "language",
    "name"
  ]
}

brevo_messaging_delete_conversations_messages_by_id

Delete a message sent by an agent Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of the message

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of the message"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

brevo_messaging_delete_conversations_pushed_messages_by_id

Delete an automated message Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of the message

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of the message"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

brevo_messaging_delete_sms_campaign

Delete an SMS campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the SMS campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the SMS campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_delete_whats_app_campaign

Delete a WhatsApp campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_get_conversations_messages_by_id

Get a message Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of the message

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of the message"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

brevo_messaging_get_conversations_pushed_messages_by_id

Get an automated message Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of the message sent previously

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of the message sent previously"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

brevo_messaging_get_sms_campaign

Get an SMS campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the SMS campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the SMS campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_get_sms_campaigns

Returns the information for all your created SMS campaigns Parameters:

Parameter	Type	Required	Default	Description
`status`	string	No	—	Status of campaign.
`startDate`	string	No	—	Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. `startDate` must not be in the future.
`endDate`	string	No	—	Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. `endDate` must not be in the future.
`limit`	integer	No	—	Number of documents per page
`offset`	integer	No	—	Beginning point in the list to retrieve from.
`sort`	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "status": {
      "type": "string",
      "description": "Status of campaign.",
      "enum": [
        "suspended",
        "archive",
        "sent",
        "queued",
        "draft",
        "inProcess"
      ]
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `startDate` must not be in the future."
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `endDate` must not be in the future."
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents per page"
    },
    "offset": {
      "type": "integer",
      "description": "Beginning point in the list to retrieve from."
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_get_sms_events

Get all your SMS activity (unaggregated events) Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	Number of documents per page
`startDate`	string	No	—	Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
`endDate`	string	No	—	Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
`offset`	integer	No	—	Index of the first document of the page
`days`	integer	No	—	Number of days in the past including today (positive integer). Not compatible with ‘startDate’ and ‘endDate’
`phoneNumber`	string	No	—	Filter the report for a specific phone number
`event`	string	No	—	Filter the report for specific events
`tags`	string	No	—	Filter the report for specific tags passed as a serialized urlencoded array
`sort`	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents per page"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document of the page"
    },
    "days": {
      "type": "integer",
      "description": "Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'**"
    },
    "phoneNumber": {
      "type": "string",
      "description": "Filter the report for a specific phone number"
    },
    "event": {
      "type": "string",
      "description": "Filter the report for specific events",
      "enum": [
        "bounces",
        "hardBounces",
        "softBounces",
        "delivered",
        "sent",
        "accepted",
        "unsubscription",
        "replies",
        "blocked",
        "rejected",
        "skipped"
      ]
    },
    "tags": {
      "type": "string",
      "description": "Filter the report for specific tags passed as a serialized urlencoded array"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_get_transac_aggregated_sms_report

Get your SMS activity aggregated over a period of time Parameters:

Parameter	Type	Required	Default	Description
`startDate`	string	No	—	Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
`endDate`	string	No	—	Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
`days`	integer	No	—	Number of days in the past including today (positive integer). Not compatible with startDate and endDate
`tag`	string	No	—	Filter on a tag

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report"
    },
    "days": {
      "type": "integer",
      "description": "Number of days in the past including today (positive integer). **Not compatible with startDate and endDate**"
    },
    "tag": {
      "type": "string",
      "description": "Filter on a tag"
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_get_transac_sms_report

Get your SMS activity aggregated per day Parameters:

Parameter	Type	Required	Default	Description
`startDate`	string	No	—	Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
`endDate`	string	No	—	Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
`days`	integer	No	—	Number of days in the past including today (positive integer). Not compatible with ‘startDate’ and ‘endDate’
`tag`	string	No	—	Filter on a tag
`sort`	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report"
    },
    "days": {
      "type": "integer",
      "description": "Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'**"
    },
    "tag": {
      "type": "string",
      "description": "Filter on a tag"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_get_whats_app_campaign

Get a WhatsApp campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	Id of the campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_get_whats_app_campaigns

Return all your created WhatsApp campaigns Parameters:

Parameter	Type	Required	Default	Description
`startDate`	string	No	—	Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. Prefer to pass your timezone in date-time format for accurate result
`endDate`	string	No	—	Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. Prefer to pass your timezone in date-time format for accurate result
`limit`	integer	No	—	Number of documents per page
`offset`	integer	No	—	Index of the first document in the page
`sort`	string	No	—	Sort the results in the ascending/descending order of record modification. Default order is descending if `sort` is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. **Prefer to pass your timezone in date-time format for accurate result**"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. **Prefer to pass your timezone in date-time format for accurate result**"
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document in the page"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_get_whats_app_config

Get your WhatsApp API account information

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_get_whats_app_templates

Return all your created WhatsApp templates Parameters:

Parameter	Type	Required	Default	Description
`startDate`	string	No	—	Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result
`endDate`	string	No	—	Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result
`limit`	integer	No	—	Number of documents per page
`offset`	integer	No	—	Index of the first document in the page
`sort`	string	No	—	Sort the results in the ascending/descending order of record modification. Default order is descending if `sort` is not passed
`source`	string	No	—	source of the template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**"
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document in the page"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "source": {
      "type": "string",
      "description": "source of the template",
      "enum": [
        "Automation",
        "Conversations"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_get_whatsapp_event_report

Get all your WhatsApp activity (unaggregated events) Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	Number limitation for the result returned
`offset`	integer	No	—	Beginning point in the list to retrieve from
`startDate`	string	No	—	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
`endDate`	string	No	—	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
`days`	integer	No	—	Number of days in the past including today (positive integer). Not compatible with ‘startDate’ and ‘endDate’
`contactNumber`	string	No	—	Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
`event`	string	No	—	Filter the report for a specific event type
`sort`	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number limitation for the result returned"
    },
    "offset": {
      "type": "integer",
      "description": "Beginning point in the list to retrieve from"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate"
    },
    "days": {
      "type": "integer",
      "description": "Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_"
    },
    "contactNumber": {
      "type": "string",
      "description": "Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)"
    },
    "event": {
      "type": "string",
      "description": "Filter the report for a specific event type",
      "enum": [
        "sent",
        "delivered",
        "read",
        "error",
        "unsubscribe",
        "reply",
        "soft-bounce"
      ]
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_request_sms_recipient_export

Export an SMS campaign’s recipients Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the campaign
`notifyURL`	string	No	—	URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
`recipientsType`	string	No	—	Filter the recipients based on how they interacted with the campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the campaign"
    },
    "notifyURL": {
      "type": "string",
      "description": "URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479"
    },
    "recipientsType": {
      "type": "string",
      "description": "Filter the recipients based on how they interacted with the campaign",
      "enum": [
        "all",
        "delivered",
        "answered",
        "softBounces",
        "hardBounces",
        "unsubscribed"
      ]
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_send_async_transactional_sms

Send SMS message asynchronously to a mobile number Parameters:

Parameter	Type	Required	Default	Description
`organisationPrefix`	string	No	—	A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.
`params`	object	No	—	Pass the set of attributes to customize the template. For example, {“FNAME”:“Joe”, “LNAME”:“Doe”}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used.
`recipient`	string	Yes	—	Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with ’+’.
`sender`	string	Yes	—	Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters. Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits.
`tag`	string[]	No	—	Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.
`type`	string	No	—	Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
`unicodeEnabled`	boolean	No	—	Format of the message. It indicates whether the content should be treated as unicode or not.
`webUrl`	string	No	—	Webhook to call for each event triggered by the message (delivered etc.)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organisationPrefix": {
      "type": "string",
      "description": "A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**"
    },
    "params": {
      "type": "object",
      "description": "Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used."
    },
    "recipient": {
      "type": "string",
      "description": "Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'."
    },
    "sender": {
      "type": "string",
      "description": "Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters.** Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits."
    },
    "tag": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string."
    },
    "type": {
      "type": "string",
      "description": "Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.",
      "enum": [
        "transactional",
        "marketing"
      ]
    },
    "unicodeEnabled": {
      "type": "boolean",
      "description": "Format of the message. It indicates whether the content should be treated as unicode or not."
    },
    "webUrl": {
      "type": "string",
      "description": "Webhook to call for each event triggered by the message (delivered etc.)"
    }
  },
  "required": [
    "PCID",
    "recipient",
    "sender"
  ]
}

brevo_messaging_send_sms_campaign_now

Send your SMS campaign immediately Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_send_sms_report

Send an SMS campaign’s report Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the campaign
`email`	object	Yes	—	Custom attributes for the report email.
`language`	string	No	—	Language of email content for campaign report sending.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the campaign"
    },
    "email": {
      "type": "object",
      "description": "Custom attributes for the report email.",
      "properties": {
        "body": {
          "type": "string",
          "description": "Custom text message to be presented in the report email."
        },
        "to": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "email"
          },
          "description": "Email addresses of the recipients"
        }
      },
      "required": [
        "body",
        "to"
      ]
    },
    "language": {
      "type": "string",
      "description": "Language of email content for campaign report sending.",
      "enum": [
        "fr",
        "es",
        "pt",
        "it",
        "de",
        "en"
      ]
    }
  },
  "required": [
    "PCID",
    "campaignId",
    "email"
  ]
}

brevo_messaging_send_test_sms

Send a test SMS campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	Id of the SMS campaign
`phoneNumber`	string	No	—	Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the SMS campaign"
    },
    "phoneNumber": {
      "type": "string",
      "description": "Mobile number of the recipient with the country code. This number **must belong to one of your contacts in Brevo account and must not be blacklisted**"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_send_transac_sms

Send SMS message to a mobile number Parameters:

Parameter	Type	Required	Default	Description
`organisationPrefix`	string	No	—	A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.
`params`	object	No	—	Pass the set of attributes to customize the template. For example, {“FNAME”:“Joe”, “LNAME”:“Doe”}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used.
`recipient`	string	Yes	—	Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with ’+’.
`sender`	string	Yes	—	Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters. Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits.
`tag`	string[]	No	—	Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.
`type`	string	No	—	Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
`unicodeEnabled`	boolean	No	—	Format of the message. It indicates whether the content should be treated as unicode or not.
`webUrl`	string	No	—	Webhook to call for each event triggered by the message (delivered etc.)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organisationPrefix": {
      "type": "string",
      "description": "A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**"
    },
    "params": {
      "type": "object",
      "description": "Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used."
    },
    "recipient": {
      "type": "string",
      "description": "Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'."
    },
    "sender": {
      "type": "string",
      "description": "Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters.** Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits."
    },
    "tag": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string."
    },
    "type": {
      "type": "string",
      "description": "Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.",
      "enum": [
        "transactional",
        "marketing"
      ]
    },
    "unicodeEnabled": {
      "type": "boolean",
      "description": "Format of the message. It indicates whether the content should be treated as unicode or not."
    },
    "webUrl": {
      "type": "string",
      "description": "Webhook to call for each event triggered by the message (delivered etc.)"
    }
  },
  "required": [
    "PCID",
    "recipient",
    "sender"
  ]
}

brevo_messaging_send_whats_app_template_approval

Send your WhatsApp template for approval Parameters:

Parameter	Type	Required	Default	Description
`templateId`	integer	Yes	—	id of the template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "templateId": {
      "type": "integer",
      "description": "id of the template"
    }
  },
  "required": [
    "PCID",
    "templateId"
  ]
}

brevo_messaging_send_whatsapp_message

Send a WhatsApp message Parameters:

Parameter	Type	Required	Default	Description
`body`	object	Yes	—	Values to send WhatsApp message

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "description": "Values to send WhatsApp message"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

brevo_messaging_update_conversations_messages_by_id

Update a message sent by an agent Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of the message
`text`	string	No	—	The new message text.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of the message"
    },
    "text": {
      "type": "string",
      "description": "The new message text."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

brevo_messaging_update_conversations_pushed_messages_by_id

Update an automated message Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of the message
`text`	string	No	—	The new message text.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of the message"
    },
    "text": {
      "type": "string",
      "description": "The new message text."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

brevo_messaging_update_conversations_visitor_group

Set visitor group assignment Parameters:

Parameter	Type	Required	Default	Description
`groupId`	object	No	—	Group ID. It can be found on group’s page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "groupId": {
      "description": "Group ID. It can be found on group’s page."
    }
  },
  "required": [
    "PCID"
  ]
}

brevo_messaging_update_sms_campaign

Update an SMS campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the SMS campaign
`content`	string	No	—	Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS
`name`	string	No	—	Name of the campaign
`organisationPrefix`	string	No	—	A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.
`recipients`	object	No	—	The recipients value
`scheduledAt`	string	No	—	UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
`sender`	string	No	—	Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters
`unicodeEnabled`	boolean	No	—	Format of the message. It indicates whether the content should be treated as unicode or not.
`unsubscribeInstruction`	string	No	—	Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the SMS campaign"
    },
    "content": {
      "type": "string",
      "description": "Content of the message. The **maximum characters used per SMS is 160**, if used more than that, it will be counted as more than one SMS"
    },
    "name": {
      "type": "string",
      "description": "Name of the campaign"
    },
    "organisationPrefix": {
      "type": "string",
      "description": "A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**"
    },
    "recipients": {
      "type": "object",
      "description": "The recipients value",
      "properties": {
        "exclusionListIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "List ids which have to be excluded from a campaign"
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Lists Ids to send the campaign to. **REQUIRED if scheduledAt is not empty**"
        }
      },
      "required": [
        "listIds"
      ]
    },
    "scheduledAt": {
      "type": "string",
      "description": "UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**"
    },
    "sender": {
      "type": "string",
      "description": "Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**"
    },
    "unicodeEnabled": {
      "type": "boolean",
      "description": "Format of the message. It indicates whether the content should be treated as unicode or not."
    },
    "unsubscribeInstruction": {
      "type": "string",
      "description": "Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_update_sms_campaign_status

Update a campaign’s status Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the campaign
`status`	string	No	—	Note:- replicateTemplate status will be available only for template type campaigns.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the campaign"
    },
    "status": {
      "type": "string",
      "description": "Note:- **replicateTemplate** status will be available **only for template type campaigns.**",
      "enum": [
        "suspended",
        "archive",
        "darchive",
        "sent",
        "queued",
        "replicate",
        "replicateTemplate",
        "cancel",
        "draft"
      ]
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

brevo_messaging_update_whats_app_campaign

Update a WhatsApp campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	integer	Yes	—	id of the campaign
`campaignName`	string	No	—	Name of the campaign
`campaignStatus`	string	No	—	Status of the campaign
`recipients`	object	No	—	Segment ids and List ids to include/exclude from campaign
`rescheduleFor`	string	No	—	Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. Prefer to pass your timezone in date-time format for accurate result.For example: 2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the campaign"
    },
    "campaignName": {
      "type": "string",
      "description": "Name of the campaign"
    },
    "campaignStatus": {
      "type": "string",
      "description": "Status of the campaign",
      "enum": [
        "scheduled",
        "suspended"
      ]
    },
    "recipients": {
      "type": "object",
      "description": "Segment ids and List ids to include/exclude from campaign",
      "properties": {
        "excludedListIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "List ids to exclude from the campaign"
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "**Mandatory if scheduledAt is not empty**. List Ids to send the campaign to"
        },
        "segments": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "**Mandatory if listIds are not used**. Segment ids to send the campaign to."
        }
      }
    },
    "rescheduleFor": {
      "type": "string",
      "description": "Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign."
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

​Tools

​brevo_messaging_create_conversations_agent_online_ping

​brevo_messaging_create_conversations_messages

​brevo_messaging_create_conversations_pushed_messages

​brevo_messaging_create_sms_campaign

​brevo_messaging_create_whats_app_campaign

​brevo_messaging_create_whats_app_template

​brevo_messaging_delete_conversations_messages_by_id

​brevo_messaging_delete_conversations_pushed_messages_by_id

​brevo_messaging_delete_sms_campaign

​brevo_messaging_delete_whats_app_campaign

​brevo_messaging_get_conversations_messages_by_id

​brevo_messaging_get_conversations_pushed_messages_by_id

​brevo_messaging_get_sms_campaign

​brevo_messaging_get_sms_campaigns

​brevo_messaging_get_sms_events

​brevo_messaging_get_transac_aggregated_sms_report

​brevo_messaging_get_transac_sms_report

​brevo_messaging_get_whats_app_campaign

​brevo_messaging_get_whats_app_campaigns

​brevo_messaging_get_whats_app_config

​brevo_messaging_get_whats_app_templates

​brevo_messaging_get_whatsapp_event_report

​brevo_messaging_request_sms_recipient_export

​brevo_messaging_send_async_transactional_sms

​brevo_messaging_send_sms_campaign_now

​brevo_messaging_send_sms_report

​brevo_messaging_send_test_sms

​brevo_messaging_send_transac_sms

​brevo_messaging_send_whats_app_template_approval

​brevo_messaging_send_whatsapp_message

​brevo_messaging_update_conversations_messages_by_id

​brevo_messaging_update_conversations_pushed_messages_by_id

​brevo_messaging_update_conversations_visitor_group

​brevo_messaging_update_sms_campaign

​brevo_messaging_update_sms_campaign_status

​brevo_messaging_update_whats_app_campaign

Tools

brevo_messaging_create_conversations_agent_online_ping

brevo_messaging_create_conversations_messages

brevo_messaging_create_conversations_pushed_messages

brevo_messaging_create_sms_campaign

brevo_messaging_create_whats_app_campaign

brevo_messaging_create_whats_app_template

brevo_messaging_delete_conversations_messages_by_id

brevo_messaging_delete_conversations_pushed_messages_by_id

brevo_messaging_delete_sms_campaign

brevo_messaging_delete_whats_app_campaign

brevo_messaging_get_conversations_messages_by_id

brevo_messaging_get_conversations_pushed_messages_by_id

brevo_messaging_get_sms_campaign

brevo_messaging_get_sms_campaigns

brevo_messaging_get_sms_events

brevo_messaging_get_transac_aggregated_sms_report

brevo_messaging_get_transac_sms_report

brevo_messaging_get_whats_app_campaign

brevo_messaging_get_whats_app_campaigns

brevo_messaging_get_whats_app_config

brevo_messaging_get_whats_app_templates

brevo_messaging_get_whatsapp_event_report

brevo_messaging_request_sms_recipient_export

brevo_messaging_send_async_transactional_sms

brevo_messaging_send_sms_campaign_now

brevo_messaging_send_sms_report

brevo_messaging_send_test_sms

brevo_messaging_send_transac_sms

brevo_messaging_send_whats_app_template_approval

brevo_messaging_send_whatsapp_message

brevo_messaging_update_conversations_messages_by_id

brevo_messaging_update_conversations_pushed_messages_by_id

brevo_messaging_update_conversations_visitor_group

brevo_messaging_update_sms_campaign

brevo_messaging_update_sms_campaign_status

brevo_messaging_update_whats_app_campaign