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

Orange Business Campaign management API

Management of actions on a fleet of devices

Orange Business Campaign management API is one of 92 APIs that Orange Business publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaign Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an engineering blog.

This API exposes 7 operations across 4 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 2026.7.0.

Requests are made against a single base URL, https://liveobjects.orange-business.com.

7 operations 4 paths 43 schemas 1 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.7.0
Base URL
https://liveobjects.orange-business.com/api/v1
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Orange Business Campaign management API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (X-API-KEY). It supports OAuth 2.0 (OAuth2.0) using the authorizationCode flow, exposing 23 scopes. By default, every request must be authenticated.

Paths & Operations 7

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

Campaign management 7

Management of actions on a fleet of devices

PUT
/api/v0/deviceMgt/campaigns/{campaignId}/cancel
Cancel a campaign
cancelCampaign 2 params → 200
GET
/api/v0/deviceMgt/campaigns
List all campaigns
listCampaigns 4 params → 200
POST
/api/v0/deviceMgt/campaigns
Create a campaign
createCampaign body → 201
GET
/api/v0/deviceMgt/campaigns/{campaignId}
Get a campaign
getCampaign 1 param → 200
DELETE
/api/v0/deviceMgt/campaigns/{campaignId}
Delete a campaign
deleteCampaign 2 params → 200202
PATCH
/api/v0/deviceMgt/campaigns/{campaignId}
Update a campaign
updateCampaign 1 param body → 200
GET
/api/v0/deviceMgt/campaigns/{campaignId}/targets
Get the campaign status per device
getCampaignDetails 4 params → 200

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are Campaign (12 properties), CampaignOperationState (8 properties), AssetParameterValue (6 properties), CampaignStatsPerStatus (6 properties). Each schema is shown below with its type and property counts.

CampaignTwinReadDefinition
object
4 properties 1 required
CampaignTwinClearObservationsOperation
1 required
CampaignOperationState
object
8 properties 1 required
CampaignRequestedContentFormat
object
2 properties
PageableCampaign
object
4 properties 4 required
CampaignOptions
object
1 property
CampaignConfigureDefinition
object
2 properties 1 required
CampaignPlanning
object
2 properties 2 required
CampaignTwinReadOperation
2 required
CampaignStatsPerStatus
object
Statistics about devices with a given status
6 properties 6 required
CampaignOperation
object
2 properties 1 required
PageableCampaignPerTarget
object
4 properties 4 required
CampaignResourceOperation
1 required
CampaignPerTarget
object
5 properties 5 required
CampaignTwinWriteMetadataOperation
2 required
CampaignConfigureOperation
2 required
CampaignTwinOperationPolicy
object
1 property
DefinitionRequest
object
2 properties 2 required
CampaignResourceUpdateDefinition
object
5 properties 2 required
TwinAddObservationDefinition
object
2 properties 2 required
CampaignTwinWriteDefinition
object
6 properties 3 required
AssetParameterValue
object
6 properties
DefinitionPolicy
object
3 properties
CampaignTwinOperationMetadata
object
2 properties 1 required
CampaignTwinExecuteDefinition
object
4 properties 1 required
CampaignResourceDefinition
object
4 properties 2 required
CampaignTwinWriteMetadataDefinition
object
4 properties 2 required
CampaignTwinOperationOptions
object
1 property
CampaignTwinOperationOptionsLwm2m
object
1 property
CampaignTwinAddObservationOperation
1 required
CampaignDefinition
object
6 properties 4 required
TwinClearObservationsDefinition
CampaignTwinOperationWriteValue
object
2 properties 2 required
DeviceSelector
object
2 properties
CampaignTwinOperationWriteMetadataValue
object
2 properties 2 required
CampaignCommandOperationV1
2 required
Campaign
object
12 properties 5 required
CampaignOperationStateError
object
4 properties
CampaignResourceUpdateOperation
1 required
CampaignTwinWriteOperation
2 required
CampaignCommandV1Definition
object
3 properties 1 required
CampaignTwinExecuteOperation
2 required
CampaignUpdating
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orange-business-campaign-management-api-openapi.yml Raw ↑

Other APIs Orange Business publishes across the network.

Orange Business IoT Managed Global Connectivity API
Orange Business Orange Money WebPay API
Orange Business Pay With Orange Bill API
Orange Business SMS Middle East and Africa API
Orange Business Voice as a Service API
Orange Business Contact Everyone API
Orange Business Business Talk API
Orange Business Cloud Avenue API
Orange Business Evolution Platform IaaS API
Orange Business EVPL Online API
Orange Business EVPL Monitoring API
Orange Business Content Delivery Boost API
Where this information came from

This is an independent, third-party profile of Orange Business Campaign management 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.