• API Overview
  • Getting Started
  • API Authorization
  • API Resources
  • Help
Sections
  • Account
  • AccountingPackage
  • Adjustment
  • AdjustmentType
  • AffCodeType
  • Affiliation
  • ApiTest
  • Arb
  • ArticleType
  • Auth
  • AuthTest
  • AutoRevCalc
  • BannerAd
  • Batch
  • Benefit
  • BenefitType
  • Bigcommerce
  • Billing
  • BoardEffect
  • CardConnect
  • CardOnFile
  • CcGateway
  • CertificationActivity
  • CertificationActivitySource
  • CertificationType
  • CivicData
  • ClassType
  • ClickLog
  • Cloudflare
  • Committee
  • CommitteeMeeting
  • CommitteeMeetingAttendee
  • CommitteeMember
  • CommitteeType
  • CommunicationQueue
  • Communicator
  • Config
  • ConfigSetting
  • Contact
  • ContactType
  • Coupon
  • CQRollCall
  • CreditType
  • Dashboard
  • Data
  • DataQuery
  • Dert
  • DropMember
  • Email
  • Entity
  • Environment
  • EPayment
  • Event
  • EventItemCustomField
  • EventPaymentMethod
  • EventSubmission
  • EventType
  • ExceptionLogger
  • ExternalSystemMap
  • Feature
  • FeatureToggle
  • FileSystem
  • Form
  • FormElement
  • FormElementType
  • FormTemplate
  • FormV2
  • FormV2Response
  • GlobalSettings
  • Guid
  • HealthCheck
  • Image
  • Informz
  • Invoice
  • InvoiceImport
  • JoinForm
  • License
  • Listing
  • Log
  • MailChimp
  • MemberActivity
  • Membership
  • MembershipLevel
  • MembershipLevelProcessingManager
  • MemberSource
  • MessageDraft
  • NewMember
  • NewsArticle
  • Notification
  • OptionalRevenueItem
  • PaymentSource
  • PaymentType
  • PaymenType
  • PlatformAuth
  • ProductLicense
  • Profile
  • ProfileAccessGuid
  • ProfileAdvancedSearch
  • ProfileCertificationType
  • ProfileChange
  • ProfileCustomField
  • ProfileImport
  • ProfileMerge
  • ProfileNotification
  • ProfilePermission
  • ProfilePortal
  • ProfileReferral
  • ProfileRelation
  • ProfileRestore
  • ProfileSearchAction
  • ProfileStatus
  • ProfileType
  • ProfileUpdateHT
  • ProfileUpdateHtV2
  • ProfileWidget
  • Project
  • ProjectTemplate
  • ProjectType
  • PromoCode
  • PublicForm
  • QuickBooksOnline
  • Receipt
  • Referral
  • Registration
  • RegistrationImport
  • RelationType
  • Report
  • Revenue
  • RevenueItem
  • Runtime
  • SalesOpportunity
  • SalesOpportunityLostReason
  • SalesOpportunityProbability
  • SalesOpportunitySource
  • Security
  • SecurityIdentityServer
  • Session
  • Settings
  • Task
  • TaskScheduler
  • TaskType
  • Tax
  • Template
  • Test
  • TestDataContext
  • Token
  • Transaction
  • UnappliedPayment
  • UrlShortener
  • User
  • UserAuth
  • UserRole
  • VerticalHba
  • VerticalNaa
  • VoterVoice
  • WebContent
  • WebContentType
  • Weebly
  • Wlc
  1. Home
  2. API Resources
  3. Membership

API Resources

Membership

APIDescription
GET Membership/GetMemberTypes

Gets all member types in the database.

GET Membership/{profileId}/MemberTypeIconColor

get selected Member Type icon color

GET Membership/MemberTypeIconColor?ProfileStatus={ProfileStatus}

get icon color for given ProfileStatus ie: Membership/MemberTypeIconColor?ProfileStatus=My+Status

GET Membership/GetMemberActivityTypes

Gets all member activity types in the database.

GET Membership/MemberActivityTypes

Gets all member activity types in the database.

POST Membership/MemberActivityTypes

No documentation available.

GET Membership/MemberActivityType/{id}

No documentation available.

PUT Membership/MemberActivityType/{id}

No documentation available.

DELETE Membership/MemberActivityType/{id}

No documentation available.

GET Membership/MemberActivityTypes/DropCodes

Gets all member activity drop codes in the database.

GET Membership/MembersForDrop

Gets members eligible for dropping.

GET Membership/MembersToDrop?ignoreIds[0]={ignoreIds[0]}&ignoreIds[1]={ignoreIds[1]}

Gets members eligible for dropping.

GET Membership/MembersForDrop/Csv?ignoreIds[0]={ignoreIds[0]}&ignoreIds[1]={ignoreIds[1]}

Gets the members eligible for dropping in a csv format.

GET Membership/MembersToDrop/Csv?ignoreIds[0]={ignoreIds[0]}&ignoreIds[1]={ignoreIds[1]}

Gets the members eligible for dropping in a csv format.

POST Membership/MembersToDrop/Export

No documentation available.

GET Membership/MembersForDrop/Count

Gets count of members eligible for dropping.

GET Membership/MemberArchive?startDate={startDate}&endDate={endDate}

Searches the member archive for a given date range

DELETE Membership/{id}?settingBatch={settingBatch}

No documentation available.

DELETE Membership/{profileId}/Entity?settingBatch={settingBatch}

Drop profile from entity. The UI prompts the user to add a member activity, so it's disabled for this endpoint.

DELETE Membership/Batch?ids[0]={ids[0]}&ids[1]={ids[1]}&settingBatch={settingBatch}

No documentation available.

POST Membership/{id}/UndropMemberArchive

Reinstates a member determined by a member archive id provided.

PUT Membership/UndropMemberArchives

Reinstates a member determined by a member archive id provided.

GET Membership/{id}/MemberSince

No documentation available.

MembershipLevel

APIDescription
GET MembershipLevels

Search

GET MembershipLevels/Profiles

Search for profiles and their membership levels

POST MembershipLevels

Create

GET MembershipLevel/{id}

Get

PUT MembershipLevel/{id}

Update

PUT MembershipLevel/{id}/UpdateProfiles

Update Membership Level and related profiles

POST MembershipLevel/{id}/AssignToProfiles

Trigger assign given profiles to the given level

DELETE MembershipLevel/{id}

Delete

POST MembershipLevel/ApplyFormulaChanges

Trigger profile membership level changes using the auto assign formula

POST MembershipLevel/MembershipLevelSetting

save settings for member level management

POST MembershipLevel/{settingBatch}/MembershipLevelSetting

save settings for member level management

GET MembershipLevel/Profile/{profileId}/AssignedAffCodesFromRelatedProfileMembershipLevels

get affcodes assingned to the profile that were given to it based on primary related member profiles' membership level's related-profile-aff-code setting.

PUT MembershipLevel/ProfileRelation/UpdateRelatedAffCodes

update related affcodes based on membership leve and primary relation.

GET MembershipLevel/RelationType/{newRelationTypeId}/RelatedProfileAffCodesToDrop?mainProfileId={mainProfileId}&relProfileId={relProfileId}

When dropping or changing a relationship with , this method returns what related aff codes, if any, should be removed from the given . This is a one-off method. Don't use this for processing many changes at once as it can be expensive to load aff codes and relation types over and over.

MembershipLevelProcessingManager

APIDescription
GET MembershipLevelProcesses

Search

GET MembershipLevelProcess/IsProcessRunning

checks to see if any process is currently running

GET MembershipLevelProcess/CurrentState

get all running or last finished

POST MembershipLevelProcess/ResumePending

resumes pending processes starting with the first

GET MembershipLevelProcess/ResumePending

No documentation available.