Appcues

opencollection: 1.0.0
info:
  name: Appcues Public API
  version: '2.0'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Flows
    type: folder
  items:
  - info:
      name: List flows
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/flows
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List flows
  - info:
      name: Get a flow
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/flows/:flow_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: flow_id
        value: ''
        type: path
    docs: Get a flow
  - info:
      name: Publish a flow
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/flows/:flow_id/publish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: flow_id
        value: ''
        type: path
    docs: Publish a flow
  - info:
      name: Unpublish a flow
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/flows/:flow_id/unpublish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: flow_id
        value: ''
        type: path
    docs: Unpublish a flow
- info:
    name: Segments
    type: folder
  items:
  - info:
      name: List segments
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/segments
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List segments
  - info:
      name: Create a segment
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/segments
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: Create a segment
  - info:
      name: Get a segment
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/segments/:segment_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: segment_id
        value: ''
        type: path
    docs: Get a segment
  - info:
      name: Update a segment
      type: http
    http:
      method: PATCH
      url: https://api.appcues.com/v2/accounts/:account_id/segments/:segment_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: segment_id
        value: ''
        type: path
    docs: Update a segment
  - info:
      name: Delete a segment
      type: http
    http:
      method: DELETE
      url: https://api.appcues.com/v2/accounts/:account_id/segments/:segment_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: segment_id
        value: ''
        type: path
    docs: Delete a segment
  - info:
      name: Add users to a segment
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/segments/:segment_id/add_user_ids
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: segment_id
        value: ''
        type: path
    docs: Add users to a segment
  - info:
      name: Remove users from a segment
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/segments/:segment_id/remove_user_ids
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: segment_id
        value: ''
        type: path
    docs: Remove users from a segment
  - info:
      name: Export segment membership
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/segments/:segment_id/segment_membership_export
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: segment_id
        value: ''
        type: path
    docs: Export segment membership
- info:
    name: Tags
    type: folder
  items:
  - info:
      name: List tags
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/tags
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List tags
  - info:
      name: Get a tag
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/tags/:tag_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: tag_id
        value: ''
        type: path
    docs: Get a tag
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Get user profile
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/users/:user_id/profile
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: user_id
        value: ''
        type: path
        description: End-user identifier
    docs: Get user profile
  - info:
      name: Update user profile
      type: http
    http:
      method: PATCH
      url: https://api.appcues.com/v2/accounts/:account_id/users/:user_id/profile
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: user_id
        value: ''
        type: path
        description: End-user identifier
    docs: Update user profile
  - info:
      name: Delete user profile
      type: http
    http:
      method: DELETE
      url: https://api.appcues.com/v2/accounts/:account_id/users/:user_id/profile
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: user_id
        value: ''
        type: path
        description: End-user identifier
    docs: Delete user profile
- info:
    name: Events
    type: folder
  items:
  - info:
      name: List user events
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/users/:user_id/events
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: user_id
        value: ''
        type: path
        description: End-user identifier
    docs: List user events
  - info:
      name: Track user event
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/users/:user_id/events
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: user_id
        value: ''
        type: path
        description: End-user identifier
    docs: Track user event
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: Get group profile
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/groups/:group_id/profile
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: group_id
        value: ''
        type: path
        description: Group identifier
    docs: Get group profile
  - info:
      name: Update group profile
      type: http
    http:
      method: PATCH
      url: https://api.appcues.com/v2/accounts/:account_id/groups/:group_id/profile
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: group_id
        value: ''
        type: path
        description: Group identifier
    docs: Update group profile
  - info:
      name: Update group users
      type: http
    http:
      method: PATCH
      url: https://api.appcues.com/v2/accounts/:account_id/groups/:group_id/users
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: group_id
        value: ''
        type: path
        description: Group identifier
    docs: Update group users
- info:
    name: Imports
    type: folder
  items:
  - info:
      name: Bulk import user profiles
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/import/profiles
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: Bulk import user profiles
  - info:
      name: Bulk import groups
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/import/groups
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: Bulk import groups
  - info:
      name: Bulk import events
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/import/events
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: Bulk import events
- info:
    name: Exports
    type: folder
  items:
  - info:
      name: Bulk export events
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/export/events
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: Bulk export events
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: List offline jobs
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/jobs
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List offline jobs
  - info:
      name: Get an offline job
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/jobs/:job_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: job_id
        value: ''
        type: path
    docs: Get an offline job
- info:
    name: Pins
    type: folder
  items:
  - info:
      name: List pins
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/pins
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List pins
  - info:
      name: Get a pin
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/pins/:pin_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: pin_id
        value: ''
        type: path
    docs: Get a pin
  - info:
      name: Publish a pin
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/pins/:pin_id/publish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: pin_id
        value: ''
        type: path
    docs: Publish a pin
  - info:
      name: Unpublish a pin
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/pins/:pin_id/unpublish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: pin_id
        value: ''
        type: path
    docs: Unpublish a pin
- info:
    name: Mobile
    type: folder
  items:
  - info:
      name: List mobile experiences
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/mobile
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List mobile experiences
  - info:
      name: Get a mobile experience
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/mobile/:mobile_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: mobile_id
        value: ''
        type: path
    docs: Get a mobile experience
  - info:
      name: Publish a mobile experience
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/mobile/:mobile_id/publish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: mobile_id
        value: ''
        type: path
    docs: Publish a mobile experience
  - info:
      name: Unpublish a mobile experience
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/mobile/:mobile_id/unpublish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: mobile_id
        value: ''
        type: path
    docs: Unpublish a mobile experience
- info:
    name: Launchpads
    type: folder
  items:
  - info:
      name: List launchpads
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/launchpads
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List launchpads
  - info:
      name: Get a launchpad
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/launchpads/:launchpad_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: launchpad_id
        value: ''
        type: path
    docs: Get a launchpad
  - info:
      name: Publish a launchpad
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/launchpads/:launchpad_id/publish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: launchpad_id
        value: ''
        type: path
    docs: Publish a launchpad
  - info:
      name: Unpublish a launchpad
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/launchpads/:launchpad_id/unpublish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: launchpad_id
        value: ''
        type: path
    docs: Unpublish a launchpad
- info:
    name: Banners
    type: folder
  items:
  - info:
      name: List banners
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/banners
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
    docs: List banners
  - info:
      name: Get a banner
      type: http
    http:
      method: GET
      url: https://api.appcues.com/v2/accounts/:account_id/banners/:banner_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: banner_id
        value: ''
        type: path
    docs: Get a banner
  - info:
      name: Publish a banner
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/banners/:banner_id/publish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: banner_id
        value: ''
        type: path
    docs: Publish a banner
  - info:
      name: Unpublish a banner
      type: http
    http:
      method: POST
      url: https://api.appcues.com/v2/accounts/:account_id/banners/:banner_id/unpublish
      params:
      - name: account_id
        value: ''
        type: path
        description: Appcues account identifier
      - name: banner_id
        value: ''
        type: path
    docs: Unpublish a banner
bundled: true