organizations

Create an organization in a clinic

Creates a CRM organization with optional contact, website, address, assigned user, and primary contact information. Requires CRM to be available for the target clinic and organization access to be granted by Ritten.

post/organizations

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/organizations
  • Auth: none declared

Request body

namestring required

Organization name.

typeIdstring uuid required

Organization type ID.

emailstring email

Primary work email for the organization.

phonestring

Primary work phone for the organization.

websitestring uri

Organization website URL.

assignedUserIdstring uuid

User assigned to the organization.

primaryContactIdstring uuid

Person to set as the organization's primary contact.

Example request

{
  "name": "Ritten Recovery Center",
  "email": "admissions@example.com",
  "phone": "555-555-5555",
  "website": "https://example.com",
  "address": {
    "country": "US",
    "line": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "region": "NY",
    "postalCode": "10001",
    "notes": "Main admissions office"
  }
}

Response

success

idstring uuid
namestring
typeIdstring uuid

Organization type ID.

assignedUserIdstring uuid

User assigned to the organization, if any.

websitestring uri

Organization website URL.

createdAtstring date-time

Example response

{
  "name": "Ritten Recovery Center",
  "website": "https://example.com",
  "createdAt": "2024-01-01T00:00:00Z"
}

Changes

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