Models
Reusable component schemas are documented once and linked from every operation that uses them.
| Model | Description |
|---|---|
| ReturnMessage | Optional user-facing notification returned by connector and App Connect workflows. |
| ApiKeyLoginRequest | Credentials and connector context used to establish an App Connect session for an API-key connector. |
| ApiKeyLoginResponse | Successful API-key login result and the new App Connect session token. |
| ErrorResponse | Error payload. Legacy routes may return a plain string instead. |
| GenericSuccessResponse | Route-specific JSON response. Consult the operation description; this generic shape is retained for legacy endpoints that do not have a stable shared schema. |
| BasicMutationResponse | Standard result envelope for an App Connect mutation. |
| ContactInfo | Connector-normalized CRM contact returned by lookup and create operations. |
| ContactSearchResponse | Result of a connector-backed CRM contact search. |
| CreateContactRequest | Standard CRM contact creation fields plus connector-specific submission data. |
| ContactMutationResponse | Result of creating a CRM contact through the active connector. |
| RcParty | RingCentral caller or callee identity embedded in a call record. |
| RcCallRecording | RingCentral call-recording metadata. Recording and download URLs can be sensitive. |
| RcCallLogLeg | One RingCentral call leg included in a detailed call record. |
| RcCallLogRecord | RingCentral call record accepted from the browser client or server-side logging service. Unknown RingCentral fields are preserved for connector use. |
| AdditionalSubmission | Connector-defined logging fields assembled by the browser client or server-side logging service, including Bullhorn note actions, Clio billing state, and administrator-assignment metadata when configured. |
| CreateCallLogRequest | Call, contact, note, identity, and optional RingSense data used to create a CRM call activity. |
| UpdateCallLogRequest | Fields used to find and partially update an existing CRM call activity. |
| CallLogInfo | Connector-normalized details for an existing CRM call activity. |
| CallLogLookupItem | Lookup result for one requested RingCentral call session. |
| CallLogLookupResponse | Existing-activity lookup results for up to five RingCentral call sessions. |
| CallLogMutationResponse | Result of creating a CRM call activity. |
| CallLogUpdateResponse | Result of updating an existing CRM call activity. |
| CallNoteCacheRequest | Temporary call note stored before full server-side call logging. |
| CallDispositionRequest | Call identity and connector-defined dispositions to apply to an existing CRM activity. |
| MessageAttachment | RingCentral message attachment metadata. |
| MessageParty | Sender or recipient identity on a RingCentral message. |
| RcMessage | RingCentral SMS, MMS, fax, voicemail, pager, or text record accepted for CRM logging. |
| MessageCorrespondent | CRM association for one external participant in a message conversation. |
| MessageConversationLog | RingCentral messages and CRM correspondents to log individually or as one shared conversation activity. |
| MessageLogRequest | Message conversation, CRM association, and connector-specific fields used to create or update CRM message activities. |
| MessageLogResponse | Result of logging an SMS, MMS, fax, voicemail, or message conversation. |
| AsyncPluginCallbackRequest | Plugin completion report for a callback-enabled asynchronous call task. |
| AsyncPluginCallbackResponse | App Connect callback-processing result. successful describes whether the callback was accepted or processed, not whether the plugin background work succeeded. |
| AppointmentStatusUpdateRequest | Generic appointment status update request. |
| ServerVersionInfoResponse | Legacy server version metadata retained for older App Connect clients. |
| ImplementedInterfacesResponse | Feature flags derived from the selected connector module and server configuration. |
| UserInfoHashResponse | Server-keyed hashes of RingCentral account and extension identifiers. |
| DebugReportUrlResponse | Temporary object-storage upload destination for an App Connect debug report. |
| PluginRegisterRequest | Plugin catalog identity and RingCentral account context used for installation. |
| PluginMutationResponse | Result of installing or removing an account-level plugin registration. |
| AuthValidationResponse | Result of validating the current user's stored CRM authorization. |
| ManagedAuthStateResponse | Readiness of administrator-managed API-key credentials for a RingCentral account and extension. |
| ManagedOAuthStateResponse | Account-level managed OAuth setup state for the selected connector. |
| UserSetting | One connector or App Connect user-setting entry. |
| UserSettings | User-setting entries keyed by their manifest setting identifier. |
| UserSettingsEnvelope | Optional wrapper used by settings preload and update operations. |
| UserSettingsUpdateRequest | Per-user settings upsert and removal request. |
| AdminSuccessMessage | Plain-text confirmation returned after an administrator update succeeds. |
| AdminSettingsUpdateRequest | Account-level App Connect settings submitted by a RingCentral administrator. |
| ManagedAuthFieldDefinition | Connector credential field that supports administrator-managed storage. |
| StoredFieldValue | Administrator view of one stored managed-auth value. |
| ManagedAuthAdminUserValue | Managed-auth values stored for one RingCentral extension. |
| ManagedAuthAdminResponse | Administrator-facing managed-auth definitions and currently stored values. |
| ManagedAuthUpdateRequest | Account-scoped or extension-scoped managed-auth value update. |
| ManagedOAuthValues | Administrator-supplied values used to configure account-scoped CRM OAuth. |
| AdminManagedOAuthCacheRequest | Pending managed OAuth configuration to cache for the RingCentral account. |
| AppointmentAttendee | Normalized attendee returned with an appointment. |
| AppointmentContactReference | CRM contact to associate with the appointment, as an id or typed reference. |
| AppointmentCreateRequest | Canonical wrapped appointment create request or deprecated direct payload. |
| AppointmentPatchRequest | Canonical wrapped appointment patch request or deprecated direct payload. |
| AppointmentListResponse | Appointment list result, including connector-level failures returned with HTTP 200. |
| HealthResponse | Literal liveness response. It does not verify databases, connectors, or upstream services. |
| ReleaseNoteItem | One categorized App Connect or connector release note. |
| ReleaseNoteSections | Release-note lists keyed by global or connector platform name. |
| ReleaseNotesResponse | App Connect and connector release notes grouped by connector-declared server version; global-only versions are not emitted. |
| AppointmentCreateInput | Fields required to create a connector appointment. |
| AppointmentPatchInput | Appointment fields to replace; omitted fields remain unchanged. |
| AppointmentFailureResponse | Connector-level appointment failure returned with HTTP 200. |
| AppointmentCreateResponse | Appointment creation result. |
| AppointmentRecordResponse | Appointment mutation or refresh result that returns the current record on success. |
| AppointmentActionResponse | Appointment confirmation or cancellation result. |
| IdentifiedAppointment | Appointment record with the identifier required by list and mutation responses. |
| CallDownEntry | Server-owned scheduled call-back entry scoped to one App Connect user. |
| CallDownCreateRequest | Fields accepted when scheduling a server-owned call-back entry. |
| CallDownPatchRequest | Allowed fields for updating a server-owned call-back entry. |
| CallDownCreateResponse | Result of scheduling a call-back entry. |
| CallDownListResponse | Scheduled call-back entries owned by the current App Connect user. |
| CallDownMutationResponse | Result of updating or deleting a call-back entry. |