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

WildApricot Contacts.CustomFields API

The Contacts.CustomFields API from WildApricot — 2 operation(s) for contacts.customfields.

WildApricot Contacts.CustomFields API is one of 29 APIs that WildApricot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.wildapricot.org/v2.2.

4 operations 2 paths 15 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.24.0
Base URL
https://api.wildapricot.org/v2.2
Authentication
OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 1

WildApricot Contacts.CustomFields API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope.

  • OAuth2 — OAuth2 authentication for WildApricot API

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.

Contacts.CustomFields 4
GET
/accounts/{accountId}/contactfields
WildApricot List of Custom Fields Related to Contacts and Members.
GetContactFieldDefinitions 2 params → 200401429
POST
/accounts/{accountId}/contactfields
WildApricot Creates a New Contact / Membership Field
CreateContactFieldDefinition 1 param body → 200400401429
PUT
/accounts/{accountId}/contactfields/{contactFieldId}
WildApricot Updates an Existing Contact / Membership Field
UpdateContactFieldDefinition 2 params body → 200400401404429
DELETE
/accounts/{accountId}/contactfields/{contactFieldId}
WildApricot Removes Existing Field by Id
DeleteContactFieldDefinition 2 params → 200401404429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are EditContactFieldParams (13 properties), EntityFieldDescription (9 properties), ExtraCharge (6 properties), OptionsListItem (5 properties). Each schema is shown below with its type and property counts.

EntityFieldDescription
object
9 properties 3 required
RulesAndTermsInfo
object
Additional info for fields with rules / terms conditions. Not present for other field types.
2 properties
OptionsListItem
object
5 properties
LinkedResource
object
2 properties
CustomFieldType
string
Custom field data type.
EditContactFieldParams
object
13 properties 2 required
ExtraCharge
object
This property appears for CalculatedExtraCharge fields only.
6 properties 2 required
UpdateContactFieldParams
CreateContactFieldParams
ContactFieldDescription
RenewalPolicy
object
Defines how system manages field during renewal process. Used only by multichoice fields with an associated cost.
2 properties
ContactFieldAccessLevel
string
Indicates who is allowed to view the field value. - Public - value is visible to anyone who has access to members directory - Members - value is visible only t…
EditEntityFieldParams
MemberFieldAccess
string
Controls whether the member is allowed to view or modify this field. Only for member fields.
EntityFieldDescriptionWithExtraCharge

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wildapricot-contacts-customfields-api-openapi.yml Raw ↑

Other APIs WildApricot publishes across the network.

WildApricot Accounts API
WildApricot Attachments API
WildApricot Contacts API
WildApricot Contacts.SavedSearch API
WildApricot Donation.CustomFields API
WildApricot Emailing.Drafts API
WildApricot Emailing.Operations API
WildApricot Emailing.SentEmailRecipients API
WildApricot Emailing.SentEmails API
WildApricot Events API
WildApricot Events.EventRegistrations API
WildApricot Events.EventRegistrationTypes API