Skip to content

Developers

Mostly about Wild Apricot API. Feel free to share examples of your code!

88 results found

  1. Contacts API: filter non-members

    How do I access non-members using the Contacts API. I have already tried '&$filter=Member ne true' but that seems to just return a list of all the contacts including members that have a membership associated to their account.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  2. Contact API Returns Dataset or Status

    Sometimes the v2.2 API calls (done via API token and auth built on the PHP class from your sampleApplication.php on GitHub) to get a specific Contact returns the user's fieldset, and sometimes it returns an object with a State of either 'Waiting' or 'Complete'.

    I've tried adding ?$async=false but it doesn't seem to change anything. Matter of fact, when I added $async=false&$select='First name','Last name' (as mentioned here in the forums, previously) I got a 400 bad request.

    It seems like sometimes the API kicks butt and returns everything I need instantly, but other times it sends a Status of either…

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    3 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  3. Batch request does not support member api ?

    Tried below payload

    [
    {
    "Id": "profile",
    "Order": 0,
    "PathAndQuery": "/v2.2/accounts/{{accountId}}/contacts",
    "Method": "GET"
    },
    ]

    But get this response

    [
    {
    "RequestId": "profile",
    "HttpStatusCode": 400,
    "HttpReasonPhrase": "Request path does not look like valid API request",
    "ResponseData": null
    }
    ]

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  4. How to map radio button or multiple choice field for add contact via api

    I have the contact form with different text box fields and radion buttons and multiple-choice values. i need to add these form entries in my Wild Apricot Contact list via API.

    I have mapped successfully string and single-line text fields. but not able to map the like radio button fields and checkbox fields. please can you help me out this? i am using node.js to send API requests.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    9 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  5. API Send Email - Cannot specify Reply to Address

    I have been able to create and send emails via the API using a POST to /rpc/{accountId}/email/SendEmail. However, I have not found a way to change the default reply to address (the default is support@wildapricot.com).
    Is there a way to specify a Reply To address similar to the option available when drafting an email on the website?
    Thanks, Paul

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  6. Custom field that a member can only view from a Wild Apricot restricted webpage using the API from JavaScript

    I would like the ability to create a membership database field that a logged-in member can view from a Wild Apricot restricted webpage using the API from JavaScript. Administrators with Membership manager access would be able to view and edit this field.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    21 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  7. Deactivate

    I would like to be able to deactivate a member through the API. Deactivating a pending membership is possible through /rpc/{accountId}/RejectPendingMembership, but that doesn't seem to be intended for existing memberships.

    I tried sending a PUT to /rpc/Accounts/{accountId}/Contacts/{member_id} with 'MembershipEnabled: false', as well as setting FieldValues like "Member", "SuspendedMember", and "Membership enabled", but this returned a 400 error.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  8. Sending email via API

    I'm trying to use the send email API call - https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricot_public_api/2.1.0#/Emailing.Operations/SendEmail but not having any luck.

    I've tried from the API browser and via a Google Apps script. In both, I just get a 400 error.

    I'm POSTing to https://api.wildapricot.org/v2.1/rpc/<ACCOUNT>/email/sendemail, with this as my body:
    {
    "Subject": "test email",
    "Body": "test email",
    "Recipients": [
    {
    "Id": 0,
    "Type": "IndividualRecipient",
    "Name": "test",
    "Email": "<HIDDEN>"
    }
    ],
    "EventId": <EVENTID>
    }

    (account, email and event id have been hidden). Each time, I get a 400 error: Parameter is required: EmailDraftParam.
    The swagger documentation doesn't mention a "EmailDraftParam". What am I doing wrong?

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    6 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  9. Single Sign On Very simple Ruby on Rails snippet

    Hello,
    I have been able to implement bare bones Wild Apricot single sign on steps in a blank Ruby on Rails project, thanks to Wild Apricot support! Please find attached a redacted and commented version of the code here for anyone who is trying to do similar with their own custom web app. This snippet prints out the ID of the user who is signed in.
    Cheers!

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  10. Event creation via API cannot set all fields

    I am creating Events using the API and cannot see how the following fields can be set (I can set these as an Administrator in the website) .....

    Show registrants who want to be listed
    to everyone
    to members only
    Include pending registrations

    Also I cannot see how the schedule for email announcements and reminders for an Event can be set via the API?

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    3 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    Team Mobile responded

    Status update in case someone new will see this topic:
    The section “Show registrants who want to be listed” have been added to API already.

    Schedule for email announcements and reminders can’t be set via API at the moment.

    As a workaround, you could create a template event on the web, set the start date in the distant future and all settings you need. Then you can clone it via POST request:
    api.wildapricot.org/v2/rpc{AccountId}/CloneEvent
    The request body should be like this:
    {“EventId”: 123456}

  11. Nicasio Design APP

    We are getting very close to launching a comprehensive member facing APP which will allow members to:
    1- download the APP
    2- Login or Register to your org
    3- View and Register to events
    4- Edit their profiles
    5- Browse member directory

    Stand by for updates!

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  12. API v2 Events - AccessLevel and Sorting

    Hi,

    I'm using the API v2 to extract Events for a custom event list in another site. So far, the API is working.

    I can get a list of event objects, but they seem to be in the order in which they were entered, not in the order of their dates! (date order should be the default sort, IMHO) Is there a way I can specify the sort order in the request URL?

    Also, the API returns ALL events regardless of access level: is there a way to restrict the returned set to be just public events?

    Thanks.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    3 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  13. CERTIFICATE_VERIFY_FAILED

    Hi
    I am trying to authenticate with contact credentials via https://oauth.wildapricot.org/auth/token

    A few days ago, this was working, but now the same code gives this error:

    SSL: CERTIFICATEVERIFYFAILED] certificate verify failed: self signed certificate in certificate chain

    Any ideas?
    thanks
    Angus

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  14. Access the URL for file attachments, after retrieving the "data-resource-id" string.

    Currently Make (Integromat) can access members and get the "data-resource-id" string. We need to get the URL for the file also so we can download the file.

    <li class="linksContainerLi" data-resource-id="717587" data-resource-name="TN_Payments-Breakdown_created-2-24-2023_35297767.xlsx" id="id717587">
    <a class="fileName" target="_blank" href="https://combinebh.org/resources/document/uTljNHN_T9II2VPclRSi4cGDjp-nxg9i6QEHVACDQ1pJhLHvIR4skYXFUd-grJCMcUeXEyAwr6NCl7iddFPFEA2">TNPayments-Breakdowncreated-2-24-2023_35297767.xlsx</a>
    <span class="fileSize">(17.43 KB)</span>
    </li>

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  15. Bulk upload profile pictures and company logos

    We have about 2,000 members that we are migrating from a previous membership management system. Importing member profile data has been easy. But we can't see a way to import the images for their profile avatars and company logos. I can see that there is a "Pictures" API call to upload image files but I don't see a way to associate the uploaded pictures with either the member's profile avatar to organization logo.

    Seems like this would be a really common need for migrations. Perhaps there is a plugin or script that already does this? If not, we could write…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  16. Adding waLoginBox to another site no longer supported because of the reCaptcha

    Logging into Wild Apricot from an external site using the steps outlined in this wild apricot article seems to be no longer supported as of Version 7.27 or higher. Is this something that Wild Apricot will add support for? Or can the api be updated to allow users to login to their account (similar to sso), as I need to allow my users ability to log into 2+ sites using their wild apricot credentials and they need to be able to go to Wild Apricot and not have to login again.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  17. $filter contacts from ID

    Does anyone have an idea on how to filter and display a list of contacts from a specific ID? I've tried Id gt 67814009.

    Seems this might not be supported. Does anyone have a solution or creative workaround?

    {"code":"Search","message":"Operator GreaterThan is not supported for attribute User ID"}

    API: https://api.wildapricot.org/v2/accounts/{account_id}/contacts

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  18. OAuth SSO - Cannot get token

    I'm trying to generate a token but I always get a "HTTP/1.1 400 Bad Request"

    curl -v --data '' --request POST \
    --url "https://oauth.wildapricot.org/auth/token?client_id=myapps&grant_type=authorization_code&code=bbd4170f875d16b6124e82e4a336f70&scope=contacts_me&redirect_uri=http%3A%2F%2Flocalhost%3A8080" \
    --header 'Authorization: Basic aHBzY2cDp1OHR0NWU1OWpoc2Y1bmNrcjNvcjhyNnR0eHFhNng=' \
    --header 'Content-Type: application/x-www-form-urlencoded'

    --data '' is used to set "Content-Type: 0", if its not included I get a 413 error

    Is there something wrong with my curl that i provided?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  19. Support Coupon Code for Membership Application Non-Admin API

    In the Non-Admin API, the "rpc/{accountId}/ApplyForRenewal" call, the API documentation shows that a "Coupon Code" can be submitted as part of the body of the request. The "rpc/{accountId}/applyForMembership" call does not show a "Coupon Code" in the documentation.

    Is it supported? If yes, how should the request be formatted? If it is not supported, is there an alternate way to add a discount code to a membership invoice via API?

    I have tried the following JSON body. It successfully creates a pending membership with the correct Level, but the discount code is ignored. (no error, it is just ignored). The…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  20. Payment and invoice allocation

    I have posted some payments via the payments API with the following JSON:
    {
    "Value": 0.65,
    "DocumentDate": "2022-12-18",
    "Invoices": [ {"id": 002049} ],
    "Tender": {"id": 1038048},
    "Contact": {"id": 12345678},
    "Comment": "Test Payment to allocate to invoice",
    "PaymentType": "InvoicePayment"
    }
    The invoice number is correct (and has to be 0 justified otherwise the API fails), the payment is correctly entered in Wild Apricot but the response returns <AllocatedValue>0.0000</AllocatedValue>
    As a result, the payment needs to be manually settled in Wild Apricot against that same invoice.
    I expected the provision of the invoice number would automatically settle the payment. Did I miss…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  • Don't see your idea?

Developers

Categories

Feedback and Knowledge Base