Brevo · Schema

CreateContact

MarketingMarketing AutomationEmail MarketingTransactional EmailSMS MarketingWhatsAppCampaignsCRMSalesE-CommerceLoyaltyEventLive ChatEmailSMSAutomationMessagingContacts

Properties

Name	Type	Description
email	string	Email address of the new contact.
attributes	object	Custom attribute values as key-value pairs.
listIds	array	IDs of lists to add the contact to.
updateEnabled	boolean	Whether to update the contact if a duplicate email exists.
smtpBlacklistSender	array	Sender email addresses to blacklist for this contact.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateContact",
  "title": "CreateContact",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the new contact."
    },
    "attributes": {
      "type": "object",
      "description": "Custom attribute values as key-value pairs.",
      "additionalProperties": true
    },
    "listIds": {
      "type": "array",
      "description": "IDs of lists to add the contact to.",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    },
    "updateEnabled": {
      "type": "boolean",
      "description": "Whether to update the contact if a duplicate email exists.",
      "default": false
    },
    "smtpBlacklistSender": {
      "type": "array",
      "description": "Sender email addresses to blacklist for this contact.",
      "items": {
        "type": "string",
        "format": "email"
      }
    }
  }
}