# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Mapp Engage public Profile Attributes API version: 1.0.0 extends: openapi/mapp-profile-attributes-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 14 - target: $.paths['/profileAttributes/archive'].post update: x-apievangelist-phrasing: intent: Archive profile attributes effect: write questions: - Can I retire profile attributes we no longer use without deleting them? - What happens to a profile attribute once it's archived? instructions: - text: Archive the profile attributes I list here. - text: Move our unused loyalty profile attributes into the archive. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/create'].post update: x-apievangelist-phrasing: intent: Create a profile attribute effect: write questions: - How do I add a new custom field to every contact's profile? - Can I define a new date-type profile attribute for birthdays? instructions: - text: Create a new profile attribute called FavoriteStore of type string. - text: Add a custom profile attribute for customer tier. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/get'].get update: x-apievangelist-phrasing: intent: Get one profile attribute definition effect: read questions: - What data type and settings does a specific profile attribute have? - Can I look up a single profile attribute definition by its ID? instructions: - text: Show the definition of profile attribute {attributeId}. slots: attributeId: query.attributeId - text: Get the settings for profile attribute ID {attributeId}. slots: attributeId: query.attributeId method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/getAvailableChannels'].get update: x-apievangelist-phrasing: intent: List channels a profile attribute can be assigned to effect: read questions: - Which channels can I assign a profile attribute to? - What channel options exist when scoping a profile attribute? instructions: - text: List the channels available for profile attribute assignment. - text: Show me which channels I can attach attributes to. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/getMarked'].get update: x-apievangelist-phrasing: intent: Get recipient statistics attribute settings effect: read questions: - Which profile attributes are currently flagged for recipient statistics? - What are our recipient statistic settings right now? instructions: - text: Show which profile attributes are marked for recipient statistics. - text: Get the current recipient statistic settings. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/getCapacity'].get update: x-apievangelist-phrasing: intent: Check remaining profile attribute capacity effect: read questions: - How many more profile attributes of each data type can I still create? - Are we running out of room for new numeric profile attributes? instructions: - text: Show the remaining profile attribute capacity per data type. - text: Check how many more string attributes we can add. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/getTechnical'].get update: x-apievangelist-phrasing: intent: List technical system attributes effect: read questions: - What built-in system attributes does every profile have? - Which technical attributes are managed by the platform rather than by us? instructions: - text: List the technical system attributes. - text: Show me the built-in platform attributes on profiles. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/list'].get update: x-apievangelist-phrasing: intent: List custom profile attributes effect: read questions: - Which custom profile attributes have we defined? - Can I include archived attributes when listing profile attributes? - Is it possible to see the allowed enum values alongside each attribute? instructions: - text: List all our profile attributes. - text: 'List profile attributes with archived set to {archived} and enum values included: {withEnums}.' slots: archived: query.archived withEnums: query.withEnums method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/markForStats'].post update: x-apievangelist-phrasing: intent: Include a profile attribute in recipient statistics effect: write questions: - How do I get a profile attribute to show up in recipient statistics? - Can I break recipient stats down by a custom attribute like region? instructions: - text: Mark attribute {attributeName} for recipient statistics. slots: attributeName: query.attributeName - text: Start tracking {attributeName} in recipient stats. slots: attributeName: query.attributeName method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/restore'].post update: x-apievangelist-phrasing: intent: Restore archived profile attributes effect: write questions: - Can I bring back a profile attribute I archived by mistake? - Is archiving a profile attribute reversible? instructions: - text: Restore these archived profile attributes. - text: Unarchive the profile attributes I list. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/export'].get update: x-apievangelist-phrasing: intent: Export profile attributes to CSV effect: read questions: - Can I download all profile attribute definitions as a CSV? - Does exporting profile attributes run in the background? instructions: - text: Start a CSV export of our profile attribute definitions. - text: Export the profile attribute list to CSV. method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/unmarkForStats'].post update: x-apievangelist-phrasing: intent: Remove a profile attribute from recipient statistics effect: write questions: - How do I stop a profile attribute from appearing in recipient statistics? - Can I drop an attribute from recipient stats without archiving it? instructions: - text: Unmark attribute {attributeName} from recipient statistics. slots: attributeName: query.attributeName - text: Stop tracking {attributeName} in recipient stats. slots: attributeName: query.attributeName method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/update'].put update: x-apievangelist-phrasing: intent: Update a profile attribute definition effect: write questions: - Can I rename or change the description of an existing profile attribute? - What settings of a profile attribute can be edited after creation? instructions: - text: Update profile attribute {attributeId} with the new settings. slots: attributeId: query.attributeId - text: Change the description of profile attribute {attributeId}. slots: attributeId: query.attributeId method: generated generated: '2026-09-26' - target: $.paths['/profileAttributes/validateName'].get update: x-apievangelist-phrasing: intent: Check a profile attribute name is available effect: read questions: - Is a profile attribute name already taken? - Can I check a new attribute name is unique before creating it? instructions: - text: Check whether profile attribute name {name} is unique. slots: name: query.name - text: Validate {name} as a new profile attribute name. slots: name: query.name method: generated generated: '2026-09-26'