Body

• ClientGUID string(uuid) | null

  This field is required if the value of EventBasis = 2: ClientGUID must be in the household.

• EventLabel string Required

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• EventBasis integer Required

  An integer representing the status of the type of event:

  • 1: Date
  • 2: Age
  • 3: Linked to another event
• LinkedEventGUID string(uuid) | null

  This field is required if the value of EventBasis = 3:

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/events/options

• OffsetBasis integer | null

  An integer representing before or after:

  • 1: Before
  • 2: After

  This field is required if the value of EventBasis = 3.

• OffsetYears integer | null

  This field is required if the value of EventBasis = 3. OffsetYears and OffsetMonths must resolve to a date in the future.

  Minimum value is 0.

• OffsetMonths integer | null

  OffsetYears and OffsetMonths must resolve to a date in the future.

  Minimum value is 0, maximum value is 11.

• AgeYears integer | null

  This field is required if the value of EventBasis = 2. Age Years + Age Months should be in the future

  Maximum value is 130.

• AgeMonths integer | null

  This field is required if the value of EventBasis = 2. Age Years + Age Months should be in the future

  Minimum value is 0, maximum value is 11.

• EventDate string(date) | null

  This field is required if the value of EventBasis = 1. Date must be after today.

  Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023.

• GoalSet integer | null

  Minimum value is 1, maximum value is 2.

• GoalPriority integer | null

  Minimum value is 1, maximum value is 5.

• GoalYears1 integer | null

  This field is required if the value of GoalSet = 1. Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

  Minimum value is 1, maximum value is 99.

• GoalAmount1 integer | null

  This field is required if the value of GoalSet = 1.

  Minimum value is 0.

• GoalYears2 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalAmount2 is set. Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

  Minimum value is 1, maximum value is 99.

• GoalAmount2 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalYears2 is set.

  Minimum value is 0.

• GoalYears3 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalAmount3 is set. Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

  Minimum value is 1, maximum value is 99.

• GoalAmount3 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalYears3 is set.

  Minimum value is 0.

• GoalYears4 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalAmount4 is set. Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

  Minimum value is 1, maximum value is 99.

• GoalAmount4 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalYears4 is set.

  Minimum value is 0.

• GoalYears5 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalAmount5 is set. Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

  Minimum value is 1, maximum value is 99.

• GoalAmount5 integer | null

  This field is required if the value of GoalSet = 1 AND the value of GoalYears5 is set.

  Minimum value is 0.

• EventIcon string | null

  Chose one of the preselected font awesome icons. If you do not enter an icon then a default icon will be applied.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/events/options

• EventColour string | null

  Enter a 6 character hex value without the '#'. If you do not enter a value then a default value will be applied.