contacts_create_group
Create a new contact group in iCloud Contacts, optionally adding initial members, for inviting or emailing a set of people together.
Instructions
Create a new contact group in the owner's address book (it shows in the Contacts app), optionally with its first members.
Use when: the owner wants a new named group, for example to invite or mail a set of people together. Not for changing an existing group's name or members (use contacts_update_group), for finding existing groups (use contacts_list_groups), or for creating a person (use contacts_create_contact). Parameters:
name: 1-100 characters; runs of spaces are collapsed.
members: person uids from contacts_search_contacts; omitted means an empty group; duplicates are dropped. Behavior:
Writes one group card to the first (default) address book and syncs it to the owner's devices; no contact card is changed.
A name that already exists (ignoring case and accents) is refused, so a repeat never makes a second group.
Every member uid is checked first; if one is unknown nothing is created.
Not available when the server runs READ_ONLY. Returns: {created: true, uid, name, members (count)}. Errors:
"There is already a group called ...": use contacts_list_groups to get its uid.
"Not contacts in this address book: ..." names the bad uids.
a name outside 1-100 characters is refused.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the new group. | |
| members | No | Contact uids (from contacts_search_contacts). |