Update an entity

PATCH

entities

{entityId}

Update an entity

const options = {
  method: 'PATCH',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Supplies Co',
    website: 'https://acme-supplies.example.com',
    metadata: {crmId: 'C-1'}
  })
};

fetch('https://api.melio.com/v2/entities/{entityId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.melio.com/v2/entities/{entityId}"

payload = {
    "name": "Acme Supplies Co",
    "website": "https://acme-supplies.example.com",
    "metadata": { "crmId": "C-1" }
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

curl --request PATCH \
  --url https://api.melio.com/v2/entities/{entityId} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "name": "Acme Supplies Co",
  "website": "https://acme-supplies.example.com",
  "metadata": {
    "crmId": "C-1"
  }
}
'

HttpResponse<String> response = Unirest.patch("https://api.melio.com/v2/entities/{entityId}")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Supplies Co\",\n  \"website\": \"https://acme-supplies.example.com\",\n  \"metadata\": {\n    \"crmId\": \"C-1\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/entities/{entityId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Supplies Co\",\n  \"website\": \"https://acme-supplies.example.com\",\n  \"metadata\": {\n    \"crmId\": \"C-1\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.melio.com/v2/entities/{entityId}"

	payload := strings.NewReader("{\n  \"name\": \"Acme Supplies Co\",\n  \"website\": \"https://acme-supplies.example.com\",\n  \"metadata\": {\n    \"crmId\": \"C-1\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "ent_7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "type": "business",
  "externalId": "partner-biz-1234",
  "metadata": {
    "crmId": "C-1"
  },
  "createdAt": "2026-07-08T15:00:00Z",
  "updatedAt": "2026-07-08T15:10:00Z",
  "name": "Acme Supplies Co",
  "legalName": "Acme Supplies LLC",
  "businessType": "llc",
  "taxInfo": {
    "type": "ein",
    "identifierLast4": "6789"
  },
  "phoneNumber": "+12125551234",
  "contact": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "website": "https://acme-supplies.example.com",
  "address": {
    "line1": "350 5th Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10118",
    "countryCode": "US"
  },
  "legalAddress": {
    "line1": "350 5th Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10118",
    "countryCode": "US"
  },
  "industry": {
    "naicsCode": "424410"
  },
  "owner": {
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "[email protected]"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

Authorizations

api-key

string

header

required

Path Parameters

entityId

string

required

An entity id (ent_) or the sentinel me (the partner's sole entity).

Body

application/json

All fields optional; only supplied fields are updated. The compliance-sensitive fields legalName, legalAddress and taxInfo are immutable once the entity is created; supplying any of them returns a 400.

name

string

phoneNumber

string

businessType

enum<string>

Available options:

partnership,

sole-proprietorship,

llc,

corporation,

trust,

non-profit,

municipality

industry

object

Hide child attributes

industry.naicsCode

string

required

NAICS industry classification code (digits).

Pattern: ^[0-9]+$

industry.name

string

contact

object

Organization-level point of contact (a person). First and last name must be at least 2 characters and contain only letters, spaces, hyphens, dots or commas.

Hide child attributes

contact.firstName

string

required

Minimum string length: 2

contact.lastName

string

required

Minimum string length: 2

website

string

description

string

address

object

Hide child attributes

address.line1

string

required

Street address. Must not be a PO box for the business (physical) address.

address.city

string

required

address.state

string

required

Two-letter US state code (e.g. NY, CA).

Pattern: ^[A-Za-z]{2}$

address.postalCode

string

required

address.line2

string

address.aptNumber

string

address.countryCode

enum<string>

default:US

Available options:

US

externalId

string

Your own unique identifier for the resource. Unique per partner per resource type (reusing one returns 409 DUPLICATE_EXTERNAL_ID). Distinct from the Idempotency-Key header, which dedupes the request rather than identifying the resource.

Maximum string length: 255

Pattern: ^[A-Za-z0-9_-]+$

metadata

object

Free-form string key/value pairs stored and returned verbatim, never interpreted by Melio. Up to 50 keys; each key 1 to 40 chars and may not contain square brackets ([ ], reserved for the metadata[key] filter); value ≤100 chars. Filterable via metadata[key].

Hide child attributes

metadata.{key}

string

Maximum string length: 100

owner

object

The account owner's personal details.

Hide child attributes

owner.firstName

string

owner.lastName

string

owner.email

string<email>

owner.dateOfBirth

string<date>

owner.phoneNumber

string

Response

The updated entity.

string

required

Opaque entity id (ent_)

type

enum<string>

required

Available options:

business

externalId

string

metadata

object

Hide child attributes

metadata.{key}

string

Maximum string length: 100

createdAt

string<date-time>

updatedAt

string<date-time>

name

string

legalName

string

businessType

string

taxInfo

object

Hide child attributes

taxInfo.type

enum<string>

Available options:

ein,

ssn,

itin

taxInfo.identifierLast4

string

phoneNumber

string

contact

object

Contact as returned in responses; fields may be absent when the stored record is incomplete.

Hide child attributes

contact.firstName

string

contact.lastName

string

website

string

description

string

address

object

Address as returned in responses; fields may be absent when the stored record is incomplete.

Hide child attributes

address.line1

string

address.line2

string

address.city

string

address.state

string

address.postalCode

string

address.aptNumber

string

address.countryCode

string

legalAddress

object

Address as returned in responses; fields may be absent when the stored record is incomplete.

Hide child attributes

legalAddress.line1

string

legalAddress.line2

string

legalAddress.city

string

legalAddress.state

string

legalAddress.postalCode

string

legalAddress.aptNumber

string

legalAddress.countryCode

string

industry

object

Hide child attributes

industry.naicsCode

string

required

NAICS industry classification code (digits).

Pattern: ^[0-9]+$

industry.name

string

owner

object

Hide child attributes

owner.firstName

string

owner.lastName

string

owner.email

string

⌘I

Update an entity

const options = {
  method: 'PATCH',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Supplies Co',
    website: 'https://acme-supplies.example.com',
    metadata: {crmId: 'C-1'}
  })
};

fetch('https://api.melio.com/v2/entities/{entityId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.melio.com/v2/entities/{entityId}"

payload = {
    "name": "Acme Supplies Co",
    "website": "https://acme-supplies.example.com",
    "metadata": { "crmId": "C-1" }
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

curl --request PATCH \
  --url https://api.melio.com/v2/entities/{entityId} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "name": "Acme Supplies Co",
  "website": "https://acme-supplies.example.com",
  "metadata": {
    "crmId": "C-1"
  }
}
'

HttpResponse<String> response = Unirest.patch("https://api.melio.com/v2/entities/{entityId}")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Supplies Co\",\n  \"website\": \"https://acme-supplies.example.com\",\n  \"metadata\": {\n    \"crmId\": \"C-1\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/entities/{entityId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Supplies Co\",\n  \"website\": \"https://acme-supplies.example.com\",\n  \"metadata\": {\n    \"crmId\": \"C-1\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.melio.com/v2/entities/{entityId}"

	payload := strings.NewReader("{\n  \"name\": \"Acme Supplies Co\",\n  \"website\": \"https://acme-supplies.example.com\",\n  \"metadata\": {\n    \"crmId\": \"C-1\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "ent_7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "type": "business",
  "externalId": "partner-biz-1234",
  "metadata": {
    "crmId": "C-1"
  },
  "createdAt": "2026-07-08T15:00:00Z",
  "updatedAt": "2026-07-08T15:10:00Z",
  "name": "Acme Supplies Co",
  "legalName": "Acme Supplies LLC",
  "businessType": "llc",
  "taxInfo": {
    "type": "ein",
    "identifierLast4": "6789"
  },
  "phoneNumber": "+12125551234",
  "contact": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "website": "https://acme-supplies.example.com",
  "address": {
    "line1": "350 5th Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10118",
    "countryCode": "US"
  },
  "legalAddress": {
    "line1": "350 5th Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10118",
    "countryCode": "US"
  },
  "industry": {
    "naicsCode": "424410"
  },
  "owner": {
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "[email protected]"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

Entities

Accounts

Payments

Tools

Webhooks

Authorizations

Path Parameters

Body

Response