Skip to main content
PATCH
Update creditor profile

Authorizations

Authorization
string
header
required

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

Path Parameters

creditorProfile
integer
required

Creditor profile ID from the manage creditors list.

Body

application/json
company_name
string
required
Required string length: 3 - 50
Example:

"Updated Capital"

company_phone
string
required

US phone number.

Example:

"8186017451"

company_email
string<email>
required
Maximum string length: 255
Example:

"updated@example.test"

company_address_1
string
required
Required string length: 2 - 100
Example:

"400 Updated Road"

company_city
string
required
Required string length: 2 - 30
Example:

"Los Angeles"

company_state
string
required
Maximum string length: 10
Example:

"CA"

company_zip
string
required
Pattern: ^\d{5}(-\d{4})?$
Example:

"90001-1234"

company_url
string
required

URL is normalized to HTTPS if no protocol is provided.

Maximum string length: 255
Example:

"updated.example.test"

company_address_2
string | null
Required string length: 2 - 100
Example:

"Suite 10"

Response

Creditor profile updated.

message
string
required
Example:

"Creditor profile updated successfully."

data
object
required
Last modified on July 19, 2026