# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Contacts API
  version: 1.0.0
extends: openapi/getresponse-contacts-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: 11
- target: $.paths['/contacts/{contactId}/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List a contact's recent activities
      effect: read
      questions:
      - What has a particular contact opened or clicked recently?
      - Can I see a contact's activity older than the last 14 days?
      instructions:
      - text: Show recent activity for contact {contact}.
        slots:
          contact: path.contactId
      - text: List activities of contact {contact} from {from} to {to}.
        slots:
          contact: path.contactId
          from: query.query[createdOn][from]
          to: query.query[createdOn][to]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contacts on one list
      effect: read
      questions:
      - Who is subscribed to one specific contact list?
      - Can I find a subscriber by email within a single list?
      instructions:
      - text: List the contacts on list {campaign}.
        slots:
          campaign: path.campaignId
      - text: Find contacts with email {email} on list {campaign}.
        slots:
          email: query.query[email]
          campaign: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/{contactId}/custom-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update a contact's custom fields
      effect: write
      questions:
      - Can I set custom field values on a contact without wiping the others?
      - What's the way to add a custom field value to just one subscriber?
      instructions:
      - text: Set custom field values {values} on contact {contact}.
        slots:
          values: requestBody.customFieldValues
          contact: path.contactId
      - text: Add or update custom fields on contact {contact} without removing existing ones.
        slots:
          contact: path.contactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/{contactId}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tags to a contact
      effect: write
      questions:
      - How do I tag a subscriber without losing the tags they already have?
      - Can I attach several tags to a contact in one call?
      instructions:
      - text: Add tags {tags} to contact {contact}.
        slots:
          tags: requestBody.tags
          contact: path.contactId
      - text: Tag contact {contact} while keeping its current tags.
        slots:
          contact: path.contactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/{contactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact's details
      effect: read
      questions:
      - What information is stored about one particular subscriber?
      - Can I look up a contact's tags and custom fields by their ID?
      instructions:
      - text: Get the details of contact {contact}.
        slots:
          contact: path.contactId
      - text: Show only {fields} for contact {contact}.
        slots:
          fields: query.fields
          contact: path.contactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/{contactId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a contact's details
      effect: write
      questions:
      - Can I change a subscriber's name or move them to another list?
      - Does updating a contact replace their existing tags and custom fields?
      instructions:
      - text: Rename contact {contact} to {name}.
        slots:
          contact: path.contactId
          name: requestBody.name
      - text: Replace the tags on contact {contact} with {tags}.
        slots:
          contact: path.contactId
          tags: requestBody.tags
      - text: Add note {note} to contact {contact}.
        slots:
          note: requestBody.note
          contact: path.contactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/{contactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact
      effect: destructive
      questions:
      - How do I permanently remove a subscriber from my account?
      - Can I record the message or IP address that triggered an unsubscribe when deleting a contact?
      instructions:
      - text: Delete contact {contact}.
        slots:
          contact: path.contactId
      - text: Remove contact {contact}, attributing it to message {message}.
        slots:
          contact: path.contactId
          message: query.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search contacts across all lists
      effect: read
      questions:
      - Which contacts across my whole account match a given email?
      - Can I find contacts that changed recently or came from a certain origin?
      - What contacts were added in a date range, sorted by newest?
      instructions:
      - text: Find all contacts with email {email}.
        slots:
          email: query.query[email]
      - text: List contacts created between {from} and {to} across every list.
        slots:
          from: query.query[createdOn][from]
          to: query.query[createdOn][to]
      - text: Show contacts that came from origin {origin}.
        slots:
          origin: query.query[origin]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new contact to a list
      effect: write
      questions:
      - How can I add a single new subscriber to a list?
      - Can I set tags and custom fields while creating a contact?
      instructions:
      - text: Add {email} to list {campaign}.
        slots:
          email: requestBody.email
          campaign: requestBody.campaign
      - text: Create contact {name} with email {email} on list {campaign}.
        slots:
          name: requestBody.name
          email: requestBody.email
          campaign: requestBody.campaign
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many contacts in one request
      effect: write
      questions:
      - Can I import a bunch of contacts in one call instead of one at a time?
      - What throttling limits apply to bulk contact creation?
      instructions:
      - text: Add these contacts {contacts} to list {campaign} in one batch.
        slots:
          contacts: requestBody.contacts
          campaign: requestBody.campaignId
      - text: Bulk create contacts on list {campaign}.
        slots:
          campaign: requestBody.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/{contactId}/consents'].get
  update:
    x-apievangelist-phrasing:
      intent: View a contact's consent fields
      effect: read
      questions:
      - Has a given subscriber given marketing consent, and when did it change?
      - Where can I see the consent history for one contact?
      instructions:
      - text: Show consent fields for contact {contact}.
        slots:
          contact: path.contactId
      - text: Check the consent status history of contact {contact}.
        slots:
          contact: path.contactId
      method: generated
      generated: '2026-09-26'