contacts_delete_group
Delete one iCloud contact group by uid and name when asked to remove a group; only the grouping is removed and every member's contact card stays.
Instructions
Delete one contact group by uid; only the grouping goes, every member's contact card stays in the address book.
Use when: the owner explicitly asks to remove a group. Not for removing some people from a group (use contacts_update_group with remove_members), for renaming (use contacts_update_group), or for deleting a person (use contacts_delete_contact). Parameters:
uid is the opaque group uid string from contacts_list_groups; copy it exactly (matched case-sensitively). A person's uid gives "No group with uid".
name must be that group's name as contacts_list_groups shows it; case and accents are ignored, other differences are not.
Both are required and must agree: name is the check that the uid is the group the owner meant. A mismatch deletes nothing and the error names the uid's real group. Behavior: removes the group card from every synced device; it cannot be undone through this connector (recreate it with contacts_create_group if needed). No contact is edited or deleted. The delete is conditional on the version last read, so a group changed elsewhere since is not deleted. Not available when the server runs READ_ONLY. Returns: {deleted: true, uid, name, note}. Errors: a name mismatch is refused with "That uid is the group 'X', not 'Y'. Nothing was deleted."; "No group with uid" (wrong uid or already deleted; a repeat call gives this); "This contact changed since it was read": list the groups again and retry.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Group uid from contacts_list_groups. | |
| name | Yes | The group's exact name, as a check. |