Create configuration link
About
Generates trading account configuration link by account id. This link can be used by the end user to enter trading account login and password. After this initial account configuration, another link can be requested to allow your end user to change the password.
PUT /users/current/accounts/:accountId/configuration-link
For more information see swagger documentation
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| auth-token | string | Yes | Authorization token. See Authentication and authorization |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | string | Yes | Trading account id |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ttlInDays | number | Lifetime of the link in days. Default is 7. |
Response
- 200 - Configuration link returned. Response schema:
| Name | Type | Required | Description |
|---|---|---|---|
| configurationLink | string | Yes | Trading account configuration link |
- 400 - Validation failed. Response schema: Error
- 404 - Trading account not found. Response schema: Error
Examples
Example request:
curl -X PUT --header 'Accept: application/json' --header 'auth-token: token' 'https://mt-provisioning-api-v1.agiliumtrade.agiliumtrade.ai/users/current/accounts/1eda642a-a9a3-457c-99af-3bc5e8d5c4c9/configuration-link?ttlInDays=3'
Example response:
{
"configurationLink": "https://app.metaapi.cloud/configure-trading-account-credentials/1eda642a-a9a3-457c-99af-3bc5e8d5c4c9/jxJvnDTBOBVm6ib3dpgvn1dliN3mSEIrLV5n1PCqmE1QReQkKFwYV4Eo2hfbWLg4"
}