Régua e comunicação

Como a cobrança acontece: réguas e seus passos, classificações da carteira, modelos de mensagem, layouts de e-mail, as notificações enviadas e os canais e preferências de envio.

Famílias nesta página

Família	Tools	read	write	destructive
collection_rules — Réguas de cobrança e passos	9	3	4	2
classifications — Classificações	5	2	2	1
templates — Modelos de mensagem	6	2	3	1
email_layouts — Layouts de e-mail	2	1	1	0
notifications — Notificações	6	2	1	3
notification_channels — Canais de notificação	5	2	2	1
notification_preferences — Preferências de notificação	2	1	1	0

Réguas de cobrança e passos

Tool	Tipo	Permissão	Endpoint	O que faz
dunning_collection_rules_list	read	collection_rules.list	GET /v1/collection-rules	Lists the organization’s collection rules, ordered by priority.
dunning_collection_rules_create	write	collection_rules.create	POST /v1/collection-rules	Creates a collection rule, optionally with steps.
dunning_collection_rules_get	read	collection_rules.show	GET /v1/collection-rules/{id}	Returns a collection rule by ID.
dunning_collection_rules_update	write	collection_rules.update	PUT /v1/collection-rules/{id}	Updates the rule data (partial).
dunning_collection_rules_delete	destructive	collection_rules.delete	DELETE /v1/collection-rules/{id}	Soft-deletes the rule and its steps.
dunning_collection_rule_steps_list	read	collection_rules.show	GET /v1/collection-rules/{id}/steps	Lists the rule steps ordered by position, with the message template embedded.
dunning_collection_rule_steps_create	write	collection_rules.update	POST /v1/collection-rules/{id}/steps	Creates a step on the rule.
dunning_collection_rule_steps_update	write	collection_rules.update	PUT /v1/collection-rules/{id}/steps/{stepId}	Updates a step (partial).
dunning_collection_rule_steps_delete	destructive	collection_rules.update	DELETE /v1/collection-rules/{id}/steps/{stepId}	Soft-deletes a step and reorders the remaining ones.

Classificações

Tool	Tipo	Permissão	Endpoint	O que faz
dunning_classifications_list	read	classifications.list	GET /v1/classifications	Lists the organization’s classifications, ordered by priority and name by default.
dunning_classifications_create	write	classifications.create	POST /v1/classifications	Creates a classification.
dunning_classifications_get	read	classifications.show	GET /v1/classifications/{id}	Returns a classification by ID.
dunning_classifications_update	write	classifications.update	PUT /v1/classifications/{id}	Updates a classification (partial).
dunning_classifications_delete	destructive	classifications.delete	DELETE /v1/classifications/{id}	Soft-deletes a classification.

Modelos de mensagem

Tool	Tipo	Permissão	Endpoint	O que faz
dunning_templates_list	read	templates.list	GET /v1/templates	Lists the organization’s message templates with pagination, search and filters.
dunning_templates_create	write	templates.create	POST /v1/templates	Creates a message template.
dunning_templates_get	read	templates.show	GET /v1/templates/{id}	Returns a template by ID.
dunning_templates_update	write	templates.update	PUT /v1/templates/{id}	Updates a template (partial).
dunning_templates_delete	destructive	templates.delete	DELETE /v1/templates/{id}	Soft-deletes a template.
dunning_templates_duplicate	write	templates.duplicate	POST /v1/templates/{id}/duplicate	Creates a copy of the template with the given name.

Layouts de e-mail

Tool	Tipo	Permissão	Endpoint	O que faz
dunning_email_layouts_list	read	email_layouts.list	GET /v1/email-layouts	Lists the organization’s email layouts (default first) and the built-in reference layout.
dunning_email_layouts_create	write	email_layouts.create	POST /v1/email-layouts	Creates an email layout.

Notificações

Tool	Tipo	Permissão	Endpoint	O que faz
dunning_notifications_list	read	notifications.list	GET /v1/notifications	Lists the organization’s notifications with pagination and filters.
dunning_notifications_create	destructive	notifications.create	POST /v1/notifications	Creates a manual notification for a customer, optionally linked to a charge and a rule step.
dunning_notifications_get	read	notifications.show	GET /v1/notifications/{id}	Returns a notification by ID; use include to attach relations.
dunning_notifications_update	write	notifications.update	PUT /v1/notifications/{id}	Updates a notification’s status, delivery timestamps and metadata (partial).
dunning_notifications_delete	destructive	notifications.delete	DELETE /v1/notifications/{id}	PERMANENTLY deletes a notification (hard delete — the model has no soft delete).
dunning_notifications_resend	destructive	notifications.resend	POST /v1/notifications/{id}/resend	Creates a NEW pending notification copied from the original (the new record’s metadata references the original via resend_of).

Canais de notificação

Tool	Tipo	Permissão	Endpoint	O que faz
dunning_notification_channels_list	read	notification_channels.show	GET /v1/notification-channels	Returns the organization channels.
dunning_notification_channels_create	write	notification_channels.update	POST /v1/notification-channels	Creates a channel.
dunning_notification_channels_get	read	notification_channels.show	GET /v1/notification-channels/{id}	Returns a channel by ID.
dunning_notification_channels_update	write	notification_channels.update	PATCH /v1/notification-channels/{id}	Updates a channel (partial).
dunning_notification_channels_delete	destructive	notification_channels.update	DELETE /v1/notification-channels/{id}	Removes the channel (soft delete).

Preferências de notificação

Tool	Tipo	Permissão	Endpoint	O que faz
dunning_notification_preferences_get	read	notification_preferences.show	GET /v1/notification-preferences	Returns the effective gate per message type — types without a saved record appear with all channels enabled.
dunning_notification_preferences_update	write	notification_preferences.update	PUT /v1/notification-preferences	Upserts the submitted preferences (partial: only the included types are changed).

---

Os campos de cada recurso estão na Referência da API.

Uma tool que você não pode rodar não aparece em tools/list. Se faltar alguma desta página, veja Autenticação.