Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required
application/json

Body

  • account_uuids array[string(uuid)] Required

    The UUIDs of the accounts who should own the bank account. These must only be client accounts.

  • account_name string Required

    The friendly name for the bank account.

    Maximum length is 255.

  • account_holders string Required

    The name of the bank account holder(s) as it appears on statements

    Maximum length is 255.

  • account_number string Required

    The bank account number.

  • sort_code string Required

    The bank account sort code

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • account_name string

      The name of the bank account

    • account_holders string

      The name of the bank account holder(s) as it appears on statements

    • account_number string

      The bank account number

    • sort_code string

      The bank account sort code

    • accounts object

      The accounts linked to this bank account

      Hide accounts attributes Show accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string
PUT /api/v2/bank-accounts/{uuid}
curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/bank-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuids":["08518b40-6456-4934-b6e3-4841729f84a3","559118ae-07a5-45b4-bc72-89aeff44debd","39d45ebf-f884-40ec-8500-aa1d274ea6f8"],"account_name":"My Savings Account","account_holders":"Mr John A Smith","account_number":"01234567","sort_code":"012345"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuids": [
    "08518b40-6456-4934-b6e3-4841729f84a3",
    "559118ae-07a5-45b4-bc72-89aeff44debd",
    "39d45ebf-f884-40ec-8500-aa1d274ea6f8"
  ],
  "account_name": "My Savings Account",
  "account_holders": "Mr John A Smith",
  "account_number": "01234567",
  "sort_code": "012345"
}
Response examples (200)
{
  "uuid": "a83a418c-ab3c-4ee8-98e1-18ef9512807e",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "9a8ca201-0fa3-4186-b069-b76f6b3d3568",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2026-02-06T09:09:45+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-02-06T09:09:45+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "sort_code": "123456",
  "created_at": "2026-02-06T09:09:45+00:00",
  "updated_at": "2026-02-06T09:09:45+00:00",
  "account_name": "Savings Account",
  "account_number": "12345678",
  "account_holders": "Mr John A Smith"
}