Authorizations
Include your Brew API key as a Bearer token in the Authorization header. Example: Authorization: Bearer bw_api_your_key_here
Body
Provide the contact's email and any additional contact data.
Custom Properties: Add any custom contact properties as top-level fields in your request. Custom properties can be strings, numbers, booleans, or dates. For detailed information about creating and managing custom properties, see our Custom Properties guide in the Audience section.
Data Types:
string— Text values (e.g., "Enterprise", "Product Manager")number— Numeric values (e.g., 50, 99.99, -10)boolean— True/false values (true, false)date— Unix timestamps in seconds (e.g., 1704067200 for 2024-01-01)
Resetting Properties: Send null as the value to clear or reset any contact property.
Reserved Names: Field names like email, firstName, lastName, userId, source, subscribed, and subscriptionGroups are reserved and cannot be used for custom properties.
Request body for creating a new contact (will fail if contact already exists)
Contact's email address (must be valid email format)
"jane.smith@example.com"
Contact's first name
"Jane"
Contact's last name
"Smith"
Unique external user ID (e.g., from your app or CRM)
"user_12345"
Custom source value to track where the contact came from (defaults to "API")
"Website signup"
Whether the contact is subscribed to marketing emails
Object mapping subscription group IDs to boolean subscription status
{
"sg_newsletter": true,
"sg_product_updates": false
}