Braze User Data API
The User API allows you to track information on your users by logging data about your users that comes from outside your mobile app. You can also use this API to delete users for testing or other purposes.All API endpoints have a data payload limit of 4MB. Attempts to post more data than 4MB will fail with an HTTP 413 Request Entity Too Large.The examples below contain the URL https://rest.iad-01.braze.com, but some customers will need to use a different endpoint URL, for example if you are hosted in Brazes EU data center or have a dedicated Braze installation. Your Success Manager will inform you if you should use a different endpoint URL.
Braze User Data API is one of 24 APIs that Braze publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User Data. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 6 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 10 base URLs: https://rest.iad-01.braze.com, https://rest.iad-01.braze.com, https://rest.iad-02.braze.com, https://rest.iad-03.braze.com, https://rest.iad-04.braze.com, https://rest.iad-05.braze.com, https://rest.iad-06.braze.com, https://rest.iad-08.braze.com, https://rest.fra-01.braze.eu, https://rest.fra-02.braze.eu.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Braze User Data API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.
The User API allows you to track information on your users by logging data about your users that comes from outside your mobile app. You can also use this API to delete users for…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Braze 12
Other APIs Braze publishes across the network.
This is an independent, third-party profile of Braze User Data API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.