> ## 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 Recurrence

> Creates a RecurrenceInfo object populated with the default values for the specific type.

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-AppointmentAgent.json post /api/v1/Agents/Appointment/CreateDefaultRecurrence
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/CreateDefaultRecurrence:
    post:
      tags:
        - Appointment_Agent
      summary: Create Default Recurrence
      description: >-
        Creates a RecurrenceInfo object populated with the default values for
        the specific type.


        NsApiSlow threshold: 2000 ms.
      operationId: v1AppointmentAgent_CreateDefaultRecurrence
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - 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.RecurrenceInfo'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceInfo'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceInfo'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceInfo'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceInfo'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.RecurrenceInfo:
      description: Class representing the recurrence of an appointment booking
      type: object
      properties:
        RecurrenceId:
          format: int32
          description: The recurrence rule id
          type: integer
        StartDate:
          format: date-time
          description: Start date of the repetition pattern
          type: string
        EndDate:
          format: date-time
          description: "End date of the repetition pattern\r\nOnly used when the end is calculated from a end date. {SuperOffice.Data.RecurrenceEndType.EndDate}"
          type: string
        RecurrenceCounter:
          format: int32
          description: "Number of recurrences\r\nOnly used when the end is calculated from a number of repetitions. {SuperOffice.Data.RecurrenceEndType.Counter}"
          type: integer
        RecurrenceEndType:
          description: >-
            Type defining how the end of the recurrence sequence should be
            calculated
          enum:
            - Unknown
            - EndDate
            - Counter
          type: string
        Pattern:
          description: The recurrence pattern (Daily, Weekly, Monthly, Yearly, Custom)
          enum:
            - Unknown
            - Daily
            - Weekly
            - Monthly
            - Yearly
            - Custom
          type: string
        DayPattern:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceDayPattern'
        WeekPattern:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceWeekPattern'
        MonthPattern:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceMonthPattern'
        YearPattern:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceYearPattern'
        Dates:
          description: List of all dates where this recurrence occurs
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceDate'
        IsRecurrence:
          description: >-
            Get a or set IsRecurrence, indicating if this is a repeating
            appointment or not.
          type: boolean
    SuperOffice.CRM.Services.RecurrenceDayPattern:
      description: Class representing a pattern for daily recurrence
      type: object
      properties:
        Pattern:
          description: The type of daily recurrence pattern
          enum:
            - Unknown
            - EveryWorkday
            - EveryWeekday
            - EveryCyclicDay
          type: string
        Cycle:
          format: int32
          description: "The number of days between each recurrence.\r\nOnly used when the cyclic pattern occurs. {SuperOffice.Data.RecurrenceDailyPattern.EveryCyclicDay}"
          type: integer
    SuperOffice.CRM.Services.RecurrenceWeekPattern:
      description: Class representing a pattern for weekly recurrence
      type: object
      properties:
        Weekdays:
          description: The weekdays the recurrence should occur for
          enum:
            - Unknown
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          type: string
        Cycle:
          format: int32
          description: The number of weeks between each repetition
          type: integer
    SuperOffice.CRM.Services.RecurrenceMonthPattern:
      description: Class representing a pattern for monthly recurrence
      type: object
      properties:
        Pattern:
          description: The type of monthly recurrence pattern
          enum:
            - Unknown
            - DayOfMonth
            - WeekdayOfMonth
          type: string
        Cycle:
          format: int32
          description: The number of months between each repetition
          type: integer
        Day:
          format: int32
          description: "The day of the month when the recurrence occurs\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.DayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.DayOfMonth}"
          type: integer
        Weekday:
          description: "The weekday of the recurring pattern. \r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}"
          enum:
            - Unknown
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          type: string
        WeekOfMonth:
          description: "The week of the month\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}"
          enum:
            - Unknown
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
    SuperOffice.CRM.Services.RecurrenceYearPattern:
      description: Class representing a pattern for yearly recurrence
      type: object
      properties:
        Pattern:
          description: The type of yearly recurrence pattern
          enum:
            - Unknown
            - DayOfMonth
            - WeekdayOfMonth
          type: string
        Cycle:
          format: int32
          description: >-
            The month of the year where the recurrence occurs. 1 is January and
            12 is December.
          type: integer
        Day:
          format: int32
          description: "The day of the month when the recurrence occurs\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.DayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.DayOfMonth}"
          type: integer
        Weekday:
          description: "The weekday of the recurring pattern. \r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}"
          enum:
            - Unknown
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          type: string
        WeekOfMonth:
          description: "The week of the month\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}"
          enum:
            - Unknown
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
    SuperOffice.CRM.Services.RecurrenceDate:
      description: Class representing a Date for recurrence.
      type: object
      properties:
        Date:
          format: date-time
          description: Date of the recurrence.
          type: string
        IsConflict:
          description: Is there a conflict for this occurrence.
          type: boolean
        Description:
          description: Conflict or day (e.g. red, blue, etc. letter-day) name.
          type: string
        DescriptionStyleHint:
          description: Style hint for the description (i.e. red for red-letter-days)
          type: string
        Tooltip:
          description: Description of conflict or other things happening this day.
          type: string

````

## Related topics

- [Create Default Recurrence By Date](/en/api/reference/restful/agent/appointment_agent/create-default-recurrence-by-date.md)
- [SuperOffice.WebApi.Data.Appointment CreateDefaultRecurrenceRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_CreateDefaultRecurrenceRequest.md)
- [SuperOffice.WebApi.Data.Appointment CreateDefaultRecurrenceByDateRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_CreateDefaultRecurrenceByDateRequest.md)
- [Create repeating follow-ups](/en/automation/crmscript/howto/diary/create-recurring-appointment.md)
- [NSAppointmentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentAgent.md)
- [SuperOffice.WebApi.Agents.AppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AppointmentAgent.md)
