Skip to main content

Update an Account

PUT 
/v1/accounts/:accountId

Updates an Account within an Organization. All properties of the Account are updated.

Request​

Path Parameters

    accountId stringrequired

    The Account identifier to update.

Body

The request received from the client.

    accountId stringrequired

    The Account identifier to update.

    name stringrequired

    A name for the Account. Must be unique within the Organization.

    description string

    (Optional) A description for the Account.

    lowBalance

    object

    Account low balance settings

    hasNotification booleanrequired

    Whether a notification should be sent if the Account balance is low

    notificationEmail stringrequired

    The email address to which to send a notification.

    threshold

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

Responses​

OK

Schema

    account

    object

    required

    An account

    accountId stringrequired

    The identifier for the Account.

    name stringrequired

    The name of the Account.

    description string

    (Optional) The description of the Account.

    balance

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    lowBalance

    object

    Account low balance settings

    hasNotification booleanrequired

    Whether a notification should be sent if the Account balance is low

    notificationEmail stringrequired

    The email address to which to send a notification.

    threshold

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

Loading...