Negotiation campaigns

Discount offers the debtor portal presents to charges within a range of days overdue. create creates the campaign already active; delete ends it and keeps the record.

Command	HTTP	Description
`negotiation-campaigns list`	`GET /v1/negotiation-campaigns`	List campaigns
`negotiation-campaigns create`	`POST /v1/negotiation-campaigns`	Create campaign
`negotiation-campaigns delete`	`DELETE /v1/negotiation-campaigns/{id}`	End campaign

Examples

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List campaigns
kobana dunning negotiation-campaigns list --fields "id,name,discount_percentage,max_installments,activated_at"

# 30% off for 60 to 180 days overdue
kobana dunning negotiation-campaigns create \
  --json '{"name": "Feirão de dezembro", "discount_percentage": 30, "max_installments": 6, "min_days_overdue": 60, "max_days_overdue": 180}'

# End a campaign
kobana dunning negotiation-campaigns delete --params '{"id": "CAMPAIGN_ID"}' --dry-run

Next steps

Disputes
Schema introspection — every parameter this resource accepts.

Examples​

Next steps​

Examples

Next steps