---
title: "Update promoter"
method: PUT
path: "/promoters/{id}"
tags: ["Promoters"]
---

# Update promoter

`PUT /promoters/{id}`

With this endpoint you can update a promoter. 
 <Tip>**HTTP Request** <br/>`PUT https://api.firstpromoter.com/api/v2/company/promoters/{id}`</Tip>

## Path parameters

- `id` integer, required

## Headers

- `Account-ID` string, required

## Request body

- PromoterUpdate
  - `email` string, email — Email address of the promoter
  - `find_by` 'email' | 'cust_id' | 'auth_token' | 'ref_token' | 'promo_code' — Find by attribute. Required when you want to find the promoter using another parameter like the email, cust_id, auth_token, ref_token, or promo_code instead of an ID. Your request should follow the format `https://api.firstpromoter.com/api/v2/company/promoters/{email, cust_id, auth_token, ref_token, or promo_code}`
  - `cust_id` string, nullable — Cust ID of the promoter
  - `custom_fields` unknown[] — Custom fields must be a Hash with the keys being the ones from the company custom fields and values must be String or Array of Strings. These are based on the custom fields that you set in your Settings > Affiliate portal > Custom fields. **Note**: Each item will have to be set as `custom_fields[my_custom_field_key]: my_custom_field_value`
    - unknown
  - `profile` PromoterProfile
    - `id` integer — ID of the profile
    - `first_name` string — First name of the promoter
    - `last_name` string — Last name of the promoter
    - `website` string, nullable — Website of the promoter
    - `company_name` string, nullable — Company name of the promoter
    - `company_number` string, nullable — Company registration number
    - `phone_number` string, nullable — Phone number of the promoter
    - `vat_id` string, nullable — VAT ID of the promoter
    - `country` string, nullable — Country in 2 characters format
    - `address` string, nullable — Address of the promoter
    - `avatar` string — URL to the promoter's avatar image
    - `w8_form_url` string, nullable — URL to the promoter's W8 form if available
    - `w9_form_url` string, nullable — URL to the promoter's W9 form if available
    - `description` string, nullable — Description of the promoter
    - `invoice_details_validation_errors` object, nullable — Validation errors for invoice details
    - `should_validate_invoice_details` boolean — Should validate invoice details
    - `instagram_url` string, nullable — Promoter's Instagram URL
    - `youtube_url` string, nullable — Promoter's YouTube URL
    - `linkedin_url` string, nullable — Promoter's LinkedIn URL
    - `facebook_url` string, nullable — Promoter's Facebook URL
    - `twitter_url` string, nullable — Promoter's Twitter URL
    - `twitch_url` string, nullable — Promoter's Twitch URL
    - `tiktok_url` string, nullable — Promoter's TikTok URL
  - `profile[_destroy_w8form]` boolean — Destroy W8 form
  - `profile[_destroy_w9form]` boolean — Destroy W9 form

## Response `200`

Promoter updated successfully

- Promoter
  - `id` integer — ID of the promoter
  - `status` string — Status of the promoter
  - `cust_id` string
  - `email` string — Email of the promoter
  - `created_at` string, date-time — ISO date of when the promoter was created
  - `temp_password` string, nullable — Temporary password created for the promoter
  - `default_promotion_id` integer
  - `pref` string
  - `default_ref_id` string — Default referral id of the promoter
  - `note` string, nullable — A note/description of promoter
  - `w8_form_url` string, nullable — Url of the w8 form
  - `w9_form_url` string, nullable — Url of the w9 form
  - `parent_promoter_id` integer — Parent promoter id
  - `earnings_balance` object — Earning balance of the promoter
    - `cash` integer
  - `current_balance` object — Current balance of the promoter
    - `cash` integer
  - `paid_balance` object — Paid balance of the promoter
    - `cash` integer
  - `auth_token` string — Authentication token generated when the promoter was created

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api.md) · [All operations](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firstpromoter/firstpromoter-batch-processes-api/versions/e15f0d026ccf/schema)