arazzo: 1.0.1
info:
  title: Mailchimp Add Member and Attach a Note
  summary: Subscribe a member to an audience and attach an internal note to them.
  description: >-
    Captures context about a contact at the moment they are added. The workflow
    subscribes a member to an audience and then attaches an internal note to
    that member record, using the subscriber's email as the subscriber hash on
    the note call. Notes are visible to team members and useful for recording
    where a contact came from. Authentication uses HTTP Basic auth with any
    username and your Mailchimp API key as the password.
  version: 1.0.0
sourceDescriptions:
- name: mailchimpMarketingApi
  url: ../openapi/mailchimp-marketing-api-openapi.yml
  type: openapi
workflows:
- workflowId: add-member-note
  summary: Add a member and attach an internal note.
  description: >-
    Subscribes a member to the audience, then attaches an internal note to the
    member record.
  inputs:
    type: object
    required:
    - listId
    - emailAddress
    - note
    properties:
      listId:
        type: string
        description: The unique id for the audience/list.
      emailAddress:
        type: string
        description: Email address of the subscriber (also used as the subscriber hash).
      status:
        type: string
        description: Subscription status for the new member.
        default: subscribed
      note:
        type: string
        description: The content of the internal note to attach to the member.
  steps:
  - stepId: addMember
    description: Subscribe the member to the audience.
    operationId: postListsIdMembers
    parameters:
    - name: list_id
      in: path
      value: $inputs.listId
    requestBody:
      contentType: application/json
      payload:
        email_address: $inputs.emailAddress
        status: $inputs.status
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      memberId: $response.body#/id
  - stepId: addNote
    description: Attach an internal note to the member record.
    operationId: postListsIdMembersIdNotes
    parameters:
    - name: list_id
      in: path
      value: $inputs.listId
    - name: subscriber_hash
      in: path
      value: $inputs.emailAddress
    requestBody:
      contentType: application/json
      payload:
        note: $inputs.note
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      noteId: $response.body#/id
  outputs:
    memberId: $steps.addMember.outputs.memberId
    noteId: $steps.addNote.outputs.noteId