Update Key API

The Update Key API enables status updates for keys within an organization, such as suspending or reactivating a key. These actions help manage user access based on organizational needs and security policies.

Only active organizations are authorized to perform update actions. Inactive organizations are restricted from executing any update requests.

Endpoint Details:

• URL: https://signals.smarte.pro/signals/v1/key/update
• Method: POST

Input Parameters

Required Headers:

Header	Value Type	Required	Description
Api-key	string	Yes	Admin API key
Content-Type	string	Yes	Must be application/json

Request Body Parameters:

Parameter	Type	Required	Description
email	string	Yes	Email ID associated with the key to be updated
action	string	Yes	Action to perform: suspend / activate

Valid Actions:

• suspend → Temporarily restricts access to a key

• active → Reactivates a previously suspended key

Action: Suspend

This action allows an active admin within the organization to suspend a key, temporarily restricting the access. This status can later be reversed by reactivating the key.

Sample Request:

curl --location 'https://signals.smarte.pro/signals/v1/key/update' \
--header 'Content-Type: application/json' \
--header 'Api-Key: WG+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxOwZcyVwvAibM=' \
--data-raw '{
    "email":"dev.udi_user@smarte.pro",
    "action": "suspend"
}'

Success Response

{
    "message": "Action performed successfully",
    "data": {
        "keyId": "222c424f-6e56-4ab1-94eb-8a0e41490831",
        "email": "dev.udi_user@smarte.pro",
        "role": "standard",
        "status": "suspended",
        "apiKey": "Id9hxxxxxxxxxxxxxxxxxxxxxxxxx9u/CeGp1mxXoTA3vs="
    }
}

Action: Active

This action allows an admin to reactivate a suspended key. Only keys with a status of "suspended" are eligible for reactivation.

Sample Request:

curl --location 'https://signals.smarte.pro/signals/v1/key/update' \
--header 'Content-Type: application/json' \
--header 'Api-Key: WG+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxOwZcyVwvAibM=' \
--data-raw '{
    "email":"dev.udi_user@smarte.pro",
    "action": "activate"
}'

Success Response

{
    "message": "Action performed successfully",
    "data": {
        "keyId": "222c424f-6e56-4ab1-94eb-8a0e41490831",
        "email": "dev.udi_user@smarte.pro",
        "role": "standard",
        "status": "active",
        "apiKey": "Id9h4v9sNYxxxxxxxxxm4i2gHC9u/CeGp1mxXoTA3vs="
    }
}