Skip to main content
DELETE
Removes a member from a family you own, then regenerates the family’s group card_image_url to reflect the remaining cast. Only the family’s owner can remove members.
Removing a family member requires a Pro, Max, or Enterprise plan, like all other family write operations.
The family must be in ready status: if another generation is already in progress for this family, the request is rejected with 422 FAMILY_NOT_READY. A family must keep at least 1 member: removing the last one is rejected with 422 FAMILY_MEMBER_MINIMUM.
Unlike Delete Family, this endpoint returns 202 Accepted rather than 204 No Content, since the group card image needs to be regenerated for the remaining members.

Path Parameters

string
required
The UUID of the family. Only accepts families you own.Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
integer
required
The 0-based position of the member to remove, matching the order of the members array returned by Get Family.Returns 404 FAMILY_MEMBER_NOT_FOUND if out of range.Example: 2

Request Body

No body fields are required.
string
HTTPS URL to receive a webhook notification when the family finishes regenerating its group card.See Webhooks for payload format and verification details.
Webhook URLs must use HTTPS and cannot point to private/internal networks (SSRF protection).

Response

Returns a 202 Accepted response with a task to poll:
string
required
Unique identifier for the family.
string
required
Unique identifier for the generation task. Poll it via Get Task, or use webhook_url for a notification instead.
string
required
Always generating for this response shape.
boolean
required
true for live (vpk_live_) requests; false for test-mode (vpk_test_) requests. See Test Mode.
HATEOAS links for navigation.
  • self: URL to fetch the family (/v1/families/{family_id})
  • task: URL to poll for the generation task (/v1/tasks/{task_id})

Polling for Completion

Poll the returned task_id via Get Task. Once status is completed, Get Family reflects the remaining members and the regenerated group card_image_url. If the task fails, the family is left exactly as it was: the member is not removed.

Error Codes

See Error Handling for more details.