Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RentCheck Account Settings API

The Account Settings API from RentCheck — 9 operation(s) for account settings.

RentCheck Account Settings API is one of 31 APIs that RentCheck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account Settings. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 14 operations across 9 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://prod-public-api.getrentcheck.com.

14 operations 9 paths 15 schemas 3 DELETE5 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://prod-public-api.getrentcheck.com
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

RentCheck Account Settings API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as x-app-id (x-app-id). An API key is passed in the header as x-app-secret (x-app-secret). By default, every request must be authenticated.

  • bearerAuth — Authorization key needed to use the API
  • x-app-id — Represents the identification of you application
  • x-app-secret — Represents the secret for your application

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 3 DELETE, 5 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Account Settings 14
DELETE
/v1/account-settings/email-customizations/{customizationId}
Delete an email customization
1 param → 204401404
GET
/v1/account-settings/email-customizations/{customizationId}
Get an email customization by ID
1 param → 200401404
GET
/v1/account-settings/email-customizations
List email customizations
→ 200401404
POST
/v1/account-settings/email-customizations
Upsert email customizations
body → 200400401
POST
/v1/account-settings/email-customizations/test-email
Send a test email customization
body → 200400401
GET
/v1/account-settings
Get account settings
→ 200401
PUT
/v1/account-settings
Update account settings
body → 200400401404
DELETE
/v1/account-settings/rooms
Delete custom rooms from account settings
body → 200400401
DELETE
/v1/account-settings/signature-acknowledgements/{templateId}
Delete a signature acknowledgement override
1 param → 200401404
GET
/v1/account-settings/signature-acknowledgements
Get signature acknowledgements
→ 200401
PUT
/v1/account-settings/signature-acknowledgements
Update signature acknowledgements
body → 200400401
GET
/v1/notifications-preferences/{preferencesId}
Get notification preferences by token
1 param → 200401
PUT
/v1/notifications-preferences/{preferencesId}
Update notification preferences via token
1 param body → 200400401
POST
/v1/sales/rev-share-prospects
Create a rev-share prospect
body → 200400409

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are api_account_settings (15 properties), account_settings_update_request_model (11 properties), notifications_preferences_response_model (8 properties), api_email_customization (6 properties). Each schema is shown below with its type and property counts.

api_signature_acknowledgement
object
Signature acknowledgement.
2 properties 2 required
api_email_customization
object
Email customization.
6 properties 5 required
rev_share_prospect_create_request_model
object
5 properties 3 required
email_customization_upsert_request_model
object
Request body for upserting an email customization.
3 properties 3 required
signature_acknowledgements_update_request_model
object
Use the literal id default to update the subscription-wide acknowledgement, or an inspection template id to scope the change.
1 property 1 required
basic_email_customization
object
Basic email customization.
6 properties 5 required
api_account_settings
object
Account settings. signatureacknowledgement uses the API-facing shape.
15 properties 12 required
email_customization_test_request_model
object
Request body for sending a test email customization.
5 properties 5 required
signature_acknowledgements_response_model
object
Signature acknowledgements grouped by inspection template.
3 properties 1 required
notification_preference
object
2 properties 1 required
notification_preference_no_email
object
1 property 1 required
account_settings_update_request_model
object
Partial update of account settings. All keys optional; the server merges supplied values onto the current document.
11 properties
notifications_preferences_response_model
object
8 properties 5 required
account_settings_delete_rooms_request_model
object
Request body for deleting rooms.
2 properties 2 required
notifications_preferences_update_request_model
object
Partial update — any combination of the fields on the preferences document may be provided. Server merges the supplied values onto the current preferences.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-account-settings-api-openapi.yml Raw ↑

Other APIs RentCheck publishes across the network.

RentCheck Automations API
RentCheck Buildings API
RentCheck Chargebee API
RentCheck Communities API
RentCheck Dashboard API
RentCheck File Requests API
RentCheck Filter Segments API
RentCheck Inspection Features API
RentCheck Inspections API
RentCheck Inspections Templates API
RentCheck Inspections V2 API
RentCheck Integrations API