Update organization

Updates an organization's details by ID.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

orgIdintegerRequired
The numeric identifier for organization, assigned by Payabli.

Request

This endpoint expects an object.
serviceslist of objectsOptional
billingInfoobjectOptional
contactslist of objectsOptional
List of contacts.
hasBillingbooleanOptional
hasResidualbooleanOptional
orgAddressstringOptional
The organization's address.
orgCitystringOptional
The organization's city.
orgCountrystringOptional
The organization's country.
orgEntryNamestringOptional
The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
orgIdstringOptional
An alternate ID for the organization, in string format. This can be your internal identifier for an org, and is typically a name, like "My Suborganization".
orgNamestringOptional
The name of the organization.
orgParentIdlongOptional
The ID of the org's parent organization.
orgStatestringOptional
The organization's state.
orgTimezoneintegerOptional

The org’s timezone, in UTC offset. For example, -5 is Eastern time.

orgTypeintegerOptional

The organization type. Currently, this must be 0.

orgWebsitestringOptional
The organization's website.
orgZipstringOptional
The organization's ZIP code.
replyToEmailstringOptionalformat: "email"

Email address for organization-level communications, such as messages about why an application was declined. This is required by commerce laws in the US.

Response

Success
isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
responseCodeinteger

Code for the response. Learn more in API Response Codes.

responseDatastring or integer
Returns the organization ID.
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

Errors

400
Bad Request Error
400
Bad Request Error
401
Unauthorized Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error