Update an Account

PUT 
/v2/accounts/:accountID

Update the information contained on an account.

Request

Path Parameters

accountID stringrequired

The ID of the account you want to retrieve.

application/json

Body

data object

oneOf

Account

type stringrequired

Default value: account

Specifies the the type of object. Set this value to account.

name stringrequired

Specifies the name of the account.

legal_name stringrequired

Specifies the legal name of the account.

registration_id string

Specifies the registration ID. If specified, this field is checked for uniqueness.

external_ref string

The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

SubAccount

type stringrequired

Default value: account

Specifies the the type of object. Set this value to account.

name stringrequired

Specifies the name of the account.

legal_name stringrequired

Specifies the legal name of the account.

registration_id string

Specifies the registration ID. If specified, this field is checked for uniqueness.

external_ref string

The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

parent_id string

Specifies the ID of the parent account.

Responses

200

OK

application/json

Schema

Schema

data

id string

The unique identifier for an Account.

type string

Default value: account

The type of the object returned. Always use account.

name string

The name of the account.

legal_name string

The legal name of the account.

registration_id string

The registration ID of the account. The maximum character limit for this field is 63.

external_ref string

The optional external ID reference. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

meta object

timestamps object

created_at date-time

The date the account is created.

updated_at date-time

The date the account is last updated.

links object

self uri

A URL to the specific resource.

Example (from schema)

{
  "data": {
    "id": "deb6b25f-8451-4211-9a22-95610333df23",
    "type": "account",
    "name": "acc-name",
    "legal_name": "acc-legal-name",
    "registration_id": "00000000-0000-1000-8000-000f00000300",
    "external_ref": "16bedceb-8b2d-4f82-a973-b0a8d8432708",
    "meta": {
      "timestamps": {
        "created_at": "2021-02-23T09:40:33.882Z",
        "updated_at": "2021-02-23T09:40:33.882Z"
      }
    },
    "links": {
      "self": "/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]
Array [
detail string
status string
title string
]

Example (from schema)

{
  "errors": [
    {
      "detail": "Validation failed: field 'Name' on the 'min' tag.",
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

404

Not Found

application/json

Schema

Schema

errors object[]
Array [
detail string
status string
title string
]

Example (from schema)

{
  "errors": [
    {
      "detail": "account not found",
      "status": "404",
      "title": "Not Found"
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...