Update account

put

https://api.monetizeplatform.com/api/accounts/{accountId}

Update account by Id

Path Params

accountId

string

required

Body Params

customId

string

A user provided identifier for the account

defaultCurrency

string

enum

Represents the currency of the account. It is the ISO 4217 assigned three-digit code. If no currency is specified, the tenant's default currency will be set for the account.

isTestAccount

boolean

Boolean value indicating if the account is a test account

locale

string

Locale of the account. Example: en_US

accountName

string

required

Name of the account.

status

string

enum

required

Status of the account. An account can be ACTIVE, INACTIVE, CANCELED or SUSPENDED

Allowed:

accountType

string

enum

Type of the account. An account can be CUSTOMER, PARTNER

Allowed:

defaultLegalEntityId

string

Legal entity ID for this account. Default legal entity will be used as default when no legal entity is specified

customFields

object

taxEntityUseCode

string

length between 0 and 100

Tax entity use code for the account

taxExemptionNumber

string

length between 0 and 100

Tax exemption number for the account

defaultDunningProcessId

string

Optional dunning process id for the account

ccEmails

string

A list of account level email addresses to which the dunning mail will be copied

billingAddress

object

Address of the contact

shippingAddress

object

Address of the contact

Headers

x-api-key

string

required

x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client

Responses

500

Internal server error. Please contact the support team.

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update object by id