Update an organization

Request

Updates an organization with a specified organization ID.
Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
Bodyapplication/json
Update Organization Request.
namestring, <= 60 charactersrequired
Name of the organization.
addressstring or null, <= 60 characters
Street address of the organization.
address2string or null, <= 60 characters
Second line of the street address.
citystring or null, <= 45 characters
City where the organization is located.
regionstring or null, <= 45 characters
Region or state where the organization is located.
countrystring or null^[A-Z]{2}$required
postalCodestring, <= 10 characters
Postal code of the organization.
phoneNumbersArray of objects(ContactPhoneNumbers)
List of phone numbers associated with the contact.
emailsArray of objects(ContactEmails)
List of email addresses associated with the contact.
taxDescriptorstring or null, <= 255 characters
Tax label of the organization. This information is displayed on the invoice.
invoiceTimeZonestring, <= 50 characters
Specifies the time zone to display on an invoice. UTC is used by default.
Example:"America/New_York"
questionnaireobject or null
Organization questionnaire.
settingsobject
Organization settings.
taxNumbersArray of objects or null(TaxNumber)
Tax numbers of the organization.
curl -i -X PATCH \
  'https://www.rebilly.com/_mock/catalog/all/organizations/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumbers": [
      {
        "label": "main",
        "value": "1-512-777-0269",
        "primary": true
      }
    ],
    "emails": [
      {
        "label": "main",
        "value": "rebilly@example.com",
        "primary": true
      }
    ],
    "taxDescriptor": "string",
    "invoiceTimeZone": "America/New_York",
    "questionnaire": {
      "role": "string",
      "monthlyTransactions": "string",
      "products": [
        "string"
      ],
      "integrationType": "string",
      "launchTiming": "string"
    },
    "settings": {
      "defaultTaxCalculator": {
        "type": "taxjar",
        "rate": 0
      },
      "billing": {
        "pendingOrderTtl": "P7D",
        "orderDelinquencyPeriod": "P7D",
        "subtractRecurringDiscountsFromMrr": true,
        "subtractOneTimeDiscountsFromMrr": true
      },
      "taxLocations": [
        {
          "address": "string",
          "city": "string",
          "region": "string",
          "country": "string",
          "postalCode": "string"
        }
      ],
      "notifications": {
        "notifyOnUserAccessChanges": false,
        "notifyOnApiKeyAccessChanges": false,
        "notificationEmailAddresses": []
      },
      "annualComplianceScreening": {
        "enabled": false,
        "monthDay": "02-15"
      },
      "payoutRequestAllocationOrder": [
        "payment-card",
        "alternative-payment-methods",
        "selected-payment-instrument"
      ]
    },
    "taxNumbers": [
      {
        "type": "eu-vat",
        "value": "GB980780684",
        "isDefault": true
      }
    ]
  }'

Responses

Organization updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
idstring, <= 50 charactersread-only

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
namestring, <= 60 charactersrequired
Name of the organization.
addressstring or null, <= 60 characters
Street address of the organization.
address2string or null, <= 60 characters
Second line of the street address.
citystring or null, <= 45 characters
City where the organization is located.
regionstring or null, <= 45 characters
Region or state where the organization is located.
countrystring or null^[A-Z]{2}$required
postalCodestring, <= 10 characters
Postal code of the organization.
phoneNumbersArray of objects(ContactPhoneNumbers)
List of phone numbers associated with the contact.
emailsArray of objects(ContactEmails)
List of email addresses associated with the contact.
taxDescriptorstring or null, <= 255 characters
Tax label of the organization. This information is displayed on the invoice.
invoiceTimeZonestring, <= 50 characters
Specifies the time zone to display on an invoice. UTC is used by default.
Example:"America/New_York"
reportCurrencystring, = 3 characters(CurrencyCode)
Currency to use for conversion in reports. This value cannot be changed.
Example:"USD"
questionnaireobject or null
Organization questionnaire.
settingsobject
Organization settings.
taxNumbersArray of objects or null(TaxNumber)
Tax numbers of the organization.
featuresArray of objectsread-only
Organization features.
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
_linksArray of objectsread-only
Related links.
Response
{
  "id": "org_0YVDM8RC7GDADADSBSMW124JA8",
  "name": "string",
  "address": "string",
  "address2": "string",
  "city": "string",
  "region": "string",
  "country": "string",
  "postalCode": "string",
  "phoneNumbers": [
    { … }
  ],
  "emails": [
    { … }
  ],
  "taxDescriptor": "string",
  "invoiceTimeZone": "America/New_York",
  "reportCurrency": "USD",
  "questionnaire": {
    "role": "string",
    "monthlyTransactions": "string",
    "products": [ … ],
    "integrationType": "string",
    "launchTiming": "string"
  },
  "settings": {
    "defaultTaxCalculator": { … },
    "billing": { … },
    "taxLocations": [ … ],
    "notifications": { … },
    "security": { … },
    "annualComplianceScreening": { … },
    "payoutRequestAllocationOrder": [ … ]
  },
  "taxNumbers": [
    { … }
  ],
  "features": [
    { … }
  ],
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}