Update a Payee
Update mutable fields on a payee. Only the fields you send are changed, except address, which is replaced whole rather than merged field by field.
entity_type and tax_id are not updatable. They are the taxpayer the payee is filed against and are fixed at create; a name or address change does not make a payee a different taxpayer, and a change to either of those two does.
Request
- Base URLhttps://api.justifi.ai/v1
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
the payer account this request is scoped to. Every payee, bank account, and payment lives under one payer account, so it is part of the path on all operate (Tier 1) routes.
the id of the resource
Headers
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)
Request body
Example request
{
"name": "Acme Plumbing LLC",
"address": {
"line1": "123 Example St",
"line2": "Suite 101",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55555",
"country": "USA"
},
"email": "ap@acmeplumbing.com"
}Response
Payee was updated successfully
Example response
{
"id": "prefix_xyz (same as id of data object)",
"type": "payee",
"data": {
"id": "pe_abc123",
"type": "payee",
"payer_account_id": "payer_123xyz",
"name": "Acme Plumbing LLC",
"entity_type": "limited_liability_company",
"email": "billing@acmeplumbing.com",
"tax_id_last4": "4021",
"address": {
"line1": "123 Example St",
"line2": "Suite 101",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55555",
"country": "USA"
},
"receiving_bank_account_id": "ba_recv123",
"status": "active",
"metadata": {
"erp_payee_id": "V-4021"
},
"created_at": "2026-01-01T12:00:00Z",
"updated_at": "2026-01-01T12:00:00Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.