Add or update a pet's birthday

POST /customers/{customer_id}/pets


Scope	`customers:write`
Customer session token	Accepted with the `write` scope, for the token’s own customer
Rate limit class	`write` (limits)
Idempotency key	Required (idempotency)
MCP tool	`charm_save_customer_pet`

For the pet birthday rule, with its limits and once-a-year change lock. Refusals carry details.reason like the children endpoint.

Parameters

Name	In	Type	Description
`customer_id`	path	string	Shopify customer GID (percent-encoded, e.g. `gid%3A%2F%2Fshopify%2FCustomer%2F123`) or the numeric customer id.

Request body

Field	Type	Description
`id`	string	Existing entry to rename or re-date; omit to add one. (optional)
`name`	string	(optional)
`birthday`	string	`YYYY-MM-DD`. (optional)
`species`	string	(optional)
`locale`	string	(optional)

Response `200`

Returns PetsResult.

Field	Type	Description
`changed`	boolean
`pets`	array of Subject

{
  "changed": true,
  "pets": [
    {
      "id": "id",
      "name": "Gold",
      "birthday": "birthday",
      "species": "species",
      "updated_at": "2026-10-01T09:30:00.000Z"
    }
  ]
}

Example

curl -X POST "https://charm.appfleece.app/api/v1/customers/7712345/pets" \
  -H "Authorization: Bearer chrm_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Errors

unauthorized · invalid_token · token_expired · insufficient_scope · access_required · not_found · validation_error · rate_limited · idempotency_conflict

Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.