GetSegmentMembership
Determines if the given profiles are within a segment.
Request Syntax
POST /domains/DomainName/segments/SegmentDefinitionName/membership HTTP/1.1
Content-type: application/json
{
"ProfileIds": [ "string" ]
}URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$Required: Yes
- SegmentDefinitionName
-
The Id of the wanted segment. Needs to be a valid, and existing segment Id.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$Required: Yes
Request Body
The request accepts the following data in JSON format.
- ProfileIds
-
The list of profile IDs to query for.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern:
[a-f0-9]{32}Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Failures": [
{
"Message": "string",
"ProfileId": "string",
"Status": number
}
],
"Profiles": [
{
"Profile": {
"AccountNumber": "string",
"AdditionalInformation": "string",
"Address": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"Country": "string",
"County": "string",
"PostalCode": "string",
"Province": "string",
"State": "string"
},
"Attributes": {
"string" : "string"
},
"BillingAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"Country": "string",
"County": "string",
"PostalCode": "string",
"Province": "string",
"State": "string"
},
"BirthDate": "string",
"BusinessEmailAddress": "string",
"BusinessName": "string",
"BusinessPhoneNumber": "string",
"EmailAddress": "string",
"FirstName": "string",
"FoundByItems": [
{
"KeyName": "string",
"Values": [ "string" ]
}
],
"Gender": "string",
"GenderString": "string",
"HomePhoneNumber": "string",
"LastName": "string",
"MailingAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"Country": "string",
"County": "string",
"PostalCode": "string",
"Province": "string",
"State": "string"
},
"MiddleName": "string",
"MobilePhoneNumber": "string",
"PartyType": "string",
"PartyTypeString": "string",
"PersonalEmailAddress": "string",
"PhoneNumber": "string",
"ProfileId": "string",
"ShippingAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"Country": "string",
"County": "string",
"PostalCode": "string",
"Province": "string",
"State": "string"
}
},
"ProfileId": "string",
"QueryResult": "string"
}
],
"SegmentDefinitionName": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Failures
-
An array of maps where each contains a response per profile failed for the request.
Type: Array of ProfileQueryFailures objects
- Profiles
-
An array of maps where each contains a response per profile requested.
Type: Array of ProfileQueryResult objects
- SegmentDefinitionName
-
The unique name of the segment definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- InternalServerException
-
An internal service error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource does not exist, or access was denied.
HTTP Status Code: 404
- ThrottlingException
-
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
