Skip to main content
POST
/realms/{realmId}/organizations/{organizationId}/customer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

realmId
string
required
organizationId
string
required

Body

application/json
name
string
required
Required string length: 1 - 100
email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phoneNumber
string
required
Pattern: ^\+55[0-9]{10,11}$
document
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9]+$
address
object
required
trandingName
string
customFields
object

Response

201 - application/json

Successful response

id
string
required
hash
string
required
address
object
name
string
document
string
documentType
string
trandingName
string
email
string
phoneNumber
string
customFields
object

The { [slug]: value } wire/storage map (custom-fields map-shape migration, issue #5167 Phase 4) — replaces the retired def-stamped array element ({id, label, values, identifier, externalIdentifier, type, version}). Stored verbatim; no validation at this layer (step 4).