> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Default Suggested Appointment Entity

> Loading default values into a new SuggestedAppointmentEntity.

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-AppointmentAgent.json post /api/v1/Agents/Appointment/CreateDefaultSuggestedAppointmentEntity
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - AppointmentAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Appointment/CreateDefaultSuggestedAppointmentEntity:
    post:
      tags:
        - Appointment_Agent
      summary: Create Default Suggested Appointment Entity
      description: |-
        Loading default values into a new SuggestedAppointmentEntity.

        NsApiSlow threshold: 2000 ms.
      operationId: v1AppointmentAgent_CreateDefaultSuggestedAppointmentEntity
      parameters:
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.SuggestedAppointmentEntity
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.SuggestedAppointmentEntity
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.SuggestedAppointmentEntity
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.SuggestedAppointmentEntity
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.SuggestedAppointmentEntity
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.SuggestedAppointmentEntity
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.SuggestedAppointmentEntity:
      description: "Carrier object for SuggestedAppointmentEntity.\r\nServices for the SuggestedAppointmentEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAppointmentAgent\">Appointment Agent</see>."
      type: object
      properties:
        SuggestedAppointmentId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Item name, visible in Guide
          type: string
        Tooltip:
          description: Tooltip / description
          type: string
        Rank:
          format: int32
          description: Rank, controls rank of non-instantiated items in Guide
          type: integer
        Deleted:
          description: >-
            0 -> record is active 1 -> record is 'deleted' and should not be
            shown in lists
          type: boolean
        DaysFuture:
          format: int32
          description: How many days into the future the appointment should be scheduled
          type: integer
        Duration:
          description: Duration in minutes of suggested appointment
          type: string
        AutoSuggest:
          description: Should this appointment be auto-suggested
          type: boolean
        IsMilestone:
          description: Is this a milestone activity
          type: boolean
        AssignToMember:
          description: Should this appointment be assigned to project member
          type: boolean
        Text:
          description: The suggested text of the new appointment
          type: string
        ProjectTypeStatusLink:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.ProjectTypeStatusLink'
        SaleTypeStageLink:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleTypeStageLink'
        Type:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.SoTask'
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.ProjectTypeStatusLink:
      description: Carrier object for ProjectTypeStatusLink.
      type: object
      properties:
        ProjectTypeStatusLinkId:
          format: int32
          description: Primary key
          type: integer
        ProjTypeId:
          format: int32
          description: Primary key
          type: integer
        ProjTypeName:
          description: The list item
          type: string
        ProjTypeTooltip:
          description: Tooltip or other description
          type: string
        ProjStatusId:
          format: int32
          description: Primary key
          type: integer
        ProjStatusName:
          description: The list item
          type: string
        ProjStatusTooltip:
          description: Tooltip or other description
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.SaleTypeStageLink:
      description: Carrier object for SaleTypeStageLink.
      type: object
      properties:
        SaleTypeStageLinkId:
          format: int32
          description: Primary key
          type: integer
        SaleTypeId:
          format: int32
          description: Primary key
          type: integer
        SaleTypeName:
          description: The list item
          type: string
        SaleTypeTooltip:
          description: Tooltip or other description
          type: string
        ProbId:
          format: int32
          description: Primary key
          type: integer
        ProbName:
          description: The list item
          type: string
        ProbTooltip:
          description: Tooltip or other description
          type: string
        Probability:
          format: int32
          description: The numeric probability of the sale
          type: integer
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.SoTask:
      description: "Type of an appointment\r\n<para />\r\nCarrier object for SoTask.\r\nServices for the SoTask Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The List Item Id
          type: integer
        Value:
          description: The List Item Value
          type: string
        Tooltip:
          description: The List Item Tooltip
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [NSAppointmentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentAgent.md)
- [SuperOffice.WebApi.Agents.AppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AppointmentAgent.md)
- [SuperOffice.WebApi.Agents.IAppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAppointmentAgent.md)
- [Create Default Appointment Entity From Sale Suggestion](/en/api/reference/restful/agent/appointment_agent/create-default-appointment-entity-from-sale-suggestion.md)
- [Create Default Suggested Document Entity](/en/api/reference/restful/agent/document_agent/create-default-suggested-document-entity.md)
- [Save Suggested Appointment Entity](/en/api/reference/restful/agent/appointment_agent/save-suggested-appointment-entity.md)
