Klaviyo · Schema
SegmentMemberResponseObjectResource
MarketingEmailSMSCustomer DataEcommerceAutomation
Properties
| Name | Type | Description |
|---|---|---|
| type | object | |
| id | string | Primary key that uniquely identifies this profile. Generated by Klaviyo. |
| attributes | object | |
| relationships | object | |
| links | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/SegmentMemberResponseObjectResource",
"title": "SegmentMemberResponseObjectResource",
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ProfileEnum"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"type": "string",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true
},
"attributes": {
"type": "object",
"properties": {
"email": {
"description": "Individual's email address",
"type": "string",
"example": "[email protected]",
"nullable": true
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"type": "string",
"example": "+15005550006",
"nullable": true
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"type": "string",
"nullable": true
},
"first_name": {
"description": "Individual's first name",
"type": "string",
"example": "Sarah",
"nullable": true
},
"last_name": {
"description": "Individual's last name",
"type": "string",
"example": "Mason",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"type": "string",
"example": "Example Corporation",
"nullable": true
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"type": "string",
"example": "en-US",
"nullable": true
},
"title": {
"description": "Individual's job title",
"type": "string",
"example": "Regional Manager",
"nullable": true
},
"image": {
"description": "URL pointing to the location of a profile image",
"type": "string",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true
},
"created": {
"description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"updated": {
"description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"last_event_date": {
"description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"type": "object",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true
},
"joined_group_at": {
"description": "The datetime when this profile most recently joined the segment.",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
}
},
"required": [
"joined_group_at"
]
},
"relationships": {
"type": "object",
"properties": {
"lists": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/ListEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"segments": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/SegmentEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"push-tokens": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"attributes",
"links"
]
}