Albato
  • Language
    En
    English
    Portuguese
    Spanish
  • Welcome to Albato Help

    Method for blocking a user


    IN THIS ARTICLE

    This method lets you block an existing user's billing plan. When applied, all user integrations are paused and no new integrations can be started.

    Authorization: This method should be called with the partner's master account token.

    Request:

    POST https://api.albato.com/wl/partner-name/add-user

    Where partner-name is your company name (partner name) in Albato.

    Request parameters:

    • id — An alphanumeric user ID that the partner passes when creating a new user. In most cases, this is the user’s nickname, the part of the email address before @your-domain (for example, john.smith from john.smith@your-domain). Use the same value consistently and insert it into the id field.

    Response parameters:

    • success — Request success indicator. Available values: true or false

    Request example via curl:

    curl --header "Content-type: application/json" --header "Accept: application/json" --header "Authorization: Basic cEFJjGffUSkV6WFFyWUhBM1RzS2hRHg7iKgReghUiijBfrdTY6" --data '{"id":"test"}' "https://api.albato.com/wl/partner-name/block-user-plan"

    Response example:

    { "success": true, "data": [] }

    Did this answer your question?