Get Segment Membership

customerprofiles_get_segment_membership

R Documentation

Determines if the given profiles are within a segment

Description

Determines if the given profiles are within a segment.

Usage

customerprofiles_get_segment_membership(DomainName,
  SegmentDefinitionName, ProfileIds)

Arguments

DomainName

[required] The unique name of the domain.

SegmentDefinitionName

[required] The Id of the wanted segment. Needs to be a valid, and existing segment Id.

ProfileIds

[required] The list of profile IDs to query for.

Value

A list with the following syntax:

list(
  SegmentDefinitionName = "string",
  Profiles = list(
    list(
      ProfileId = "string",
      QueryResult = "PRESENT"|"ABSENT",
      Profile = list(
        ProfileId = "string",
        AccountNumber = "string",
        AdditionalInformation = "string",
        PartyType = "INDIVIDUAL"|"BUSINESS"|"OTHER",
        BusinessName = "string",
        FirstName = "string",
        MiddleName = "string",
        LastName = "string",
        BirthDate = "string",
        Gender = "MALE"|"FEMALE"|"UNSPECIFIED",
        PhoneNumber = "string",
        MobilePhoneNumber = "string",
        HomePhoneNumber = "string",
        BusinessPhoneNumber = "string",
        EmailAddress = "string",
        PersonalEmailAddress = "string",
        BusinessEmailAddress = "string",
        Address = list(
          Address1 = "string",
          Address2 = "string",
          Address3 = "string",
          Address4 = "string",
          City = "string",
          County = "string",
          State = "string",
          Province = "string",
          Country = "string",
          PostalCode = "string"
        ),
        ShippingAddress = list(
          Address1 = "string",
          Address2 = "string",
          Address3 = "string",
          Address4 = "string",
          City = "string",
          County = "string",
          State = "string",
          Province = "string",
          Country = "string",
          PostalCode = "string"
        ),
        MailingAddress = list(
          Address1 = "string",
          Address2 = "string",
          Address3 = "string",
          Address4 = "string",
          City = "string",
          County = "string",
          State = "string",
          Province = "string",
          Country = "string",
          PostalCode = "string"
        ),
        BillingAddress = list(
          Address1 = "string",
          Address2 = "string",
          Address3 = "string",
          Address4 = "string",
          City = "string",
          County = "string",
          State = "string",
          Province = "string",
          Country = "string",
          PostalCode = "string"
        ),
        Attributes = list(
          "string"
        ),
        FoundByItems = list(
          list(
            KeyName = "string",
            Values = list(
              "string"
            )
          )
        ),
        PartyTypeString = "string",
        GenderString = "string"
      )
    )
  ),
  Failures = list(
    list(
      ProfileId = "string",
      Message = "string",
      Status = 123
    )
  )
)

Request syntax

svc$get_segment_membership(
  DomainName = "string",
  SegmentDefinitionName = "string",
  ProfileIds = list(
    "string"
  )
)