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

Neon One Campaigns API

Fundraising campaigns that transactions are attributed to.

Neon One Campaigns API is one of 12 APIs that Neon One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against 2 base URLs: https://api.neoncrm.com/v2, https://trial.z2systems.com/v2.

6 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.11
Base URL
https://api.neoncrm.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Neon One Campaigns API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication. Username is the Neon CRM organization's Org ID; password is an API key generated for a system user under Settings User Management.

Paths & Operations 6

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

Campaigns 6

Fundraising campaigns that transactions are attributed to.

GET
/campaigns
List campaigns
listCampaigns → 200401
POST
/campaigns
Create a campaign
createCampaign body → 200401
GET
/campaigns/{id}
Retrieve a campaign
getCampaign 1 param → 200404
PUT
/campaigns/{id}
Update a campaign
updateCampaign 1 param body → 200404
PATCH
/campaigns/{id}
Partially update a campaign
patchCampaign 1 param body → 200404
DELETE
/campaigns/{id}
Delete a campaign
deleteCampaign 1 param → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Campaign (5 properties), Error (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property
Campaign
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neonone-campaigns-api-openapi.yml Raw ↑

Other APIs Neon One publishes across the network.

Neon One Accounts API
Neon One Custom Fields API
Neon One Donations API
Neon One Events API
Neon One Households API
Neon One Memberships API
Neon One Orders API
Neon One Properties API
Neon One Store API
Neon One Volunteers API
Neon One Webhooks API