How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opply Customer Status API

The Customer Status API from Opply — 2 operation(s) for customer status.

Opply Customer Status API is one of 47 APIs that Opply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customer Status. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 0.0.0.

Requests are made against the base URL https://api.opply.com.

3 operations 2 paths 8 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.0
Base URL
https://api.opply.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Opply Customer Status API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 3

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

Customer Status 3
GET
/api/v1/crm/companies/{uuid}/status/
Get current customer status
api_v1_crm_companies_status_retrieve 1 param → 200404
PUT
/api/v1/crm/companies/{uuid}/status/
Update customer status
api_v1_crm_companies_status_update 1 param body → 200
GET
/api/v1/crm/companies/{uuid}/status/history/
Get customer status history
api_v1_crm_companies_status_history_list 3 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CustomerStatus (6 properties), PaginatedCustomerStatusList (4 properties), CustomerStatusUpdate (3 properties), UpdatedBy (2 properties). Each schema is shown below with its type and property counts.

CustomerHealthStatusEnum
string
healthy - Healthy average - Average atrisk - At Risk new - New churned - Churned onhold - On Hold
CustomerHoldReasonEnum
string
overduepayments - Overdue Payments newcontractrequired - New Contract Required verificationneeded - Verification Needed other - Other
BlankEnum
CustomerStatus
object
Serializer for reading CustomerStatus records.
6 properties 6 required
PaginatedCustomerStatusList
object
4 properties 2 required
UpdatedBy
object
2 properties 2 required
CustomerStatusNotFoundResponse
object
1 property 1 required
CustomerStatusUpdate
object
Serializer for updating a customer's status.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-customer-status-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
Opply Admin panel API
Opply Agents API
Opply Agreements API
Opply api API
Opply App Orders API
Opply Brain API
Opply Brands API
Opply Buyer Documents API
Opply Buyer Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Where this information came from

This is an independent, third-party profile of Opply Customer Status API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.