Ban a partner
ban_partnerBlock a partner from your program by disabling all links and canceling their commissions. Provide a valid reason and partner ID to enforce.
Instructions
Ban a partner from your program. This will disable all links and mark all commissions as canceled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | The reason for banning the partner. | |
| account | No | Exact configured private workspace profile label; not a tenant or provider account ID. | |
| confirm | No | Must be true for the requested mutation or exclusive private output file. | |
| payload | No | Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. | |
| tenantId | No | The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown. | |
| partnerId | No | The ID of the partner to create a link for. Will take precedence over `tenantId` if provided. | |
| payload_file | No | Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. |