Change the organization's profile: its name, kind and contact details (`organization.manage`, an owner by default) and the billing contact (`billing.manage`); a request with both needs both. Only the fields given change; null clears one. An API key gets 403

patch/v1/organization

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/organization
  • Auth: HTTP bearer

Request body

namestring
kind'owner' | 'property_manager' | 'both' nullable
contactEmailstring email nullable
contactPhonestring nullable
contactAddressstring nullable
billingEmailstring email nullable

Response

The organization after the change.

idstring required
namestring required
verifiedboolean
kindunknown required
contactEmailstring nullable

The company's own contact address.

contactPhonestring nullable
contactAddressstring nullable
billingEmailstring nullable

The billing contact: it also gets the payment, refund and receipt emails of live cases, and the online checkout of a live charge uses it as the payer's email when it can (without one, the payer types their own). Null when there is none.

Changes

No recorded changes to this operation across all 1 revision of this API.