---
title: "Suspend a partner"
method: POST
path: "/affiliates/{id}/suspend"
tags: ["Affiliates"]
---

# Suspend a partner

`POST /affiliates/{id}/suspend`

## Request

- Base URL: `https://api.supersendtx.com`
- URL: `https://api.supersendtx.com/affiliates/{id}/suspend`
- Auth: HTTP bearer

Their links stop attributing and payouts skip them.

## Request body

- object
  - `reason` string

## Response `200`

Partner after the change

- AffiliateResponse
  - `affiliate` Affiliate, required
    - `object` 'affiliate', required
    - `id` string, required
    - `email` string, email, required
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `company` string, nullable
    - `website` string, nullable
    - `country` string, nullable: ISO 3166-1 alpha-2
    - `status` 'invited' | 'pending' | 'active' | 'suspended' | 'rejected', required
    - `source` 'applied' | 'invited' | 'imported' | 'api' | 'customer', required
    - `campaign_id` string, required
    - `parent_affiliate_id` string, nullable: The partner who recruited this one (second-tier commissions)
    - `tags` string[]
    - `payout_method` 'stripe_connect' | 'paypal' | 'wise' | 'bank' | 'other'
    - `payout_ready` boolean: Whether the partner has payout details a run can use
    - `approved_at` string, date-time, nullable
    - `links` AffiliateLink[]: All links on single-partner responses; the primary link only on lists. Omitted before the program is set up.
      - `object` 'affiliate_link', required
      - `id` string, required
      - `affiliate_id` string, required
      - `token` string, required: The value of `?via=` (or `?ref=`) in the link
      - `url` string, uri, required: The shareable link
      - `destination_url` string, uri, nullable
      - `label` string, nullable
      - `is_primary` boolean, required
      - `created_at` string, date-time, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: Validation error (`details.fields` names each bad field)
- `401`: Missing or invalid API key
- `403`: The API key is not full access, or the action is not allowed
- `404`: Not found in this account
- `409`: Conflict

---

[API](https://skmtc.dev/ranla/apis/supersend-tx-api.md) · [All operations](https://skmtc.dev/ranla/apis/supersend-tx-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ranla/apis/supersend-tx-api/revisions/e3e782652f50?raw)