Account and profile
Authorizations
Path parameters
tenantstring · min: 3 · max: 16RequiredPattern:
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$
Query parameters
expandstringOptionalExample:
List of additional attributes to be retrieved, separated by commas.
Possible value to be passed in this parameter is addresses
.
addresses
Responses
200
OK
application/json
400
Request was syntactically incorrect. Details will be provided in the response payload.
application/json
401
Unauthorized
application/json
403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
application/json
get
GET /customer/{tenant}/me HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"title": "MR",
"firstName": "John",
"lastName": "Doe",
"contactPhone": "123456789",
"company": "Emporix",
"preferredLanguage": "en_US",
"preferredCurrency": "USD",
"preferredSite": "default",
"metadata": {
"mixins": {},
"version": 2
},
"mixins": {},
"customerNumber": "13869000",
"id": "13869000",
"accounts": [
{
"id": "[email protected]"
}
],
"contactEmail": "[email protected]",
"businessModel": "B2B",
"b2b": {
"companyRegistrationId": "123-456-789",
"legalEntities": [
{
"id": "D165356",
"name": "BMW",
"contactAssignmentId": "D436432"
}
]
}
}
Authorizations
Path parameters
tenantstring · min: 3 · max: 16RequiredPattern:
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$
Query parameters
tokenstringOptional
Token received by the customer through email.
Responses
202
Customer profile deletion confirmation was successfully accepted
204
Customer profile deletion request was successful
400
Request was syntactically incorrect. Details will be provided in the response payload.
application/json
401
Unauthorized
application/json
403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
application/json
delete
DELETE /customer/{tenant}/me HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Authorizations
Path parameters
tenantstring · min: 3 · max: 16RequiredPattern:
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$
Body
all ofOptional
Responses
200
OK
400
Request was syntactically incorrect. Details will be provided in the response payload.
application/json
401
Unauthorized
application/json
403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
application/json
patch
PATCH /customer/{tenant}/me HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 283
{
"title": "MR",
"firstName": "John",
"lastName": "Doe",
"contactEmail": "[email protected]",
"contactPhone": "123456789",
"company": "Emporix",
"preferredLanguage": "en_US",
"preferredCurrency": "EUR",
"preferredSite": "main",
"b2b": {
"companyRegistrationId": "123-456-789"
},
"metadata": {
"version": 1
}
}
No content
Authorizations
Path parameters
tenantstringRequired
Body
emailstringRequired
Customer's email address.
passwordstringRequired
Customer's account password.
Responses
201
Created
application/json
400
Request was syntactically incorrect. Details will be provided in the response payload.
application/json
401
Unauthorized
application/json
403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
application/json
409Error
application/json
post
POST /customer/{tenant}/me/accounts/internal HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"email": "[email protected]",
"password": "password123"
}
{
"id": "13869000"
}
Was this helpful?