All
Guides
API
Search
CTRL+K
Getting Started
Search

Add Custom Field

post

https://gcalcustomfields.tabgraf.com/api/user/custom-fields/add


Add a new custom field to an event or calendar.


HEADER

Authorizationinteger

API token for authentication.

Content-Type

BODY PARAMS

customFieldsobject

DATA OBJECT

bookmarkFieldinteger

Marks if the field is bookmarked (0/1).


defaultFieldinteger

Indicates if it's a default field (0/1).


fieldIdstring

Unique ID of the field.


fieldTypestring

Type of input (e.g., text, dropdown).


fieldOptions

Options for dropdown fields (null for text).


fieldRenderLocationstring

Defines where it's shown in UI.


isSurveyinteger

Specifies if it's part of a survey (0/1).


fieldIconstring

Icon representing the field.


responsestring

User's input value


validationboolean

If validation is required.


responseBystring

Who provided the response

eventNamestring

The event's name


eventIdstring

Unique event identifier


calendarIdstring

Calendar where the event is stored

Field Descriptions

  • fieldType: Specifies the type of field (e.g., text, textarea, radio, checkbox, date, daterange, color picker, select).
  • fieldLabel: The label or name of the field (e.g., "Attendee Type").
  • fieldId: A unique identifier for the custom field (e.g., "attendeeType123").
  • fieldOptions: The available options for the field, separated by slashes (e.g., "Speaker/VIP/General Admission").
  • fieldRenderLocation: Specifies where the field will appear in the form (e.g., "belowLocation", "belowNotification", "belowColor", "belowVisibility", "belowDescription", "belowPermission", "belowGuests").
  • fieldIcon: The icon associated with the field, taken from Material Icons (e.g., "Search").
  • isSurvey: Indicates whether the field is part of a survey. Values:
    • 0 → Not a survey
    • 1 → Is a survey
  • defaultField: Indicates whether this is a default field. Values:
    • 0 → Not default
    • 1 → Default
  • bookmarkField: Indicates whether the field is bookmarked. Values:
    • 0 → Not bookmarked
    • 1 → Bookmarked

Important Notes

  • fieldRenderLocation: This must be one of the predefined values like "belowLocation", "belowNotification", etc. Any other value will be rejected.
  • Boolean Fields (isSurvey, defaultField, bookmarkField): These fields accept only 0 (false) or 1 (true).
LANGUAGE
Shell logoShell
Node logoNode
Ruby logoRuby
PHP logoPHP
C logoC
REQUEST
RESPONSE
200
Custom Fields

Create custom fields in Google Calendar™ events to include additional information. Select the display location according to your preferences. Generate surveys and collect feedback from event attendees.

English

Developers

Help us improve

How was your experience using our docs?