Skip to content

Google: Creates an event — response body — birthday Properties

Creates an event.: response body, field birthdayProperties. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Creates an event — response body — birthday Properties

FieldTypePresenceDescription and constraints
$objectRoot
contactstringOptionalResource name of the contact this birthday event is linked to. This can be used to fetch contact details from People API. Format: “people/c12345”. Read-only.
customTypeNamestringOptionalCustom type label specified for this event. This is populated if birthdayProperties.type is set to “custom”. Read-only.
typestringOptionalType of birthday or special event. Possible values are:
- “anniversary” - An anniversary other than birthday. Always has a contact.
- “birthday” - A birthday event. This is the default value.
- “custom” - A special date whose label is further specified in the customTypeName field. Always has a contact.
- “other” - A special date which does not fall into the other categories, and does not have a custom label. Always has a contact.
- “self” - Calendar owner’s own birthday. Cannot have a contact. The Calendar API only supports creating events with the type “birthday”. The type cannot be changed after the event is created.
Default: birthday

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.