WildApricot

https://gethelp.wildapricot.com/en/
Admin
WildApricot is a comprehensive membership management software that provides tools for website...
Tokens:111,356
Snippets:610
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Getting Started with WildApricot APIs

Source: https://gethelp.wildapricot.com/en/categories/32-wildapricot-apis

Information to help developers begin using the WildApricot APIs.

```APIDOC
## Getting Started with WildApricot APIs

### Description
Guides and resources for new users of the WildApricot API.

### Topics
- Using WildApricot's API
- API authentication
- Batch API requests
- API status codes
- Sample API applications
- Working with API from JavaScript
```

--------------------------------

### WildApricot Contact Welcome Email Template Example

Source: https://gethelp.wildapricot.com/en/articles/19-importing-contacts-and-members

An example of a welcome email template for newly imported contacts in WildApricot. It includes placeholders for personalization such as contact name, email, and a password reset link. This template serves as a basis for communicating login credentials and initial setup instructions to new members.

```text
Hi {Contact_First_Name}, Welcome to the new association website! You have been added as a member. You can use your email address to log in to your member profile: {Contact_Email} If this is your first time logging in, please use the following link to reset your password: {Contact_Password_Reset_URL} An email will be sent to you to reset your password. Once you've logged in, you will be prompted to accept the terms and conditions. Then, you can go into your profile and update and verify your contact information. Let's make this association something special! The Association Team
```

--------------------------------

### Example POST Request with Encoded API Key

Source: https://gethelp.wildapricot.com/en/articles/484-api-authentication

This is an illustrative example of the POST request to obtain an API key token, featuring a sample Base64 encoded API key. It mirrors the structure of the general API key token request but uses specific placeholder credentials.

```http
POST /auth/token HTTP/1.1
Host: oauth.wildapricot.org
Authorization: Basic QVBJS0VZOm85c2U4N3Jnb2l5c29lcjk4MDcwOS0=
Content-type: application/x-www-form-urlencoded

grant_type=client_credentials&scope=auto
```

--------------------------------

### Basic DMARC Record Example

Source: https://gethelp.wildapricot.com/en/articles/546-godaddy-dns-setup

An example of a basic DMARC TXT record for a custom domain, without the 'rua' tag. This record specifies the DMARC version, policy, and alignment settings for DKIM and SPF.

```text
Name:  _dmarc.{yourdomainname}
Value:  v=DMARC1; p=none; adkim=r; aspf=r;
```

--------------------------------

### Basic DMARC Record Example

Source: https://gethelp.wildapricot.com/en/articles/547-network-solutions-custom-domain-setup

This code snippet shows a basic DMARC record configuration without the 'rua' tag. It specifies the version, policy, and alignment for DKIM and SPF checks.

```TXT
Name:  _dmarc.{yourdomainname}
Value:  v=DMARC1; p=none; adkim=r; aspf=r; 
```

--------------------------------

### Social Profile Gadget - General Settings Input

Source: https://gethelp.wildapricot.com/en/articles/433-social-profile-gadget

Example of how to input profile names or links for social networks. Links must start with http:// or https://. Leaving a field blank hides the icon for that network.

```text
Facebook: https://www.facebook.com/yourprofile
Twitter: https://twitter.com/yourprofile
LinkedIn: https://www.linkedin.com/in/yourprofile
YouTube: https://www.youtube.com/user/yourchannel
Instagram: https://www.instagram.com/yourprofile
Pinterest: https://www.pinterest.com/yourprofile
```

--------------------------------

### Access WildApricot Admin API (v2)

Source: https://gethelp.wildapricot.com/en/articles/182-using-wildapricot-s-api

Demonstrates how to make a GET request to access version 2 of the WildApricot admin API to retrieve account information. This example uses a standard HTTP GET method.

```HTTP
GET https://api.wildapricot.org/v2/Accounts
```

--------------------------------

### WildApricot Batch API Request Example

Source: https://gethelp.wildapricot.com/en/articles/488-batch-api-requests

Demonstrates a batch request to the WildApricot API, including GET, POST, and DELETE operations. Note that the example includes a DELETE request to an external URL, which is likely an error in the original documentation.

```http
BATCH https://api.wildapricot.org/batch
[
  {
    "Id": "get all available accounts",
    "Order": 0,
    "PathAndQuery": "/v2/accounts",
    "Method": "GET"
  },
  {
    "Id": "create new contact",
    "Order": 1,
    "PathAndQuery": "/v2/accounts/123/contacts",
    "Method": "POST",
    "Payload": "{\"FirstName\":\"John\"}",
    "ContentType": "application/json"
  },
  {
    "Id": "try to delete account",
    "Order": 0,
    "PathAndQuery": "/v2/accounts",
    "Method": "DELETE",
    "Payload": null,
    "ContentType": null
  },
  {
    "Id": "try to open external url",
    "Order": 0,
    "PathAndQuery": "http://ya.ru",
    "Method": "DELETE",
    "Payload": null,
    "ContentType": null
  }
]
```

--------------------------------

### Retrieve Available API Versions (WildApricot API)

Source: https://gethelp.wildapricot.com/en/articles/507-base-admin-api-call

This example demonstrates how to make a GET request to the base WildApricot API endpoint to retrieve a list of available API versions. No specific parameters are required for this call.

```http
GET https://api.wildapricot.org
```

--------------------------------

### DMARC Record with 'rua' Tag Example

Source: https://gethelp.wildapricot.com/en/articles/546-godaddy-dns-setup

An example of a DMARC TXT record that includes the 'rua' tag to specify where DMARC aggregate reports should be sent. This is useful for monitoring email delivery and identifying potential spoofing.

```text
Name:  _dmarc.{yourdomainname}
Value:  v=DMARC1; p=none; adkim=r; aspf=r; rua=mailto:something@{yourdomainname};
```

--------------------------------

### Custom Domain Example

Source: https://gethelp.wildapricot.com/en/articles/544-domain-name-management

Shows an example of a custom domain name that can be used with a paid WildApricot account.

```text
http://nycs.com
```

--------------------------------

### Enable Guest Registration in WildApricot Ticket Setup

Source: https://gethelp.wildapricot.com/en/articles/33-guest-registration

This section describes how to enable guest registrations for specific ticket types within WildApricot. It involves checking a box during the ticket setup process. This functionality allows registrants to add guests during event registration.

```plaintext
To enable guest registrations, click the **Allow guest registrations** checkbox while setting up the ticket type.
```

--------------------------------

### Configure CNAME Records for WildApricot

Source: https://gethelp.wildapricot.com/en/articles/547-network-solutions-custom-domain-setup

Sets up CNAME records for `sites.wildapricot.org` and DKIM authentication. These records are crucial for email deliverability and website functionality.

```text
Alias: sites.wildapricot.org (Other Host)

Alias: _default._domainkey_
Other Host: dkim.wildapricot.org
```

--------------------------------

### DMARC Record with Rua Tag Example

Source: https://gethelp.wildapricot.com/en/articles/547-network-solutions-custom-domain-setup

This code snippet demonstrates a DMARC record configuration that includes the 'rua' tag. The 'rua' tag specifies an email address where DMARC aggregate reports should be sent.

```TXT
Name:  _dmarc.{yourdomainname}
Value:  v=DMARC1; p=none; adkim=r; aspf=r; rua=mailto:something@{yourdomainname}; 
```

--------------------------------

### Basic DMARC Record Example

Source: https://gethelp.wildapricot.com/en/articles/545-custom-domain-setup

This TXT record configures a basic DMARC policy. It specifies the DMARC version, the action to take for emails failing policy checks (none, quarantine, or reject), and the strictness of DKIM and SPF checks. The 'v' tag must be lowercase.

```text
Name: _dmarc.{yourdomainname}
Value: v=DMARC1; p=none; adkim=r; aspf=r; 
```

--------------------------------

### Example Website Domain Names

Source: https://gethelp.wildapricot.com/en/articles/65-email-hosting-with-a-custom-domain

Shows the format of website domain names, including the default provided by WildApricot and a placeholder for custom domains.

```domain
{yourdomainname}.wildapricot.org
```

--------------------------------

### Configure A Record for Domain IP Address

Source: https://gethelp.wildapricot.com/en/articles/545-custom-domain-setup

An A record maps a domain or subdomain to an IPv4 address. This example shows how to point your domain to a specific server IP address. Ensure the 'Name' field is correctly set to your domain or '@' depending on your DNS provider.

```DNS
Name: {yourdomainname}
Value: 34.226.77.200
```

--------------------------------

### Configure A Record for WildApricot

Source: https://gethelp.wildapricot.com/en/articles/547-network-solutions-custom-domain-setup

Sets the IP address for A records, essential for pointing your domain and subdomains to the WildApricot servers. This ensures proper routing for your website.

```text
Host: @ (none)
Numeric IP: 34.226.77.200

Host: * (All Others)
Numeric IP: 34.226.77.200
```

--------------------------------

### Sample DNS Records for WildApricot

Source: https://gethelp.wildapricot.com/en/articles/545-custom-domain-setup

This section provides sample DNS records required for custom domain setup in WildApricot, including A, CNAME, DKIM, SPF, CAA, and DMARC records. These are used to configure your domain provider's settings. Remember to replace placeholders like {yourdomainname} with your actual domain.

```dns
1) A record  
Name: {yourdomainname}
Value: 34.226.77.200

2) CNAME (Note: This record is optional) 
Name: {subdomain.yourdomainname}
Value: sites.wildapricot.org
 
3) DKIM record (a second CNAME record)
Name: default._domainkey.{yourdomainname} 
Value: dkim.wildapricot.org
 
4) SPF record (a TXT record)
Name: {yourdomainname}
Value: v=spf1 mx include:wildapricot.org ~all

5) CAA record
Name: {yourdomainname}
Value: 0 issue {already existing values, if any} "letsencrypt.org"

6) DMARC record (a second TXT record)
Name: _dmarc.{yourdomainname}
Value: v=DMARC1; p=none; adkim=r; aspf=r; 

```

--------------------------------

### Example Spam Message

Source: https://gethelp.wildapricot.com/en/articles/1897-recommended-best-practice-for-creating-a-text-message-campaign

Illustrates a text message example that is likely to be flagged as spam due to its content and formatting. It uses promotional language, ALL CAPS, and a shortened URL.

```text
SALE 50%, Click _tinyurl.com/2gmqw_ NOW!!!

```

--------------------------------

### Example Non-Spam Message

Source: https://gethelp.wildapricot.com/en/articles/1897-recommended-best-practice-for-creating-a-text-message-campaign

Demonstrates a text message example that is not likely to be flagged as spam. It includes clear context, a specific URL, the organization name, and an opt-out instruction.

```text
The January newsletter has been posted on the member portal. 
Read it at _swimsahara.com/report-jan_
Sent by Swimming Club of Sahara

Text STOP to opt out

```

--------------------------------

### CAA Record Example for LetsEncrypt

Source: https://gethelp.wildapricot.com/en/articles/545-custom-domain-setup

This CAA record specifies that only letsencrypt.org is authorized to issue SSL/TLS certificates for the domain. This helps prevent unauthorized certificate issuance and ensures compliance with certificate policies.

```text
Name: {yourdomainname}
Tag: issue
Flag: 0
Domain: letsencrypt.org
```

--------------------------------

### Example Email Addresses

Source: https://gethelp.wildapricot.com/en/articles/65-email-hosting-with-a-custom-domain

Illustrates common formats for email addresses, including those from free providers like Gmail and Yahoo, and the default format provided by WildApricot for custom domains.

```email
yourorganizationname@gmail.com
```

```email
yourorganizationname@yahoo.com
```

```email
{yourdomainname}@wildapricot.org
```

--------------------------------

### WildApricot Theme File Structure Example

Source: https://gethelp.wildapricot.com/en/articles/462-theme-and-page-generation-process

Illustrates the directory structure of WildApricot themes, including main configuration files, templates, and layout files, demonstrating theme inheritance.

```plaintext
/Theme1/
/Theme1/MainConfig.cfg
/Theme1/MainTemplate.tpl
/Theme1/Layouts/LayoutsTemplate.tpl

/Theme2/
/Theme2/MainConfig.cfg

/Theme2/
/Theme2/MainConfig.cfg (file from *Theme2*, overrides *Theme1* file with the same name)
/Theme2/MainTemplate.tpl (taken from *Theme1* theme)
/Theme2/Layouts/LayoutsTemplate.tpl (also taken from *Theme1* theme)
```

--------------------------------

### Configure GoDaddy CNAME Record for WildApricot

Source: https://gethelp.wildapricot.com/en/articles/546-godaddy-dns-setup

Establishes a CNAME record to connect your custom domain to the WildApricot subdomain. This maps your domain name to the WildApricot hosting service.

```text
Name = {yourdomainname}
Value = sites.wildapricot.org
TTL = Default
```

--------------------------------

### WildApricot API: OR Operator Example

Source: https://gethelp.wildapricot.com/en/articles/499-events-admin-api-call

Shows how to use the OR operator to include results that satisfy at least one of the specified criteria. This broadens search results when multiple conditions are acceptable.

```text
$filter=substringof('Name', 'training') eq true OR $filter=Tags in [training]
```

--------------------------------

### WildApricot API: AND Operator Example

Source: https://gethelp.wildapricot.com/en/articles/499-events-admin-api-call

Demonstrates using the AND operator to filter results where both specified criteria must be met. This is useful for narrowing down searches based on multiple conditions.

```text
$filter=RegistrationEnabled eq true AND StartDate gt 2015-01-15
```

--------------------------------

### Transitioning from API Version 1 to Version 2

Source: https://gethelp.wildapricot.com/en/articles/182-using-wildapricot-s-api

Guidance for migrating applications from WildApricot API Version 1 to Version 2, covering authentication, authorization, and response formats.

```APIDOC
## Transitioning from API Version 1 to Version 2

### Description
This section provides essential information for transitioning your application from Version 1 of the WildApricot API to Version 2. It covers key changes in authentication, authorization, and response structures.

### Key Changes

*   **Authentication:** Version 2 uses OAuth authentication. Server-side authentication is a two-step process:
    1.  The client application requests an authentication token from the authentication server.
    2.  The authentication server returns an authentication token for use in API calls.
*   **Authorization and API Keys:** Third-party servers or applications must be authorized to access your WildApricot account. During authorization, a unique API key is assigned. This API key is used to request an authentication token. Refer to API access options for more details.
*   **XML Response Format:** For asynchronous Contacts API calls, the root node in Version 2 is `ApiResponse`. In Version 1, it was `AsyncResult`.
```

--------------------------------

### OAuth Token with User Credentials

Source: https://gethelp.wildapricot.com/en/articles/484-api-authentication

Obtain an access token by providing the user's email and password. This method is suitable when the user trusts your application and is willing to share their credentials.

```APIDOC
## POST /auth/token

### Description
Requests an access token using a user's email and password.

### Method
POST

### Endpoint
/auth/token

### Parameters
#### Headers
- **Host** (string) - Required - The host for the authentication service (oauth.wildapricot.org).
- **Authorization** (string) - Required - Basic authentication header with Base64 encoded `CLIENT_ID:CLIENT_SECRET`.
- **Content-type** (string) - Required - Set to `application/x-www-form-urlencoded`.

#### Request Body
- **grant_type** (string) - Required - Must be `password`.
- **username** (string) - Required - The email address of the user.
- **password** (string) - Required - The password of the user.
- **scope** (string) - Optional - Defines the access scope, recommended to use `auto`.

### Request Example
```
POST /auth/token HTTP/1.1
Host: oauth.wildapricot.org
Authorization: Basic BASE64_ENCODED("CLIENT_ID:CLIENT_SECRET")
Content-type: application/x-www-form-urlencoded

grant_type=password&username=USER_EMAIL&password=USER_PASSWORD&scope=auto
```

### Response
#### Success Response (200)
- **access_token** (string) - The obtained access token.
- **token_type** (string) - The type of token (e.g., Bearer).
- **expires_in** (integer) - The token's expiration time in seconds.
- **refresh_token** (string) - A token to obtain a new access token without re-authenticating.
- **scope** (string) - The scope granted for the access token.

#### Response Example
```json
{
  "access_token": "some_access_token_string",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "some_refresh_token_string",
  "scope": "auto"
}
```
```

--------------------------------

### Defining root placeholder in SettingsLayout.cfg

Source: https://gethelp.wildapricot.com/en/articles/564-adding-parameters-to-gadgets

This snippet demonstrates the basic structure of the SettingsLayout.cfg file, showing the root placeholder element `<SettingsLayout>` which encloses all other configuration elements for gadget parameters.

```xml
<SettingsLayout>
...
</SettingsLayout>
```

--------------------------------

### Gadget Configuration Parameters (WildApricot)

Source: https://gethelp.wildapricot.com/en/articles/471-customizing-theme-gadgets

This snippet outlines the common parameters found in a WildApricot gadget's MainConfig.cfg file. These parameters define the gadget's metadata, such as its title, description, and the module providing its data.

```cfg
Title
Full name of the gadget.

ShortTitle
Short name of the gadget.

Module
Name of the module providing the data to the gadget.

Description
Description of the gadget.

Icon
Icon to be displayed in gadget selection screen.

IconSmall
Small icon to be displayed in gadget selection screen.

Dedication
Type of gadget.

Classname
Class name to be added to gadget outer HTML.
```

--------------------------------

### WildApricot API: Iterative Fetching with $skip and $top (New Approach)

Source: https://gethelp.wildapricot.com/en/articles/2911-preparing-your-api-integrations-for-pagination

This code demonstrates the new approach for fetching data using the WildApricot API with pagination. It shows how to iteratively retrieve data by incrementing the '$skip' parameter and setting the '$top' parameter (max 100) to get data in pages. This is for endpoints that require mandatory pagination.

```pseudocode
@skip = 0
@maxCount = 100
contacts = []
do {
    cnts = ../Contacts/?$async=false&$top=@maxCount&$skip=@skip
    contacts = contacts.concat(cnts)
    @skip = @skip + @maxCount
} while cnts.count == @maxCount

return contacts
```

--------------------------------

### WildApricot Theme Configuration Example (XML)

Source: https://gethelp.wildapricot.com/en/articles/468-customizing-main-theme-parameters

This XML snippet demonstrates the structure of the MainConfig.cfg file used for customizing WildApricot theme parameters. It includes elements for ParentId, Title, and ShortTitle. This file should be modified when creating a new theme, not when extending an existing one.

```xml
<?xml version="1.0"?>  
<Theme>  
  <ParentId>theme.prototype.main.v1.0</ParentId>  
  <Title>Clouds Orange</Title>  
  <ShortTitle>Orange</ShortTitle>  
</Theme>
```

--------------------------------

### Pass Auth Token to Public API

Source: https://gethelp.wildapricot.com/en/articles/484-api-authentication

This example illustrates how to include the authentication token in the 'Authorization' header of an HTTP request to the WildApricot public API. The token should be prefixed with 'Bearer '.

```HTTP
GET /v2.1/accounts HTTP/1.1
Host: api.wildapricot.com
User-Agent: MySampleApplication/0.1
Accept: application/json
Authorization: Bearer YOUR_TOKEN_HERE
```

--------------------------------

### OAuth Service Token Response

Source: https://gethelp.wildapricot.com/en/articles/484-api-authentication

This is an example of the successful HTTP response from the OAuth service after a token request. It includes the access token, token type, expiration time, refresh token, and user permissions.

```JSON
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
   "access_token":"2YotnFZFEjr1zCsicMWpAA",
   "token_type":"Bearer",
   "expires_in":1800,
   "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",
   "permissions":[
      {
        "accountId":123,
        "availableScopes":["contacts_view", "contacts_me", 
"contacts_edit", "finances_view", "events_view"]
      }
   ]
}
```

--------------------------------

### WildApricot Gadget Settings Layout Example

Source: https://gethelp.wildapricot.com/en/articles/564-adding-parameters-to-gadgets

This snippet shows the structure of the SettingsLayout.cfg file for a WildApricot slideshow gadget. It defines sections for general settings, slideshow controls, appearance, and advanced options, including various control elements and their attributes.

```xml
<SettingsLayout>
    <Section title="General">
        <Control settingName="ImageSource" />
        <Control settingName="GalleryLayout">
            <ControlItem value="FixedHeight">
                <Control settingName="LayoutFixedHeight" postfix="px" controlContainerDisplayType="fixed" />
            </ControlItem>
        </Control>
        <Control settingName="FitImage" />
    </Section>
    <Section title="Slideshow controls">
        <Control settingName="DisplayImage" title="Display image for:" titlePosition="Left" titleWidth="120" postfix="sec" controlContainerDisplayType="fixed" />
        <Control settingName="TransitionTime" title="Transition time:" titlePosition="Left" titleWidth="120" postfix="ms" controlContainerDisplayType="fixed" />
        <Control settingName="TransitionEffect" type="DropDownList" title="Transition effect:" titlePosition="Left" titleWidth="120" />
        <Control settingName="AllowUserManuallyNavigate" />
    </Section>
    <Section title="Appearance">
        <Style>
            <Margin />
        </Style>
    </Section>
    <Section title="Advanced" isCollapsible="true" isCollapsed="true">
        <UnencodedText>Use CSS to fine-tune appearance and behavior.
            &lt;a href=&quot;http://help.wildapricot.com/display/DOC/Gadgets#Gadgets-HTMLandCSSparameters/
?utm_source=contexthelp&amp;utm_medium=site&amp;utm_campaign=contexthelp&quot; target=&quot;_blank&quot; &gt;Learn more&lt;/a&gt;
        </UnencodedText>
        <Control settingName="ClientId"/>
        <Control settingName="CustomClassName"/>
        <Control settingName="InlineStyle"/>
    </Section>
</SettingsLayout>
```

--------------------------------

### Loading Templates in WildApricot

Source: https://gethelp.wildapricot.com/en/articles/458-theme-files-language-syntax

Shows how to load a template file into a page using the <$TemplateName()$> syntax. It also explains how to load templates from subfolders like 'Layouts/Helpful.tpl'.

```wildapricot
<$TemplateName()$>
<$Layouts/Helpful()$>
```

--------------------------------

### Configure TXT (SPF) Record for WildApricot

Source: https://gethelp.wildapricot.com/en/articles/547-network-solutions-custom-domain-setup

Defines the Sender Policy Framework (SPF) record, which helps prevent email spoofing by specifying which mail servers are authorized to send email on behalf of your domain.

```text
Host: @ (None) or * (All Others)
Text: v=spf1 mx include:wildapricot.org ~all

If using a subdomain:
Host: [your subdomain]
Text: v=spf1 mx include:wildapricot.org ~all
```

--------------------------------

### Referencing controls within a section in SettingsLayout.cfg

Source: https://gethelp.wildapricot.com/en/articles/564-adding-parameters-to-gadgets

This snippet shows how control elements are placed within a section in the SettingsLayout.cfg file. It lists example controls like `ImageSource`, `GalleryLayout`, and `FitImage` that can be configured by an administrator.

```xml
<Section title="General">
		<Control settingName="ImageSource" />
		<Control settingName="GalleryLayout" />
		<Control settingName="FitImage" />
</Section>
```

--------------------------------

### Configure GoDaddy A Record for WildApricot

Source: https://gethelp.wildapricot.com/en/articles/546-godaddy-dns-setup

Sets up the Address (A) record for the root domain to point to WildApricot's IP address. This is crucial for directing traffic to your WildApricot website. Ensure only one A record exists for optimal performance.

```text
Name = @
Value = 34.226.77.200
TTL = Default
```

--------------------------------

### Retrieve Top-Level API Calls for a Specific Version (WildApricot API)

Source: https://gethelp.wildapricot.com/en/articles/507-base-admin-api-call

This example shows how to make a GET request to a specific version of the WildApricot API endpoint to retrieve a list of top-level API calls available for that version. The version number is appended to the base API URL.

```http
GET https://api.wildapricot.org/v2
```

--------------------------------

### Pasting Code into the Editor

Source: https://gethelp.wildapricot.com/en/articles/1714-using-the-code-editor

Instructions on how to paste code from the clipboard into the WildApricot editor, specifying the keyboard shortcuts for Windows and macOS.

```text
To paste code from the clipboard, you must use the Ctrl + V keyboard combination on Windows and Command + V on a Mac.
```

--------------------------------

### Wild Apricot Redirect with Authorization Code

Source: https://gethelp.wildapricot.com/en/articles/484-api-authentication

This example shows the format of the HTTP request your application will receive after a user successfully authenticates via the Wild Apricot login page. The redirect includes an authorization 'code' and the 'state' parameter, which your application uses to complete the OAuth flow.

```HTTP
https://mycustomdomain.org/authcallback?code=s98er7gf87sd9fasdf&state=1234567
```

--------------------------------

### Obtain API Key Token with Refresh Token (POST Request)

Source: https://gethelp.wildapricot.com/en/articles/484-api-authentication

This example shows how to request an API key token along with a refresh token from the WildApricot authentication service. It's a variation of the standard API key token request, including the 'obtain_refresh_token=true' parameter in the form data.

```http
POST /auth/token HTTP/1.1
Host: oauth.wildapricot.org
Authorization: Basic BASE64_ENCODED("APIKEY:YOUR_API_KEY")
Content-type: application/x-www-form-urlencoded

grant_type=client_credentials&scope=auto&obtain_refresh_token=true
```

--------------------------------

### WildApricot Contacts API - Filter by Date (GET)

Source: https://gethelp.wildapricot.com/en/articles/502-contacts-admin-api-call

This example illustrates how to filter contacts based on a date field using the WildApricot API. It shows the correct format for date values (yyyy-mm-dd) when using operators like 'ge' (greater than or equal to) with fields that may contain spaces, such as 'Profile last updated'.

```http
$filter='Profile last updated' ge 2013-06-25
```

--------------------------------

### Wild Apricot Layouts Configuration

Source: https://gethelp.wildapricot.com/en/articles/472-customizing-master-layouts

Defines the master layouts available for a Wild Apricot theme in the `LayoutsConfig.cfg` file. It specifies the default layout and lists individual layouts with their IDs, titles, and descriptions.

```xml
<Layouts>
  <DefaultLayoutId>LayoutMain</DefaultLayoutId>
  <Layout>
    <ID>LayoutMain</ID>
    <Title>Main Layout</Title>
    <Description></Description>
  </Layout>
  <Layout>
    <ID>LayoutPlain</ID>
    <Title>Plain layout</Title>
    <Description></Description>
  </Layout>
  <Layout>
    <ID>LayoutLegacy</ID>
    <Title>Legacy Layout</Title>
    <Description></Description>
  </Layout>
</Layouts>
```

--------------------------------

### WildApricot ContactFields API - Retrieve Fields

Source: https://gethelp.wildapricot.com/en/articles/1611-contactfields-member-api-call

This API call retrieves a detailed list of all contact and membership fields available in your WildApricot database, along with system fields. The retrieved fields can be used for filtering contacts via the Contacts API. No specific code example is provided, but it is implied that this is a GET request.

```API
GET /api/v2/accounts/{accountId}/fields
```

--------------------------------

### Configure SPF Record for Email Sending Authorization

Source: https://gethelp.wildapricot.com/en/articles/545-custom-domain-setup

An SPF record (TXT type) authorizes mail servers to send emails on behalf of your domain, improving email security and deliverability. This example authorizes WildApricot servers. Ensure correct formatting and spacing, especially when merging with existing records.

```DNS
Name: {yourdomainname}
Value: v=spf1 mx include:wildapricot.org ~all
```

```DNS
Name: {yourdomainname}
Value: v=spf1 include:wildapricot.org include:_spf.google.com ~all
```

--------------------------------

### Retrieve members with WildApricot API in PHP

Source: https://gethelp.wildapricot.com/en/articles/485-sample-api-applications

This PHP application retrieves the names of the first 10 members from a Wild Apricot account and displays them on an HTML page. It demonstrates basic API usage for data retrieval. Requires a Wild Apricot account and API key.

```PHP
<?php
// PHP code to retrieve and display the names of the first 10 members
// from a Wild Apricot account.
// (Detailed code not provided in the original text)
?>
```

--------------------------------

### WildApricot Contacts API - Filter by Field (GET)

Source: https://gethelp.wildapricot.com/en/articles/502-contacts-admin-api-call

This snippet shows the general syntax for filtering contacts using the WildApricot API's $filter parameter. It includes placeholders for version, account ID, API key, and the specific filter criteria, along with examples of using relational operators and handling field names with spaces.

```http
GET
https://api.wildapricot.org/{version}/Accounts/{accountID}/Contacts?apikey={APIkey}&$filter={filterCriteria}
```

--------------------------------

### Copy Google Analytics 4 Tag Code (Manual Installation)

Source: https://gethelp.wildapricot.com/en/articles/1931-tracking-website-traffic-using-google-analytics-4

This snippet describes the process of manually copying the Google Analytics 4 tag code from the Google Analytics setup interface. It is a crucial step before adding the code to the WildApricot website. No specific programming language is involved in this copying action itself.

```General
Click the icon to copy the tag code.
```

--------------------------------

### Calling WildApricot Controls

Source: https://gethelp.wildapricot.com/en/articles/469-customizing-theme-controls

Demonstrates the basic syntax for invoking WildApricot controls within your templates. Parameters are passed similarly to how they are passed to gadgets.

```wildapricot
<$control.ControlName(param = "val")$>
```

--------------------------------

### DMARC Record with Rua Tag Example

Source: https://gethelp.wildapricot.com/en/articles/545-custom-domain-setup

This TXT record includes the 'rua' tag, which designates an email address for receiving DMARC aggregate feedback reports. These reports help monitor email delivery and detect potential domain spoofing or phishing attacks. The 'v' tag must be lowercase.

```text
Name:  _dmarc.{yourdomainname}
Value:  v=DMARC1; p=none; adkim=r; aspf=r; rua=mailto:something@{yourdomainname}; 
```

--------------------------------

### WildApricot API Call from JavaScript

Source: https://gethelp.wildapricot.com/en/articles/1705-working-with-api-from-javascript

This JavaScript code snippet demonstrates how to make a GET request to the WildApricot API to retrieve the current contact's email. It uses jQuery's AJAX method and requires the `clientId` to be provided in the HTTP headers. This method is applicable when the JavaScript code is running on a Wild Apricot domain, leveraging session cookies for authentication.

```javascript
$.ajax({
  url: "/sys/api/v2/accounts/58293/contacts/me",
  type: "GET",
  dataType: "json",
  cache: false,
  async: true,
  headers: { "clientId": "APPLICATION_CLIENT_ID" },
  success: function (data, textStatus, jqXhr) {
    alert("Current contact email:" + data.Email);
  },
  error: function (jqXHR, textStatus, errorThrown) {
    alert(textStatus + " (" + jqXHR.status + ") : " + errorThrown);
  }
});
```

--------------------------------

### General Formatting: Background Color

Source: https://gethelp.wildapricot.com/en/articles/453-color-and-style-settings-for-showcase-themes

Configures the background color for website elements. Supports color selection from a palette or by entering hexadecimal color codes. Allows adding to and removing from custom palettes.

```WildApricot Settings
Background color: select from palette or enter hex code (e.g., #FF0000).
Add to custom palette: click color, then plus sign.
Remove from custom palette: Ctrl+click color.
```

--------------------------------

### WildApricot API: GET /accounts/{accountId}/EmailDrafts with new parameters

Source: https://gethelp.wildapricot.com/en/articles/2872-api-update-added-new-parameters-for-specific-endpoints

Email drafts can now be filtered using $count and idsOnly parameters, streamlining the process of getting draft counts and IDs.

```api
GET /accounts/{accountId}/EmailDrafts
```

--------------------------------

### System Pages API Reference

Source: https://gethelp.wildapricot.com/en/articles/188-system-pages

Reference for WildApricot's system pages, including their purpose and URL endpoints.

```APIDOC
## System Pages API Reference

### Description
This API reference provides details on the various system pages available within the WildApricot platform. These pages handle core functionalities such as user authentication, event registration, and error handling.

### Available System Pages

| Page Name                 | Description                                                                                                   | URL                                                |
| ------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| Access denied (403)       | Error page displayed when access to the requested page is denied                                              | `/Sys/Error/403`                                   |
| Add member to bundle      | Form to add member to membership bundle                                                                       | `/Sys/AddBundleMember`                             |
| Anonymous payment profile | Form to allow existing contact to make a payment (e.g. event registration fee) without logging in                | `/Sys/Profile/Anonymous`                           |
| Authorization required    | Login message and form to access restricted page                                                              | `/Sys/Login`                                       |
| Blog post                 | Form to add, edit, and view blog posts                                                                        | `/[pageID]/AddPost`, `/[pageID]/[postID]/EditPost`, `/[pageID]/[postID]` |
| Change password           | Form for logged in user to change password                                                                    | `/Sys/Password/Change`                             |
| Contact profile           | Contact profile as it appears to the contact ("My Profile")                                                 | `/Sys/Profile`                                     |
| Email member              | Form to email member from member directory profile                                                            | `/Sys/PublicProfile/SendEmail/[userID]`            |
| Event details             | Displays event details and registration options for individual events                                         | `/event-[eventID]`                                 |
| Event registration        | Form to register for a particular event                                                                       | `/event-[eventID]/Registration`                    |
| Financial document        | Displays details of an invoice, payment, refund, or donation within the Invoices and payments screen of a contact's profile | `/Sys/FinDocument/[document ID]`                   |
| Forum topic               | Form to view, create, edit, and reply to forum topics                                                         | `/[pageID]/[topicID]`, `/[pageID]/[topicID]/AddTopic`, `/[pageID]/[topicID]/EditTopic`, `/[pageID]/[topicID]/NewMessage` |
| Member public profile     | Member profile as it appears to others                                                                        | `/Sys/PublicProfile/[userID]`                      |
| Membership level change   | Form for member to switch to a different membership level                                                     | `/Sys/MembershipLevelChange`                       |
| Membership renewal        | Form for member to renew membership                                                                           | `/Sys/MembershipRenewal`                           |
| Online store cart         | The shopping cart screen that forms part of the online store                                                  | `/Sys/Store/Cart`                                  |
| Online store checkout     | The Contact, Delivery, and Confirmation screens that appear when a customer is checking out their order from your online store | `/Sys/Store/Checkout`                              |
| Online store product      | The product details screen that appears when a visitor to your online store clicks on a product within the catalog | `/Sys/Store/Products/[productID]`                  |
| Page not found (404)      | Error page displayed when requested page does not exist or is not available                                   | `/Sys/Error/404`                                   |
| Poll details              | The description and questions for a poll or survey                                                            | `/Sys/Poll/[pollID]`                               |
| Reset password            | Form accessible via email link to change password                                                             | `/Sys/Password/Reset?id=[requestID]`               |
| Reset password request    | Form to request email containing reset password link                                                          | `/Sys/ResetPasswordRequest`                        |
| Site search results       | Results from a site search                                                                                    | `/Sys/Search?q=[searchstring]`                     |
| Terms of use              | Terms, rules, and contractual conditions to be accepted before logging in                                     | `/Sys/TermsOfUse`                                  |
| Unsubscribe from emails   | Form to confirm request to unsubscribe from emails                                                            | `/Sys/Unsubscribe?et=[requestID]`                  |

```

--------------------------------

### WildApricot Macro Placeholder Example

Source: https://gethelp.wildapricot.com/en/articles/39-email-macros

This example demonstrates the common syntax for inserting a macro into WildApricot emails. Macros are enclosed in curly braces and represent dynamic fields like contact names.

```text
{Contact_First_Name}
```

--------------------------------

### Reference Gadget-Specific Control in SettingsLayout.cfg

Source: https://gethelp.wildapricot.com/en/articles/564-adding-parameters-to-gadgets

Shows how to reference a gadget-specific control, like 'ImageSource', in the SettingsLayout.cfg file. This control is not defined in Settings.cfg but is processed by the gadget server code.

```xml
<Control settingName="ImageSource" />
```

--------------------------------

### Defining user-defined control references in SettingsLayout.cfg

Source: https://gethelp.wildapricot.com/en/articles/564-adding-parameters-to-gadgets

Illustrates how to define a custom control reference in SettingsLayout.cfg, including a `settingName` for internal reference and a `title` attribute for a user-friendly label displayed in the admin settings.

```xml
<Control settingName="MySetting" title="Check to enable extra coolness" />
```

--------------------------------

### WildApricot Contacts API - Filter by Balance (GET)

Source: https://gethelp.wildapricot.com/en/articles/502-contacts-admin-api-call

This snippet demonstrates how to retrieve contact records from the WildApricot API, specifically filtering for contacts whose 'Balance' is greater than 100. It uses a GET request to the Contacts endpoint with an API key and a $filter query parameter.

```http
GET
https://api.wildapricot.org/v1/Accounts/58293/Contacts?apikey=rktud7anqouibtdm1d4yhob9dgy&$filter=Balance gt 100
```

--------------------------------

### Obtain Access Token with User Login and Password

Source: https://gethelp.wildapricot.com/en/articles/484-api-authentication

This method is used to build client applications that authenticate on behalf of a user. It requires the user's email and password. Ensure you replace placeholder values like CLIENT_ID, CLIENT_SECRET, USER_EMAIL, and USER_PASSWORD with actual credentials and application details.

```HTTP
POST /auth/token HTTP/1.1
Host: oauth.wildapricot.org
Authorization: Basic BASE64_ENCODED("CLIENT_ID:CLIENT_SECRET")
Content-type: application/x-www-form-urlencoded

grant_type=password&username=USER_EMAIL&password=USER_PASSWORD&scope=auto
```

```HTTP
POST /auth/token HTTP/1.1
Host: oauth.wildapricot.org
Authorization: Basic dGNSc25xazRtcDo5OHdlcjd0OTg3YTlzMDdkZjk3OGE=
Content-type: application/x-www-form-urlencoded

grant_type=password&username=joe@mail.com&password=pwd123&scope=auto
```

--------------------------------

### WildApricot API GET Request with $top parameter (50)

Source: https://gethelp.wildapricot.com/en/articles/2051-api-update-returned-items-limited-to-100-per-request

Shows a GET request to the WildApricot contacts API with the `$top` parameter set to 50. The API will return 50 contacts as this is within the allowed limit.

```HTTP
GET https://api.wildapricot.org/v2/accounts/{account_id}/contacts?$async=false&$top=50
```

--------------------------------

### WildApricot API GET Request without $top parameter

Source: https://gethelp.wildapricot.com/en/articles/2051-api-update-returned-items-limited-to-100-per-request

Illustrates a GET request to the WildApricot contacts API without specifying the `$top` parameter. The API will return the maximum allowed number of contacts, which is 100.

```HTTP
GET https://api.wildapricot.org/v2/accounts/{account_id}/contacts?$async=false
```

--------------------------------

### Manage data with WildApricot API in C#

Source: https://gethelp.wildapricot.com/en/articles/485-sample-api-applications

This Visual Studio project, written in C#, uses Version 2 of the Wild Apricot API to perform various functions such as creating and updating contacts, retrieving events, managing event registrations, and handling payments. It utilizes the Newtonsoft.Json assembly for JSON serialization and deserialization. Requires Visual Studio and the Newtonsoft.Json NuGet package.

```C#
// C# code for a Visual Studio project interacting with Wild Apricot API v2
// Includes creating/updating contacts, getting events, managing registrations,
// and handling payments.
// Uses Newtonsoft.Json assembly.
// (Detailed code not provided in the original text)
```

--------------------------------

### WildApricot API GET Request with $top parameter (150)

Source: https://gethelp.wildapricot.com/en/articles/2051-api-update-returned-items-limited-to-100-per-request

Demonstrates a GET request to the WildApricot contacts API where the `$top` parameter is set to 150, but the API will return a maximum of 100 contacts due to the imposed limit.

```HTTP
GET https://api.wildapricot.org/v2/accounts/{account_id}/contacts?$async=false&$top=150
```

--------------------------------

### Defining parameter sections in SettingsLayout.cfg

Source: https://gethelp.wildapricot.com/en/articles/564-adding-parameters-to-gadgets

Illustrates how to define individual parameter sections within the SettingsLayout.cfg file. Each `<Section>` element can have a title attribute to label the section.

```xml
<Section>
...
</Section>
```

--------------------------------

### Custom Font CSS Example for WildApricot

Source: https://gethelp.wildapricot.com/en/articles/1641-adding-your-own-fonts

Provides an example of CSS code to define a custom font using @font-face. Users need to replace placeholders with their specific font name, path, and filenames. It also mentions removing unnecessary font format declarations.

```css
@font-face {
font-family: 'Futura-Boo';
src: url('/resources/Fonts/Futura-Boo/372C70_0_0.woff2') format('woff2'),
url('/resources/Fonts/Futura-Boo/372C70_0_0.woff') format('woff'),
url('/resources/Fonts/Futura-Boo/372C70_0_0.ttf') format('truetype');
}
```

--------------------------------

### Add 'ShowOnHome' Setting to SettingsLayout.cfg

Source: https://gethelp.wildapricot.com/en/articles/470-adding-settings-to-breadcrumb-gadgets

This XML snippet demonstrates adding a new setting named 'ShowOnHome' to the SettingsLayout.cfg file. This setting controls the visibility of the breadcrumbs gadget on the home page and defines its title and alignment.

```xml
<Section title="New Settings"> <Control settingName="ShowOnHome" title="Show gadget on home page" titlePosition="Left" titleWidth="247"/> </Section>
```

--------------------------------

### Configure DKIM Record for Email Authentication

Source: https://gethelp.wildapricot.com/en/articles/545-custom-domain-setup

A DKIM record is a CNAME record used to authenticate outgoing emails, reducing spam classification. This setup associates your domain with a specific DKIM service. The 'Name' typically includes '_domainkey' and the 'Value' points to the DKIM provider.

```DNS
Name: default._domainkey.{yourdomainname}
Value: dkim.wildapricot.org
```

--------------------------------

### DNS CAA Record Example

Source: https://gethelp.wildapricot.com/en/articles/555-securing-custom-domains

An example of a Certification Authority Authorization (CAA) record configuration for DNS. This record specifies which certificate authorities are authorized to issue certificates for a domain, enhancing security by preventing unauthorized issuance. The 'letsencrypt.org' domain must be included as the authorized authority for WildApricot websites.

```dns
Name: {yourdomainname}
Tag: issue
Flag: 0
Domain: letsencrypt.org
```
Tokens:
Raw