PUT
/
Organization
/
{orgId}
curl --request PUT \
  --url https://api-sandbox.payabli.com/api/Organization/{orgId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "orgName": "Pilgrim Planner",
  "orgType": 0,
  "orgId": "123",
  "orgWebsite": "www.pilgrimageplanner.com",
  "orgAddress": "123 Walnut Street",
  "orgCity": "Johnson City",
  "orgState": "TN",
  "orgZip": "37615",
  "orgCountry": "US",
  "orgTimezone": -5,
  "orgEntryName": "pilgrim-planner",
  "contacts": [
    {
      "contactName": "Herman Martinez",
      "contactEmail": "herman@hermanscoatings.com",
      "contactTitle": "Owner",
      "contactPhone": "3055550000"
    }
  ]
}'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": 2442,
  "pageIdentifier": null
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Body

OrganizationData object to modify. Only include the fields you want to update.
orgParentId
integer

The ID of the org's parent organization.

Example:

236

orgName
string

The name of the organization.

Example:

"Pilgrim Planner"

orgType
integer

The organization type. Currently, this must be 0.

Example:

0

orgId
string | null

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".

Example:

"My Suborganization"

orgWebsite
string | null

The organization's website.

Example:

"www.pilgrimageplanner.com"

orgAddress
string | null

The organization's address.

Example:

"123 Walnut Street"

orgCity
string | null

The organization's city.

Example:

"Johnson City"

orgState
string | null

The organization's state.

Example:

"TN"

orgZip
string | null

The organization's ZIP code.

Example:

37615

orgCountry
string | null

The organization's country.

Example:

"US"

orgTimezone
integer | null
default:0

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

Example:

-5

orgEntryName
string | null

The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.

Example:

"pilgrim-planner"

replyToEmail
string

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

Example:

"example@email.com"

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

contacts
object[] | null

List of contacts.

billingInfo
object
hasBilling
boolean | null
hasResidual
boolean | null
services
object[] | null

Response

200
application/json
Success
isSuccess
boolean

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

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseCode
integer | null

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

Example:

1

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

responseData

Returns the organization ID.

Was this page helpful?