FamilyService

UpdateFamily by clientKey

Updates an existing family using the list of fields specified in update_mask.

patch/api/v1/families/client_key/{clientKey}

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/families/client_key/{clientKey}
  • Auth: HTTP bearer

Path parameters

clientKeystring required

Request body

familyIdstring
updateMaskstring required

Note: Whenever the family is updated, the family stats are also updated to point to the new family version to ensure the family stats are always up to date. client_key can only be updated if it is not already set. It must be passed in via the family request and cannot be used as identifier.

Response

A successful response.

familyVersionIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.