Brevo · Schema

UpdateContact

MarketingMarketing AutomationEmail MarketingTransactional EmailSMS MarketingWhatsAppCampaignsCRMSalesE-CommerceLoyaltyEventLive ChatEmailSMSAutomationMessagingContacts

Properties

Name	Type	Description
attributes	object	Custom attribute values to update as key-value pairs.
listIds	array	IDs of lists to set for the contact.
unlinkListIds	array	IDs of lists to remove the contact from.
emailBlacklisted	boolean	Whether to blacklist the contact's email.
smsBlacklisted	boolean	Whether to blacklist the contact's phone for SMS.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateContact",
  "title": "UpdateContact",
  "type": "object",
  "properties": {
    "attributes": {
      "type": "object",
      "description": "Custom attribute values to update as key-value pairs.",
      "additionalProperties": true
    },
    "listIds": {
      "type": "array",
      "description": "IDs of lists to set for the contact.",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    },
    "unlinkListIds": {
      "type": "array",
      "description": "IDs of lists to remove the contact from.",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    },
    "emailBlacklisted": {
      "type": "boolean",
      "description": "Whether to blacklist the contact's email."
    },
    "smsBlacklisted": {
      "type": "boolean",
      "description": "Whether to blacklist the contact's phone for SMS."
    }
  }
}