Create a new appointment

post

https://api.maximizer.com/ferret/v1/appointments

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Notice to Ferret API (v1) users
We’re excited to announce the beta release of Ferret API v2, offering a more consistent and expanded approach, with access to a wider range of objects.
New clients are encouraged to start with Ferret API v2 and/or Octopus API to take advantage of the latest updates. Existing clients are also encouraged to transition to v2, although Ferret API v1 will remain stable and fully operational. For those looking to migrate to the Octopus API, we’ve prepared a detailed migration guide.

Body Params

Command to create an appointment

contactAttendees

array of objects | null

Contact attendees

contactAttendees

userAttendees

array of objects

required

User attendees

userAttendees*

legacyOpportunityKey

string | null

Parent opportunity key

legacyAssignedUserKey

string

required

length ≥ 1

Appointment's organizer

subject

string

required

length ≥ 1

Subject

body

string | null

Description

location

object

startDate

date-time

required

Start date of appointment

endDate

date-time

required

End date of appointment

category

int32 | null

Appointment's production category

interactionCategory

int32 | null

Appointment's interaction category

result

int32 | null

Appointment's result

Headers

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json