Create or update a domain object mapping
PUT/v1/admin/mapping/:type/:arkId
Required role: ADMIN
Creates or updates a domain object instance in the platform and
establishes its mapping to the corresponding external system identifier
via the configured connector. Idempotent — re-submitting the same
arkId updates the existing mapping.
objectType-specific fields
objectType | Required fields | Optional fields |
|---|---|---|
CUSTOMER | customerNumber | dpid, verificationId |
ACCOUNT | accountNumber, bsb, productKey, productVersion | — |
CARD | cardType, accountId, customerNumber | — |
cardType values: PHYSICAL, VIRTUAL, PHYSICAL_AND_VIRTUAL
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 500
The requested domain object mapping was created successfully.
Schema validation failed (GEN000000)
Invalid API key (GEN001004) or Tenant context could not be resolved (AUT001001)
Access forbidden — bearer token supplied to an api-key route (GEN022000)
Domain object mapping not found (ADM100008) or No matching product (ADM004002)
Domain object mapping not found during update (ADM100008)
General internal server error (GEN100000) or Service error (GEN100001)