Update producer

put

https://api.advancehq.com/v1/producers/{producer_id}

Updates a specific producer by ID.

Path Params

producer_id

string

required

Body Params

billing_contact_email

string | null

Billing contact email (used internally for payout processing)

billing_contact_name

string | null

Billing contact name (used internally for payout processing)

billing_contact_phone

string | null

Billing contact phone (used internally for payout processing)

company_email_on_invoices

string | null

Company email shown on invoices sent to this producer's clients

company_name_on_invoices

string | null

Company name shown on invoices sent to this producer's clients. Overrides the default agency name.

company_phone_on_invoices

string | null

Company phone shown on invoices sent to this producer's clients

contact_email

string | null

Primary contact email address

contact_name

string | null

Primary contact person's name

contact_phone

string | null

Primary contact phone number

customer_external_id

string | null

Your system's unique identifier for this producer. Must be unique per tenant. Used for lookups via GET /v1/producers/customer_external_id/{id}.

customer_external_id_for_billing

string | null

External ID used specifically for billing-related lookups.

external_account_id

string | null

memo

string | null

Internal notes about this producer (max 250 characters)

minimal_monthly_threshold

≥ 0

Minimum accumulated commission balance before a payout is triggered. Payouts are skipped if the balance is below this amount.

notifications_email_enabled

boolean | null

Send email notifications to the producer for relevant events

notifications_email_template

string | null

Email notification template to use

notify_recipient_on_payout_sent

boolean

Defaults to true

Email the producer when their scheduled payout is sent.

notify_tenant_on_payout_failure

boolean

Defaults to true

Email the tenant's admins when a scheduled payout to this producer fails.

notify_tenant_on_payout_sent

boolean

Defaults to false

Email the tenant's admins when a payout is sent to this producer (opt-in).

payout_cadence

payout_cadence_type

string | null

Payout cadence type: 'monthly', 'weekly', or 'every_n_weeks'.

producer_name

string | null

recurrence_payout_day

integer | null

1 to 28

deprecated

Deprecated: use payout_cadence instead. Legacy single day of the month (1–28) on which commissions are automatically paid out.

recurrence_payout_enabled

boolean | null

Enable automatic scheduled commission payouts. Set payout_cadence to configure the schedule.

transfer_speed

string | null

Defaults to ach

Transfer method for payouts. Defaults to 'ach'.

Responses

200Successful Response

400Bad Request - Invalid input parameters or malformed request body

401Unauthorized - Missing or invalid authentication credentials

403Forbidden - Insufficient permissions to access this resource

404Not Found - The requested resource does not exist

422Validation Error

429Too Many Requests - Rate limit exceeded

500Internal Server Error - An unexpected error occurred