Skip to main content
PUT
/
payees
/
{payeeId}
Update a Payee
curl --request PUT \
  --url https://test.onlinecheckwriter.com/api/v3/payees/{payeeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "nickName": "JD",
  "company": "Company A",
  "email": "[email protected]",
  "phone": "1234567890",
  "address1": "123 Main Street",
  "address2": "Apt 4B",
  "city": "City",
  "state": "ST",
  "zip": "12345",
  "country": "US"
}
'
{
  "success": true,
  "message": "Successfully updated",
  "data": {
    "payeeId": "RJ6qGAAxJPGE1rD"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
payeeId
string
required

The ID of the payee to update.

Example:

"RJ6qGAAxJPGE1rD"

Body

application/json

Payload to update payee details.

​
name
string

Name of the payee.

Example:

"John Doe"

​
nickName
string

Nick name of the payee.

Example:

"JD"

​
company
string

Company name.

Example:

"Company A"

​
email
string

Payee's email address.

Example:

"[email protected]"

​
phone
string

Payee's phone number.

Example:

"1234567890"

​
address1
string

Address 1

Example:

"123 Main Street"

​
address2
string

Address 2

Example:

"Apt 4B"

​
city
string

City name.

Example:

"City"

​
state
string

State

Example:

"ST"

​
zip
string

ZIP code.

Example:

"12345"

​
country
string

Country name.

Example:

"US"

Response

Payee updated successfully.

​
success
boolean
Example:

true

​
message
string
Example:

"Successfully updated"

​
data
object