> ## Documentation Index
> Fetch the complete documentation index at: https://docs.altamiq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Affiliates

> Track affiliate and referral programs in AltamIQ, from adding and editing an affiliate to setting its type, status, links, and notes.

The Affiliate Programs page is where you keep track of every affiliate and referral program your team takes part in. From one screen you can add a new program, edit an existing one, record the product it relates to, set its type and status, save the important links, and jot down the terms in a notes field. This page walks you through all of it in plain language.

<Frame caption="The Affiliate Programs list, showing the type and status badges on each row">
  <img src="https://mintcdn.com/altamiq/SPqIIaLSODmIXl2w/images/affiliates-1.png?fit=max&auto=format&n=SPqIIaLSODmIXl2w&q=85&s=b7978d56fe73dd5cbb800bb444dfb21d" alt="Affiliates 1" width="1600" height="1116" data-path="images/affiliates-1.png" />
</Frame>

<Note>
  **Who can do what.** Admins can do everything here, including deleting affiliate programs. Managers can create and edit affiliate programs, but they cannot delete them. Viewers have read-only access: they can browse, search, and filter, but the Add button and the row menu with Edit and Delete will not appear for them.
</Note>

## Finding your way around

The page has a familiar shape. A header at the top gives you the **Add Affiliate** button (when you have permission to create). Below it sits a filter bar with a search box and two dropdowns. A short line then tells you how many programs you are looking at, for example "Showing 8 of 12 affiliate programs," so you can see how much your filters are narrowing things down. The rest of the page is the affiliate table itself.

### Search

Type in the search box (placeholder "Search affiliate programs...") to match on the program's product name or its notes. Results update as you type, so you can quickly find a program by the product it relates to or by a term you wrote in its notes.

### Filter by status and type

Two dropdowns sit next to the search box, and they stack together with the search text:

<AccordionGroup>
  <Accordion title="All Status" icon="filter">
    Narrow the list to a single status so you can focus on, for example, only the programs that are still Pending or the ones that are Approved. Set it back to **All Status** to clear the filter.
  </Accordion>

  <Accordion title="All Types" icon="tags">
    Narrow the list to a single program type. Set it back to **All Types** to see every program again.
  </Accordion>
</AccordionGroup>

<Tip>
  The search box and both dropdowns work together. Set each one back to its "All" option and clear the search box to see the full list again.
</Tip>

## What the table shows

Each row in the table is one affiliate program, laid out across these columns:

<CardGroup cols={2}>
  <Card title="Product" icon="box">
    The product name, shown with its logo (or a link icon when no logo is set). If the program has notes, a preview line appears under the product name.
  </Card>

  <Card title="Type" icon="tag">
    A colored badge showing the program's type, such as Referral or Commission.
  </Card>

  <Card title="Status" icon="circle-dot">
    A colored badge showing where the program stands, such as Pending or Approved.
  </Card>

  <Card title="Applied Date" icon="calendar">
    The date you applied to the program, or a dash when no date is set.
  </Card>

  <Card title="Links" icon="arrow-up-right-from-square">
    Quick outbound links. **Affiliate Link** opens the program's main link, and **Dashboard** opens the affiliate dashboard or support URL. Each opens in a new tab.
  </Card>

  <Card title="Row menu" icon="ellipsis-vertical">
    The three-dot menu at the end of each row, where Edit and Delete live for users who have permission.
  </Card>
</CardGroup>

Programs are listed with the most recently applied ones first.

## Understanding the type values

Every program has a type that describes how the partnership pays out or works. You choose it from a dropdown when you add or edit a program:

<CardGroup cols={2}>
  <Card title="Referral" icon="share-nodes">
    You refer customers and earn for the referral.
  </Card>

  <Card title="Commission" icon="percent">
    You earn a commission on sales you drive.
  </Card>

  <Card title="Revenue Share" icon="chart-pie">
    You share in the revenue the partnership generates.
  </Card>

  <Card title="Hybrid" icon="shuffle">
    A mix of arrangements, such as commission plus revenue share.
  </Card>

  <Card title="Other" icon="ellipsis">
    Anything that does not fit the categories above. Use the notes field to explain the arrangement.
  </Card>
</CardGroup>

## Understanding the status values

The status tells you where a program stands in its lifecycle. You set it from a dropdown when you add or edit a program:

<CardGroup cols={2}>
  <Card title="Pending" icon="hourglass-half">
    You have applied and are waiting on a decision. New programs start here by default.
  </Card>

  <Card title="Approved" icon="circle-check">
    Your application has been accepted.
  </Card>

  <Card title="Active" icon="bolt">
    The program is live and running.
  </Card>

  <Card title="Paused" icon="circle-pause">
    The program is temporarily on hold.
  </Card>

  <Card title="Rejected" icon="circle-xmark">
    The application was declined.
  </Card>
</CardGroup>

## Adding an affiliate

<Steps>
  <Step title="Open the form">
    Click **Add Affiliate** in the top-right corner. The Add New Affiliate Program form opens over the page.
  </Step>

  <Step title="Fill in the basic information">
    Enter the **Product Name** (required), for example the name of the tool or service you are partnering with. You can also add a **Logo URL** and set the **Applied Date** (required). Choose a **Type** and a **Status** from their dropdowns. A new program starts as Referral and Pending until you change it.
  </Step>

  <Step title="Add the links and resources">
    Enter the **Affiliate Link** (required), which is the main link for the program. You can also add an **Affiliate Dashboard/Support URL** for logging in to the partner's dashboard, and an **Agreement Document URL** pointing to the signed agreement.
  </Step>

  <Step title="Record the terms in notes">
    Use the **Notes** field for anything worth remembering, such as commission rates, special terms, and requirements. This free-text field is your place to capture the details of the arrangement.
  </Step>

  <Step title="Save the program">
    Click **Add Affiliate**. The new program appears in the table right away, and the count line updates.
  </Step>
</Steps>

<Note>
  Product Name, Applied Date, and the Affiliate Link are the key details for a program. The Logo URL, Dashboard/Support URL, Agreement Document URL, and Notes are all optional, so you can add just what you have and fill in the rest later.
</Note>

## Editing an affiliate

To update a program, open its three-dot menu at the end of the row and choose **Edit**. The same form opens, pre-filled with the current details, and the button now reads **Update Affiliate**. Change whatever you need, then save. Your edits appear in the table immediately.

## Product association

Each affiliate program is tied to a product through its **Product Name** field. This is the product or service the partnership is about, and it is what shows up first in each table row (alongside the logo if you added a Logo URL). Because search matches on the product name, keeping this field clear and consistent makes it easy to find the right program later.

## Tracking the terms and earnings details

AltamIQ keeps affiliate records lightweight. There is no separate earnings dashboard or automatic payout calculation on this page. Instead, the details that matter for how a program pays, such as commission rates, revenue-share splits, and any special conditions, live in two places you control:

* The **Type** field records the shape of the arrangement (Referral, Commission, Revenue Share, Hybrid, or Other).
* The **Notes** field is where you write the specifics, for example the exact commission rate or the terms of a revenue share.

<Tip>
  Because the Notes field is searchable, a good habit is to write the key numbers there, such as "20% commission" or "30-day cookie." You can then search for a rate or term across all your programs and jump straight to the matching record.
</Tip>

## Deleting an affiliate

Only Admins can delete a program. Open the row's three-dot menu and choose **Delete**. A confirmation prompt appears asking if you are sure you want to delete the affiliate program. Confirm to remove it, and the table refreshes. If you are a Manager or a Viewer, the Delete option will not appear for you.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.