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

RingCentral Custom Fields API

The Custom Fields API from RingCentral — 2 operation(s) for custom fields.

RingCentral Custom Fields API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

4 operations 2 paths 4 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Custom Fields API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Fields 4
GET
/restapi/v1.0/account/{accountId}/custom-fields
Get Custom Field List
listCustomFields 1 param → 200
POST
/restapi/v1.0/account/{accountId}/custom-fields
Create Custom Field
createCustomField 1 param body → 200
PUT
/restapi/v1.0/account/{accountId}/custom-fields/{fieldId}
Update Custom Field
updateCustomField 2 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/custom-fields/{fieldId}
Delete Custom Field
deleteCustomField 2 params → 204

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CustomFieldModel (3 properties), CustomFieldCreateRequest (2 properties), CustomFieldUpdateRequest (1 property), CustomFieldList (1 property). Each schema is shown below with its type and property counts.

CustomFieldList
object
1 property
CustomFieldUpdateRequest
object
1 property
CustomFieldCreateRequest
object
2 properties
CustomFieldModel
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-custom-fields-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API