Update payee | Root API

Updates an existing payee's information. Only the provided fields will be updated.

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

payee_idstringRequiredformat: "uuid"

This endpoint expects an object.

country_codeenumOptional

country_sub_divisionstring or nullOptional<=35 characters

State, province, or country subdivision

citystring or nullOptional<=35 characters

City or town name

address_linestring or nullOptional<=500 characters

Street address, building number, postal code, etc.

postal_codestring or nullOptional<=16 characters

Zip or postal code

namestring or nullOptional1-255 characters

emailstring or nullOptionalformat: "email"<=255 characters

Payee updated successfully

dataobject

warningstring or null

$	curl -X PATCH https://api.useroot.com/api/payees/payee_id \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"city": "Brooklyn",
>	"postal_code": "10002",
>	"name": "John Smith"
>	}'

1	{
2	"data": {
3	"created_at": "2024-03-20T12:00:00Z",
4	"updated_at": "2024-03-20T12:00:00Z",
5	"id": "123e4567-e89b-12d3-a456-426614174000",
6	"name": "John Doe",
7	"email": "john.doe@example.com",
8	"country_code": "US",
9	"country_sub_division": "NY",
10	"city": "New York",
11	"address_line": "123 Main Street, Apt 4B",
12	"postal_code": "10001"
13	}
14	}