Create Association
POST/client/users/:correlation_id/associations
This request is used to create account association.
- associationType and associationValue are mandatory parameters.
- Association Type should be a valid one as per the configuration.
- Association Value can be 3-128 alphanumeric characters with space, hyphen and underscore.
- As per configuration (Exclusive = true), child accounts can currently be associated with only one parent account.
Request
Body
| Attribute | Definition | Format | Notes |
|---|---|---|---|
| associationType | Provides type of association | String | Mandatory attribute. |
| associationValue | Provides value for association | String | Mandatory attribute. |
Response
| Attribute | Definition | Format | Notes |
|---|---|---|---|
| accountID | The accountId for which association was created for. | String | |
| associationKey | Concatenation of the Type and Value returned. | String | |
| associationType | Type of the association | String | |
| associationValue | Value of the association | String |
Error Responses
| statusCode | errorMessage | errorCode | Definition |
|---|---|---|---|
| 400 Bad Request | Account Association feature is not supported. | INVALID_REQUEST | A valid request to created association but the feature is disabled. |
| 400 Bad Request | SHIP_TO association type is not valid. | INVALID_REQUEST | A request with associationType that is not configured in system. |
| 400 Bad Request | Association already exists. | INVALID_REQUEST | A valid request to add more than one association which is invalid. |
Request
Responses
- 200
- 400
200 - Create Account Association
400 - Account Association Not Enabled