This section provides to the Admin user retrieve, create and change meta data for users
Meta data meaning: an Admin can create different key:value pairs stored in internal DB. Every meta data key:value pair will be related to a specfifc user with user_id
key: has to be any string
value: has to be any of next types: ["string", "array", "JSON"].
The usersMeta routes available only for Admin user
{- "api_message": "<string>",
- "api_data": [
- {
- "last_at": "<dateitme string>",
- "total_items": 1,
- "users_metas": [
- {
- "id": "K1hQOGs4U3hJS0U9",
- "user_id": "Y0ZuTVFCNnl6S3hWQlJ3ZHJGNVk1QT09",
- "key": "EXTERNAL_DEPOSIT_WEBHOOKS",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
]
}
]
}Retrieve information about all stored users meta key:value pairs and allowed keys and values structure
Success
{- "api_message": "<string>",
- "api_data": {
- "EXTERNAL_DEPOSIT_WEBHOOKS": {
- "DATA_TYPE": "ARRAY",
- "ARRAY_TYPE": "string[]",
- "VALIDATION": "url"
}, - "SOME_USER_API_CREDS": {
- "DATA_TYPE": "STRING"
}, - "JSON_EXAMPLE": {
- "DATA_TYPE": "JSON",
- "DATA_STRUCTURE": {
- "key": "value"
}, - "PAYLOAD_EXAMPLE": {
- "example_key": "example_value"
}
}
}
}Create user meta key:value object related to the user by user_id
Success
{- "user_id": "Y0ZuTVFCNnl6S3hWQlJ3ZHJGNVk1QT09",
- "key": "EXTERNAL_DEPOSIT_WEBHOOKS",
}{- "api_message": "<string>",
- "api_data": {
- "id": "K1hQOGs4U3hJS0U9",
- "user_id": "Y0ZuTVFCNnl6S3hWQlJ3ZHJGNVk1QT09",
- "key": "EXTERNAL_DEPOSIT_WEBHOOKS",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}get specific user meta object by id
Success
{- "api_message": "<string>",
- "api_data": {
- "userMeta": {
- "id": "K1hQOGs4U3hJS0U9",
- "user_id": "Y0ZuTVFCNnl6S3hWQlJ3ZHJGNVk1QT09",
- "key": "EXTERNAL_DEPOSIT_WEBHOOKS",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}update specific user meta object by id
Success
{- "user_id": "Y0ZuTVFCNnl6S3hWQlJ3ZHJGNVk1QT09",
- "key": "EXTERNAL_DEPOSIT_WEBHOOKS",
}{- "api_message": "<string>",
- "api_data": {
- "userMeta": {
- "id": "K1hQOGs4U3hJS0U9",
- "user_id": "Y0ZuTVFCNnl6S3hWQlJ3ZHJGNVk1QT09",
- "key": "EXTERNAL_DEPOSIT_WEBHOOKS",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}get specific user meta object by user_id and object key
Success
{- "api_message": "<string>",
- "api_data": {
- "userMeta": {
- "id": "K1hQOGs4U3hJS0U9",
- "user_id": "Y0ZuTVFCNnl6S3hWQlJ3ZHJGNVk1QT09",
- "key": "EXTERNAL_DEPOSIT_WEBHOOKS",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}