POST
/
Organization
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Organization \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "orgParentId": 236,
  "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",
  "replyToEmail": "email@example.com",
  "orgLogo": {
    "ftype": "pdf",
    "filename": "my-doc.pdf",
    "furl": "https://mysite.com/my-doc.pdf",
    "fContent": "TXkgdGVzdCBmaWxlHJ==..."
  },
  "contacts": [
    {
      "contactName": "Herman Martinez",
      "contactEmail": "herman@hermanscoatings.com",
      "contactTitle": "Owner",
      "contactPhone": "3055550000"
    }
  ],
  "billingInfo": {
    "achRouting": "123123123",
    "achAccount": "123123123",
    "billingAddress": "123 Walnut Street",
    "billingCity": "Johnson City",
    "billingState": "TN",
    "billingZip": "37615",
    "billingCountry": "US"
  },
  "hasBilling": true,
  "hasResidual": true,
  "services": null
}'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseData": 245
}

Authorizations

​
requestToken
string
header
required

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

Headers

​
idempotencyKey
string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Body

OrganizationData object to add
​
orgName
string
required

The name of the organization.

Example:

"Pilgrim Planner"

​
orgType
integer
required

The organization type. Currently, this must be 0.

Example:

0

​
replyToEmail
string
required

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"

​
orgParentId
integer

The ID of the org's parent organization.

Example:

236

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

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"

​
responseData

Returns the organization ID.

Was this page helpful?

Add ResponseUpdate Org