Skip to navigation
APIPay Ops endpointsOrganizations

Update an organization

Beta
View as MarkdownOpen in Claude

Applies a partial update to an organization. Send only the fields you want to change. You can’t change an organization’s type. If you send paypointType, the request ignores it and doesn’t return an error.

Authentication

AuthorizationBearer

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

Path parameters

organizationReferencestringRequired
The organization reference.

Request

This endpoint expects an object.
doingBusinessAsstringOptional

The name the organization does business as (DBA).

descriptionstringOptional

A free-text description of the organization.

websitestringOptional
The organization's website URL.
customerServicePhonestringOptional
The customer service phone number.
customerServiceEmailstringOptional
The customer service email address.
timezonestringOptional

The organization’s time zone, as an IANA identifier such as America/Chicago.

externalIdstringOptional
Your own identifier for the organization.
customDatamap from strings to anyOptional

Arbitrary key-value data you attach to the organization.

Response

Organization updated.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null
The updated paypoint.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error