Actions119
- Call (Beta) Actions
- Chat Actions
- Community Actions
- Group Actions
- Group (More) Actions
- Instance Actions
- Instance (More) Actions
- Message Actions
- Message (More) Actions
- Newsletter / Channel Actions
- Accept Admin Invite
- Create Newsletter
- Delete Newsletter
- Follow Newsletter
- Get Newsletter Metadata
- List Newsletters
- Mute Newsletter
- Remove Newsletter Admin
- Revoke Admin Invite
- Search Newsletters
- Transfer Newsletter Ownership
- Unfollow Newsletter
- Unmute Newsletter
- Update Newsletter Description
- Update Newsletter Name
- Update Newsletter Picture
- Update Newsletter Settings
- Partner Actions
- Webhook Actions
- Webhook (More) Actions
- WhatsApp Status Actions
Partner → Rename Instance
AI-generatedSummary
Rename a partner instance by updating its name.
Inputs
- gp_instance (required) — Instance identifier to rename (used in the request path).
- gp_body — Request body containing the new name under the key
name.
Output shape
a single updated instance object
Returns the renamed instance details; fields may be omitted on error.
Examples
Example 1: Rename an instance from 'old-name' to 'new-name'
Resource: Partner, Operation: externalRenameInstance, gp_instance='old-name', gp_body={"name":"new-name"}
Example 2: Rename an instance while providing optional additional fields
Resource: Partner, Operation: externalRenameInstance, gp_instance='instance-123', gp_body={"name":"instance-456","description":"Updated"}
Example 3: Rename an instance using default empty body (fails if name missing)
Resource: Partner, Operation: externalRenameInstance, gp_instance='instance-123', gp_body={}