Create Contact
Add a new contact to your Brew audience with custom properties, subscription group memberships, and other contact data. Perfect for syncing contacts from your app or CRM. If a contact with the same email already exists, this will return a 409 error. To modify existing contacts, use the Update Contact endpoint.
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 documentation.
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)
Response
Contact created successfully
Success response for contact operations