Directory API: Groups
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
200
OK
post
/api/directory/groups/collect200
OK
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
200
OK
post
/api/directory/groups/count200
OK
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
200
OK
No content
post
/api/directory/groups/download200
OK
No content
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
200
OK
post
/api/directory/groups/search200
OK
Last updated
Was this helpful?