This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

appointment

Type: object

This is object used to describe the To do/Meeting/appointments

root appointmentId
Type: string

OpCo's appointment id or number that identifies the activity.

Must be at most 50 characters long


Example:

"1234567"

root subject
Type: string

Type a short description about the objective or primary topic of the appointment.

Must be at most 200 characters long


Example:

"Introduction appointment"

root visitPurposes
Default: [""]

Deprecated Visit purposes. Use comma delimited string for multiple purposes.

root visitPurposes anyOf item 0
Type: const

Welcome meeting

Specific value: "231820000"
root visitPurposes anyOf item 1
Type: const

Regular meeting

Specific value: "231820001"
root visitPurposes anyOf item 2
Type: const

Project meeting

Specific value: "231820002"
root visitPurposes anyOf item 3
Type: const

Commercial

Specific value: "231820003"
root visitPurposes anyOf item 4
Type: const

Presentation / prospection

Specific value: "231820004"
root visitPurposes anyOf item 5
Type: const

Other

Specific value: "231820005"
root visitPurposes anyOf item 6
Type: const

N/A

Specific value: ""

Must be at most 200 characters long


Example:

"231820000"

root categoryCode
Default: [""]

Category of the activity to identify the purpose, such as lead gathering or customer follow up, to tie the task to a business group or function.

root categoryCode oneOf item 0
Type: const

Account

Specific value: "0"
root categoryCode oneOf item 1
Type: const

Case

Specific value: "1"
root categoryCode oneOf item 2
Type: const

Contact

Specific value: "2"
root categoryCode oneOf item 3
Type: const

Lead

Specific value: "3"
root categoryCode oneOf item 4
Type: const

Opportunity

Specific value: "4"
root categoryCode oneOf item 5
Type: const

N/A

Specific value: ""

Must be at most 1 characters long


Example:

"0"

root priorityCode
Default: ["1"]

Select the priority so that preferred customers or critical issues are handled quickly.

root priorityCode oneOf item 0
Type: const

Low

Specific value: "0"
root priorityCode oneOf item 1
Type: const

Normal

Specific value: "1"
root priorityCode oneOf item 2
Type: const

High

Specific value: "2"

Must be at most 1 characters long


Example:

"0"

root scheduledStart
Type: stringFormat: date-time

Enter the expected start date and time for the activity to provide details about the timing of the activity.
Examples:

"2021-10-12T08:30:22.804Z"

"2018-11-13T20:20:39+02:00"

root scheduledEnd
Type: stringFormat: date-time

Enter the expected end date and time for the activity to provide details about the timing of the activity.
Examples:

"2021-10-12T08:30:22.804Z"

"2018-11-13T20:20:39+02:00"

root scheduledDurationMinutes
Type: integer

Shows the expected duration of the activity, in minutes.
Examples:

59

61

root requiredAttendees
Type: string

Enter the account, contact, lead, user, or other equipment resources that are required to attend the appointment. Use semi-colon delimited string for multiple names or email addresses.

Must be at most 2000 characters long

root optionalAttendees
Type: string

Enter the account, contact, lead, user, or other equipment resources that are not needed at the appointment, but can optionally attend.. Use semi-colon delimited string for multiple names or email addresses

Must be at most 2000 characters long

root location
Type: string

Type the location where the appointment will take place, such as a conference room or customer office.

Must be at most 200 characters long

root atBranch
Default: [false]

Deprecated Indicate if the visit took place at a branch

root atBranch oneOf item 0
Type: const

Yes

Specific value: true
root atBranch oneOf item 1
Type: const

No

Specific value: false

Example:

true

root facilityId
Type: string

Deprecated Enter the unique facilityId when the atBranch's value is true.

Must be at most 50 characters long


Example:

"D36"

root description
Type: string

Description of the activity. For email this should be the greeting and message text of the email.

Must be at most 1073741823 characters long


Examples:

"First to client for introductions"

"Hi Jo, Good to talk the other day. Best Regards"

root meetingMinutes
Type: string

Meeting minutes.

Must be at most 10000 characters long

root personalNotes
Type: string

Personal notes related to the appointment.

Must be at least 0 characters long


Example:

"Discuss project updates and next steps."

root outcomeOfVisit
Type: enum (of string)

Outcome of the visit

Must be one of:

  • "COMMERCIAL_FOLLOWUP"
  • "QUOTE_REQUESTED"
  • "OPPORTUNITY_DETECTED"
  • "ORDER_TAKING"
  • "CASE_DETECTED"
  • "FOLLOWUP_NEEDED"
  • "CUSTOMER_INFO_COLLECTED"
  • "OTHERS"

root createReport
Type: boolean Default: false

Boolean value representing if a report should be created. By default createREport is set to false, but if either outcomeOfVisit or meetingMinutes are provided, then createReport's default value will be true.

root regardingObjectType
Type: enum (of string)

Enter the record type that the activity relates to.

Must be one of:

  • "ACCOUNT"
  • "CONTACT"
  • "INCIDENT"
  • "LEAD"
  • "OPPORTUNITY"
  • "QUOTE"
  • "SALESORDER"
  • "PROSPECT"

Example:

"ACCOUNT"

root regardingObjectId
Type: string

Enter the record id that the activity relates to.

Must be at most 50 characters long


Example:

"123245678"

root actualStart
Type: stringFormat: date-time

Enter the actual start date and time for the activity to provide details about the timing of the activity.
Examples:

"2021-10-12T08:30:22.804Z"

"2018-11-13T20:20:39+02:00"

root actualEnd
Type: stringFormat: date-time

Enter the actual end date and time for the activity to provide details about the timing of the activity.
Examples:

"2021-10-12T08:30:22.804Z"

"2018-11-13T20:20:39+02:00"

root actualDurationMinutes
Type: integer

Shows the actual duration of the activity, in minutes.
Examples:

"59"

"61"

root owner
Type: string

Enter the email address of the user who is assigned to manage the record.

root appointmentType
Type: enum (of string)

Enter the type of Appointment.If it is over phone or Teams then Remote else if it is a physical visit then In Person

Must be one of:

  • "In Person"
  • "Remote"

Example:

"In Person"

root statusCode
Default: ["1"]

Enter the activity's status.

root statusCode oneOf item 0
Type: const

Free

Specific value: "1"
root statusCode oneOf item 1
Type: const

Tentative

Specific value: "2"
root statusCode oneOf item 2
Type: const

Completed

Specific value: "3"
root statusCode oneOf item 3
Type: const

Canceled

Specific value: "4"
root statusCode oneOf item 4
Type: const

Busy

Specific value: "5"
root statusCode oneOf item 5
Type: const

Out of Office

Specific value: "6"

Example:

"1"