openapi: 3.2.0
info:
title: Infusionsoft Note API
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.0'
description: 'Operations tagged Note across 7 of this provider''s published API definitions: infusionsoft-keap-sdk-v2-swagger-original.yml, infusionsoft-rest-v1-2025-11-05-openapi-original.json, infusionsoft-rest-v1-openapi-original.json, infusionsoft-rest-v1-openapi.json, infusionsoft-rest-v2-2025-11-05-openapi-original.json, infusionsoft-rest-v2-openapi-original.json, infusionsoft-rest-v2-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.keap.com/crm
- url: https://api.infusionsoft.com/crm/rest
- url: https://api.infusionsoft.com/crm
tags:
- name: Note
paths:
/rest/v2/notes/model/customFields:
post:
tags:
- Note
summary: Create a Custom Field
description: 'Creates a custom field of the specified type and options to the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: createNoteCustomField
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldMetaData'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes/model/customFields/tabs:
get:
tags:
- Note
summary: List Note Custom Field Tabs
description: 'Retrieves a list of custom field tabs for the Note record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: listNoteCustomFieldTabs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomFieldTabsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
post:
tags:
- Note
summary: Create a Note Custom Field Tab
description: 'Creates a new custom field tab for the Note record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: createNoteCustomFieldTab
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldTabRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldTab'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes/model/customFields/groups:
get:
tags:
- Note
summary: List Note Custom Field Groups
description: 'Retrieves a list of custom field groups for the Note record type. Optionally filter by tab_id to scope to a specific tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: listNoteCustomFieldGroups
parameters:
- name: tab_id
in: query
description: Optional tab id to scope groups to a single tab
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomFieldGroupsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
post:
tags:
- Note
summary: Create a Note Custom Field Group
description: 'Creates a new custom field group for the Note record type. If `tab_id` is omitted, the group is added to the default ''Custom Fields'' tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: createNoteCustomFieldGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldGroupRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldGroup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/contacts/{contact_id}/notes:
get:
tags:
- Note
summary: List Notes
description: Retrieves a list of Notes for a given contact
operationId: listNotes
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
- name: filter
in: query
description: "Filter to apply. Allowed fields and operators:\n- (String) `id` — supports `==`, `!=`, `>`, `<`, `>=`, `<=`\n- (String list) `ids` — comma-separated note ids, supports `==` only (e.g. `ids==1,2,3`)\n- (String) `title` — supports `==`. Bare value matches anywhere in the title (contains).\n Wildcard prefix match also supported (e.g. `title==Follow*`)\n- (String) `contact_id`\n- (String) `assigned_to_user_id`\n- (String) `since_time` — ISO-8601 date/time\n- (String) `until_time` — ISO-8601 date/time\n\nOperators must be URL-encoded. Common encodings:\n`==` → `%3D%3D`, `!=` → `!%3D`, `>` → `%3E`, `<` → `%3C`,\n`>=` → `%3E%3D`, `<=` → `%3C%3D`, `*` → `%2A`.\n\nMultiple filters are combined with AND using `;`.\n\nExamples:\n- `filter=contact_id%3D%3D1001`\n- `filter=id%3E5`\n- `filter=ids%3D%3D1,2,3`\n- `filter=title%3D%3DFollow%2A`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z`\n- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z`\n\nCustom fields (when enabled) can be filtered by their field name (case-insensitive).\nA standard field above takes precedence over a custom field with the same name.\nSupported operators depend on the custom field's type:\n- Text-like fields and single-value choice fields with text options (dropdown, radio, state): `==` only, with optional trailing wildcard (e.g. `Priority%3D%3DHigh%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (including user, month, day of week): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601\n- Multi-select fields: `==` matches records that contain the given option\nExample (for a custom field named `Priority`): `filter=Priority%3D%3DHigh`\n\nNotes:\n- `id` and `ids` cannot be combined in the same request.\n- Wildcard `*` may only appear at the end of the value (prefix match).\n Leading wildcards (`*foo`, `*foo*`) are rejected for performance reasons.\n"
required: false
schema:
type: string
- name: order_by
in: query
description: 'Attribute and direction to order items.
One of the following fields:
- `id`
- `create_time`
- `update_time`
One of the following directions:
- `asc`
- `desc`'
required: false
schema:
type: string
- name: page_size
in: query
description: Total number of items to return per page
required: false
schema:
type: integer
format: int32
maximum: 1000
minimum: 0
example: 0
- name: page_token
in: query
description: Page token
required: false
schema:
type: string
- name: fields
in: query
description: 'Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListNotesResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
post:
tags:
- Note
summary: Create a Note
description: Creates a new Note.
operationId: createNote
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
- name: fields
in: query
description: 'Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNoteRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes/model/customFields/{custom_field_id}:
delete:
tags:
- Note
summary: Delete a Note Custom Field
description: 'Deletes a Custom Field from the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: deleteNotesCustomField
parameters:
- name: custom_field_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Note
summary: Update a Custom Field
description: 'Updates a custom field of the specified type and options to the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: updateNotesCustomField
parameters:
- name: custom_field_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
required: false
schema:
type: array
items:
type: string
enum:
- group_id
- label
- options
uniqueItems: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomFieldMetaDataRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldMetaData'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes/model/customFields/tabs/{tab_id}:
get:
tags:
- Note
summary: Retrieve a Note Custom Field Tab
description: 'Retrieves a single custom field tab by id for the Note record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: getNoteCustomFieldTab
parameters:
- name: tab_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldTab'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
delete:
tags:
- Note
summary: Delete a Note Custom Field Tab
description: 'Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: deleteNoteCustomFieldTab
parameters:
- name: tab_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Note
summary: Update a Note Custom Field Tab
description: 'Updates an existing custom field tab. Only fields listed in `update_mask` are applied.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: updateNoteCustomFieldTab
parameters:
- name: tab_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: Comma-separated list of fields to update
required: true
schema:
type: array
items:
type: string
enum:
- name
- order
uniqueItems: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomFieldTabRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldTab'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes/model/customFields/groups/{group_id}:
get:
tags:
- Note
summary: Retrieve a Note Custom Field Group
description: 'Retrieves a single custom field group by id for the Note record type.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: getNoteCustomFieldGroup
parameters:
- name: group_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldGroup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
delete:
tags:
- Note
summary: Delete a Note Custom Field Group
description: 'Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: deleteNoteCustomFieldGroup
parameters:
- name: group_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Note
summary: Update a Note Custom Field Group
description: 'Updates an existing custom field group. Only fields listed in `update_mask` are applied.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: updateNoteCustomFieldGroup
parameters:
- name: group_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: Comma-separated list of fields to update
required: true
schema:
type: array
items:
type: string
enum:
- name
- tab_id
- order
uniqueItems: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomFieldGroupRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldGroup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/contacts/{contact_id}/notes/{note_id}:
get:
tags:
- Note
summary: Retrieve a Note
description: Retrieves the specified Note
operationId: getNote
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
- name: note_id
in: path
required: true
schema:
type: string
- name: fields
in: query
description: 'Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetNoteResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
delete:
tags:
- Note
summary: Delete a Note
description: Deletes the specified Note
operationId: deleteNote
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
- name: note_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Note
summary: Update a Note
description: Updates a Note for a Contact
operationId: updateNote
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
- name: note_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
required: false
schema:
type: array
items:
type: string
enum:
- contact_id
- title
- text
- type
- user_id
- is_pinned
- custom_fields
uniqueItems: true
- name: fields
in: query
description: 'Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNoteRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNoteResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes:
get:
tags:
- Note
summary: List All Notes
description: Retrieves a list of all notes
operationId: listAllNotes
parameters:
- name: filter
in: query
description: "Filter to apply. Allowed fields and operators:\n- (String) `id` — supports `==`, `!=`, `>`, `<`, `>=`, `<=`\n- (String list) `ids` — comma-separated note ids, supports `==` only (e.g. `ids==1,2,3`)\n- (String) `title` — supports `==`. Bare value matches anywhere in the title (contains).\n Wildcard prefix match also supported (e.g. `title==Follow*`)\n- (String) `contact_id`\n- (String) `assigned_to_user_id`\n- (String) `since_time` — ISO-8601 date/time\n- (String) `until_time` — ISO-8601 date/time\n\nOperators must be URL-encoded. Common encodings:\n`==` → `%3D%3D`, `!=` → `!%3D`, `>` → `%3E`, `<` → `%3C`,\n`>=` → `%3E%3D`, `<=` → `%3C%3D`, `*` → `%2A`.\n\nMultiple filters are combined with AND using `;`.\n\nExamples:\n- `filter=contact_id%3D%3D1001`\n- `filter=id%3E5`\n- `filter=ids%3D%3D1,2,3`\n- `filter=title%3D%3DFollow%2A`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z`\n- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z`\n\nCustom fields (when enabled) can be filtered by their field name (case-insensitive).\nA standard field above takes precedence over a custom field with the same name.\nSupported operators depend on the custom field's type:\n- Text-like fields and single-value choice fields with text options (dropdown, radio, state): `==` only, with optional trailing wildcard (e.g. `Priority%3D%3DHigh%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (including user, month, day of week): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601\n- Multi-select fields: `==` matches records that contain the given option\nExample (for a custom field named `Priority`): `filter=Priority%3D%3DHigh`\n\nNotes:\n- `id` and `ids` cannot be combined in the same request.\n- Wildcard `*` may only appear at the end of the value (prefix match).\n Leading wildcards (`*foo`, `*foo*`) are rejected for performance reasons.\n"
required: false
schema:
type: string
- name: page_token
in: query
description: Page token
required: false
schema:
type: string
- name: order_by
in: query
description: 'Attribute and direction to order items.
One of the following fields:
- `id`
- `create_time`
- `update_time`
One of the following directions:
- `asc`
- `desc`'
required: false
schema:
type: string
- name: page_size
in: query
description: Total number of items to return per page
required: false
schema:
type: integer
format: int32
maximum: 1000
minimum: 0
example: 0
- name: fields
in: query
description: 'Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListNotesResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes/templates:
get:
tags:
- Note
summary: Retrieve Note Templates
description: Retrieves a list of Note Templates
operationId: listNoteTemplates
parameters:
- name: filter
in: query
description: Search filter to apply to results
required: false
schema:
type: string
- name: order_by
in: query
description: Attribute and direction to order items by. E.g. `given_name desc`
required: false
schema:
type: string
- name: page_size
in: query
description: Total number of items to return per page
required: false
schema:
type: integer
format: int32
maximum: 1000
minimum: 0
example: 0
- name: page_token
in: query
description: Page token
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListNoteTemplateResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/notes/model:
get:
tags:
- Note
summary: Retrieve Note Model
description: 'Gets the custom fields for the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: retrieveNoteModel
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectModel'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/v1/notes:
get:
tags:
- Note
summary: List Notes
description: Retrieves a list of all notes
operationId: listNotesUsingGET
parameters:
- name: contact_id
in: query
description: Filter based on the contact id assigned to the note.
schema:
type: integer
format: int64
example: 0
- name: limit
in: query
description: Sets a total of items to return
schema:
type: integer
format: int32
example: 0
- name: offset
in: query
description: Sets a beginning range of items to return
schema:
type: integer
format: int32
example: 0
- name: user_id
in: query
description: Filter based on the user id assigned to the note.
schema:
type: integer
format: int64
example: 0
responses:
'200':
description: OK
content:
application/json:
schema:
title: NoteList
type: object
properties:
count:
type: integer
format: int32
next:
type: string
notes:
type: array
items:
title: Note
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
date_created:
type: string
format: date-time
id:
type: integer
format: int64
last_updated:
type: string
format: date-time
last_updated_by:
title: NoteUser
type: object
properties:
family_name:
type: string
given_name:
type: string
user_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
previous:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
post:
tags:
- Note
summary: Create a Note
description: Creates a new note as the authenticated user. Either a "title" or "body" is required
operationId: createNoteUsingPOST
requestBody:
description: createNote
content:
application/json:
schema:
title: RequestNote
required:
- contact_id
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
title: Note
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
date_created:
type: string
format: date-time
id:
type: integer
format: int64
last_updated:
type: string
format: date-time
last_updated_by:
title: NoteUser
type: object
properties:
family_name:
type: string
given_name:
type: string
user_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: createNote
servers:
- url: https://api.infusionsoft.com/crm/rest
/v1/notes/model:
get:
tags:
- Note
summary: Retrieve Note Model
description: Get the custom fields for the Note object
operationId: retrieveNoteModelUsingGET
responses:
'200':
description: OK
content:
application/json:
schema:
title: ObjectModel
type: object
properties:
custom_fields:
type: array
items:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_2'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
optional_properties:
type: array
items:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
servers:
- url: https://api.infusionsoft.com/crm/rest
/v1/notes/model/customFields:
post:
tags:
- Note
summary: Create a Custom Field
description: Adds a custom field of the specified type and options to the Note object.
operationId: createNoteCustomFieldUsingPOST
requestBody:
description: customField
content:
application/json:
schema:
title: CreateRestCustomField
required:
- field_type
- label
type: object
properties:
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
group_id:
type: integer
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
format: int64
label:
type: string
options:
type: array
items:
title: CreateRestCustomFieldOption
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption'
user_group_id:
type: integer
description: An optional user group to choose from when selecting values for User or UserListBox fields.
format: int64
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_2'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: customField
servers:
- url: https://api.infusionsoft.com/crm/rest
/v1/notes/{noteId}:
get:
tags:
- Note
summary: Retrieve a Note
description: Retrieves a single note
operationId: getNoteUsingGET
parameters:
- name: noteId
in: path
description: noteId
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
title: Note
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
date_created:
type: string
format: date-time
id:
type: integer
format: int64
last_updated:
type: string
format: date-time
last_updated_by:
title: NoteUser
type: object
properties:
family_name:
type: string
given_name:
type: string
user_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
put:
tags:
- Note
summary: Replace a Note
description: Replaces all values of a given note
operationId: updateNoteUsingPUT
parameters:
- name: note
in: path
description: note
required: true
schema:
type: integer
format: int64
example: 0
requestBody:
description: requestNote
content:
application/json:
schema:
title: RequestNote
required:
- contact_id
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
title: Note
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
date_created:
type: string
format: date-time
id:
type: integer
format: int64
last_updated:
type: string
format: date-time
last_updated_by:
title: NoteUser
type: object
properties:
family_name:
type: string
given_name:
type: string
user_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: requestNote
delete:
tags:
- Note
summary: Delete a Note
description: Deletes a note
operationId: deleteNoteUsingDELETE
parameters:
- name: noteId
in: path
description: noteId
required: true
schema:
type: integer
format: int64
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
patch:
tags:
- Note
summary: Update a Note
description: Updates a note with only the values provided in the request
operationId: updatePropertiesOnNoteUsingPATCH
parameters:
- name: noteId
in: path
description: noteId
required: true
schema:
type: integer
format: int64
requestBody:
description: note
content:
application/json:
schema:
title: UpdateNote
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
title: Note
type: object
properties:
body:
type: string
contact_id:
type: integer
format: int64
date_created:
type: string
format: date-time
id:
type: integer
format: int64
last_updated:
type: string
format: date-time
last_updated_by:
title: NoteUser
type: object
properties:
family_name:
type: string
given_name:
type: string
user_id:
type: integer
format: int64
title:
type: string
type:
type: string
enum:
- Appointment
- Call
- Email
- Fax
- Letter
- Other
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: note
servers:
- url: https://api.infusionsoft.com/crm/rest
/rest/v1/notes/{noteId}:
get:
tags:
- Note
summary: Retrieve a Note
description: Retrieves a single note
operationId: getNote
parameters:
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Note_2'
security:
- oauth2: []
put:
tags:
- Note
summary: Replace a Note
description: Replaces all values of a given note
operationId: updateNote
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestNote'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Note_2'
security:
- oauth2: []
delete:
tags:
- Note
summary: Delete a Note
description: Deletes a note
operationId: deleteNote
parameters:
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'204':
description: No Content
security:
- oauth2: []
patch:
tags:
- Note
summary: Update a Note
description: Updates a note with only the values provided in the request
operationId: updatePropertiesOnNote
parameters:
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNote'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Note_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/rest/v1/notes/model/customFields:
post:
tags:
- Note
summary: Create a Custom Field
description: Adds a custom field of the specified type and options to the Note object.
operationId: createNoteCustomField
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRestCustomField'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldMetaData_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/rest/v1/notes:
get:
tags:
- Note
summary: List Notes
description: Retrieves a list of all notes
operationId: listNotes
parameters:
- name: noteQueryCommand
in: query
required: true
schema:
$ref: '#/components/schemas/NoteQueryCommand'
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NoteList'
security:
- oauth2: []
post:
tags:
- Note
summary: Create a Note
description: Creates a new note as the authenticated user. Either a "title" or "body" is required
operationId: createNote
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestNote'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Note_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/rest/v1/notes/model:
get:
tags:
- Note
summary: Retrieve Note Model
description: Get the custom fields for the Note object
operationId: retrieveNoteModel
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectModel_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/v2/contacts/{contact_id}/notes:
get:
tags:
- Note
summary: List Notes
description: Retrieves a list of Notes
operationId: listNotesUsingGET_1
parameters:
- name: contact_id
in: path
description: contact_id
required: true
schema:
type: string
- name: filter
in: query
description: 'Filter to apply, allowed fields are:
- (String) `assigned_to_user_id`
- (String) `title`
- (String) `since_time`
- (String) `until_time`
You will need to apply the `==` operator to check the equality of one of the filters with your searched
word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:
- `filter=assigned_to_user_id%3D%3DUserId`
- `filter=title%3D%3DexpectedTitle`
- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z;`
- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z;`
'
schema:
type: string
- name: order_by
in: query
description: 'Attribute and direction to order items.
One of the following fields:
- `id`
- `create_time`
One of the following directions:
- `asc`
- `desc`'
schema:
type: string
- name: page_size
in: query
description: Total number of items to return per page
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
example: 0
- name: page_token
in: query
description: Page token
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
title: ListNotesResponse
type: object
properties:
next_page_token:
type: string
notes:
type: array
items:
title: Note
type: object
properties:
assigned_to_user:
title: BasicUser
type: object
properties:
email_address:
type: string
family_name:
type: string
given_name:
type: string
id:
type: string
contact_id:
type: string
create_time:
type: string
created_by_user_id:
type: string
id:
type: string
last_updated_by_user_id:
type: string
pinned_at:
type: string
text:
type: string
title:
type: string
type:
type: string
update_time:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
post:
tags:
- Note
summary: Create a Note
description: Creates a new Note.
operationId: createNoteUsingPOST_1
parameters:
- name: contact_id
in: path
description: contact_id
required: true
schema:
type: string
requestBody:
description: request
content:
application/json:
schema:
title: CreateNoteRequest
required:
- user_id
type: object
properties:
is_pinned:
type: boolean
text:
type: string
title:
type: string
description: A value for either `title` or `type` is required.
type:
type: string
description: A value for either `title` or `type` is required. The value may be one of `Appointment`, `Call`, `Email`, `Fax`, `Letter` or `Other` in Keap Max/Pro, or an admin-configured value in Classic.
user_id:
type: string
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
title: Note
type: object
properties:
assigned_to_user:
title: BasicUser
type: object
properties:
email_address:
type: string
family_name:
type: string
given_name:
type: string
id:
type: string
contact_id:
type: string
create_time:
type: string
created_by_user_id:
type: string
id:
type: string
last_updated_by_user_id:
type: string
pinned_at:
type: string
text:
type: string
title:
type: string
type:
type: string
update_time:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: request
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/contacts/{contact_id}/notes/{note_id}:
get:
tags:
- Note
summary: Retrieve a Note
description: Retrieves the specified Note
operationId: getNoteUsingGET_1
parameters:
- name: contact_id
in: path
description: contact_id
required: true
schema:
type: string
- name: note_id
in: path
description: note_id
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
title: GetNoteResponse
type: object
properties:
assigned_to_user:
title: BasicUser
type: object
properties:
email_address:
type: string
family_name:
type: string
given_name:
type: string
id:
type: string
contact_id:
type: string
create_time:
type: string
created_by_user_id:
type: string
id:
type: string
last_updated_by_user_id:
type: string
pinned_at:
type: string
text:
type: string
title:
type: string
type:
type: string
update_time:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
delete:
tags:
- Note
summary: Delete a Note
description: Deletes the specified Note
operationId: deleteNoteUsingDELETE_1
parameters:
- name: contact_id
in: path
description: contact_id
required: true
schema:
type: string
- name: note_id
in: path
description: note_id
required: true
schema:
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
patch:
tags:
- Note
summary: Update a Note
description: Updates a Note for a Contact
operationId: updateNoteUsingPATCH
parameters:
- name: contact_id
in: path
description: contact_id
required: true
schema:
type: string
- name: note_id
in: path
description: note_id
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- contact_id
- text
- title
- type
- user_id
requestBody:
description: updateNoteRequest
content:
application/json:
schema:
title: UpdateNoteRequest
required:
- user_id
type: object
properties:
contact_id:
type: string
is_pinned:
type: boolean
text:
type: string
title:
type: string
description: A value for either `title` or `type` is required.
type:
type: string
description: A value for either `title` or `type` is required. The value may be one of `Appointment`, `Call`, `Email`, `Fax`, `Letter` or `Other` in Keap Max/Pro, or an admin-configured value in Classic.
user_id:
type: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
title: UpdateNoteResponse
type: object
properties:
assigned_to_user:
title: BasicUser
type: object
properties:
email_address:
type: string
family_name:
type: string
given_name:
type: string
id:
type: string
contact_id:
type: string
create_time:
type: string
created_by_user_id:
type: string
id:
type: string
last_updated_by_user_id:
type: string
pinned_at:
type: string
text:
type: string
title:
type: string
type:
type: string
update_time:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: updateNoteRequest
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/notes/model:
get:
tags:
- Note
summary: Retrieve Note Model
description: 'Gets the custom fields for the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: retrieveNoteModelUsingGET_1
responses:
'200':
description: OK
content:
application/json:
schema:
title: ObjectModel
type: object
properties:
custom_fields:
type: array
items:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
optional_properties:
type: array
description: These fields are not transmitted by default on this model, but can be requested by specifying them in a comma-separated list in the optional_properties query parameter.
items:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/notes/model/customFields:
post:
tags:
- Note
summary: Create a Custom Field
description: 'Creates a custom field of the specified type and options to the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: createNoteCustomFieldUsingPOST_1
requestBody:
description: customField
content:
application/json:
schema:
title: CreateCustomFieldRequest
required:
- field_type
- label
type: object
properties:
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
label:
type: string
options:
type: array
items:
title: CreateCustomFieldOptionRequest
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateCustomFieldOptionRequest_2'
user_group_id:
type: string
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: customField
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/notes/model/customFields/{custom_field_id}:
patch:
tags:
- Note
summary: Update a Custom Field
description: 'Updates a custom field of the specified type and options to the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: updateNotesCustomFieldUsingPATCH
parameters:
- name: custom_field_id
in: path
description: custom_field_id
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- group_id
- label
- options
requestBody:
description: request
content:
application/json:
schema:
title: UpdateCustomFieldMetaDataRequest
required:
- group_id
type: object
properties:
group_id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: request
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/notes/templates:
get:
tags:
- Note
summary: Retrieve Note Templates
description: Retrieves a list of Note Templates
operationId: listNoteTemplatesUsingGET
parameters:
- name: filter
in: query
description: Search filter to apply to results
schema:
type: string
- name: order_by
in: query
description: Attribute and direction to order items by. E.g. `given_name desc`
schema:
type: string
- name: page_size
in: query
description: Total number of items to return per page
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
example: 0
- name: page_token
in: query
description: Page token
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
title: ListNoteTemplateResponse
type: object
properties:
next_page_token:
type: string
note_templates:
type: array
items:
title: NoteTemplate
type: object
properties:
action_type:
type: string
enum:
- APPOINTMENT
- CALL
- EMAIL
- FAX
- LETTER
- OTHER
assignment_user_id:
type: integer
format: int64
description:
type: string
id:
type: string
notify_users:
type: array
items:
type: string
title:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
servers:
- url: https://api.infusionsoft.com/crm/rest
components:
schemas:
CustomFieldValueObject:
type: object
properties:
id:
type: string
content:
description: The value of the custom field. Text custom field values have a maximum length of 65535 characters.
UpdateCustomFieldTabRequest:
type: object
properties:
name:
type: string
order:
type: integer
format: int32
CreateCustomFieldGroupRequest:
type: object
properties:
name:
type: string
tab_id:
type: string
CustomFieldGroup:
type: object
properties:
id:
type: string
name:
type: string
order:
type: integer
format: int32
tab_id:
type: string
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
CustomFieldOption:
type: object
properties:
id:
type: string
label:
type: string
ListCustomFieldTabsResponse:
type: object
properties:
tabs:
type: array
items:
$ref: '#/components/schemas/CustomFieldTab'
NoteTemplate:
type: object
properties:
id:
type: string
description: Template ID
example: 5001
title:
type: string
description: Template title
example: Post-Sale Follow-up
description:
type: string
description: Template description
example: Follow up within 24 hours of purchase
action_type:
type: string
description: Note action type
example: Call
assignment_user_id:
type: integer
format: int64
description: Default assigned user ID
example: 100
notify_users:
type: array
description: List of user IDs to notify
items:
type: string
UpdateCustomFieldGroupRequest:
type: object
properties:
name:
type: string
order:
type: integer
format: int32
tab_id:
type: string
CustomFieldTab:
type: object
properties:
id:
type: string
description: The unique identifier of the custom field tab
example: 123
name:
type: string
description: The name of the custom field tab
example: Personal Info
order:
type: integer
format: int32
description: The display order of the tab
example: 1
record_type:
type: string
description: The record type this tab belongs to (e.g., CONTACT, COMPANY, OPPORTUNITY, REFERRAL_PARTNER, ORDER, SUBSCRIPTION, TASK_NOTE_APPOINTMENT)
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
example: CONTACT
Error:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
status:
type: string
details:
type: array
items:
$ref: '#/components/schemas/ErrorDetails'
CustomFieldMetaData:
type: object
description: Metadata describing a custom field, including its type and options
properties:
id:
type: string
description: The unique identifier of the custom field
example: 123
label:
type: string
description: The display label of the custom field
example: Favorite Color
options:
type: array
description: The list of available options for select/radio/multiselect/drilldown field types
items:
$ref: '#/components/schemas/CustomFieldOption'
record_type:
type: string
description: The entity type this custom field belongs to (e.g. CONTACT, COMPANY)
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
field_type:
type: string
description: The data type of the custom field (e.g. Text, Number, Date, Select)
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
default_value:
type: string
description: The default value for this custom field, if any
group_id:
type: string
description: The ID of the group this custom field belongs to
example: 45
group_name:
type: string
description: The name of the group this custom field belongs to
example: Personal Info
field_name:
type: string
description: The database column name for this custom field. Use this value when filtering contacts (e.g. for field_name 'firstName1', filter with 'firstName1==John').
example: firstName1
CreateCustomFieldOptionRequest:
type: object
properties:
label:
type: string
Note:
type: object
properties:
id:
type: string
description: Note ID
example: 12345
text:
type: string
description: Note content
example: Called about the Q3 proposal
title:
type: string
description: Note title
example: Sales Call
type:
type: string
description: Note type
example: Call
contact_id:
type: string
description: Associated contact ID
example: 1001
assigned_to_user:
$ref: '#/components/schemas/BasicUser'
description: User assigned to this note
create_time:
type: string
description: Creation timestamp (ISO-8601)
example: '2024-01-10T08:00:00Z'
update_time:
type: string
description: Last update timestamp (ISO-8601)
example: '2024-03-15T10:30:00Z'
last_updated_by_user_id:
type: string
description: ID of user who last updated
example: 456
pinned_at:
type: string
description: Pin timestamp (ISO-8601), null if not pinned
example: '2024-02-18T16:45:00Z'
created_by_user_id:
type: string
description: ID of user who created
example: 789
custom_fields:
type: array
description: Custom field values for the note
example:
- id: '1'
content: Red
- id: '2'
content: Preferred
items:
$ref: '#/components/schemas/CustomFieldValueObject'
CreateCustomFieldTabRequest:
type: object
properties:
name:
type: string
ListNotesResponse:
type: object
properties:
notes:
type: array
items:
$ref: '#/components/schemas/Note'
next_page_token:
type: string
ObjectModel:
type: object
properties:
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldMetaData'
optional_properties:
type: array
description: These fields are not transmitted by default on this model, but can be requested by specifying them in a comma-separated list in the optional_properties query parameter.
items:
type: string
uniqueItems: true
ErrorDetails:
type: object
properties:
domain:
type: string
resource:
type: string
CreateNoteRequest:
type: object
properties:
title:
type: string
description: A value for either `title` or `type` is required.
example: Follow-up Meeting
text:
type: string
description: Note content
example: Discussed pricing for contract renewal
type:
type: string
description: A value for either `title` or `type` is required. The value may be one of `Appointment`, `Call`, `Email`, `Fax`, `Letter` or `Other` in Keap Max/Pro, or an admin-configured value in Classic.
example: Call
user_id:
type: string
description: ID of user creating the note
example: 123
is_pinned:
type: boolean
description: Whether to pin this note
example: false
custom_fields:
type: array
description: Custom field values for the note. An empty array resets all custom fields to their defaults.
example:
- id: '1'
content: Red
items:
$ref: '#/components/schemas/CustomFieldValueObject'
required:
- user_id
CreateCustomFieldRequest:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateCustomFieldOptionRequest'
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
user_group_id:
type: string
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required:
- field_type
- label
UpdateNoteRequest:
type: object
properties:
title:
type: string
description: A value for either `title` or `type` is required.
example: Follow-up Meeting
text:
type: string
description: Note content
example: Discussed pricing for contract renewal
type:
type: string
description: A value for either `title` or `type` is required. The value may be one of `Appointment`, `Call`, `Email`, `Fax`, `Letter` or `Other` in Keap Max/Pro, or an admin-configured value in Classic.
example: Call
user_id:
type: string
description: ID of user creating the note
example: 123
is_pinned:
type: boolean
description: Whether to pin this note
example: false
custom_fields:
type: array
description: Custom field values for the note. An empty array resets all custom fields to their defaults.
example:
- id: '1'
content: Red
items:
$ref: '#/components/schemas/CustomFieldValueObject'
contact_id:
type: string
description: Associated contact ID
example: 1001
required:
- user_id
UpdateCustomFieldMetaDataRequest:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption'
group_id:
type: string
required:
- group_id
ListNoteTemplateResponse:
type: object
properties:
note_templates:
type: array
items:
$ref: '#/components/schemas/NoteTemplate'
next_page_token:
type: string
UpdateNoteResponse:
type: object
properties:
id:
type: string
description: Note ID
example: 12345
text:
type: string
description: Note content
example: Called about the Q3 proposal
title:
type: string
description: Note title
example: Sales Call
type:
type: string
description: Note type
example: Call
contact_id:
type: string
description: Associated contact ID
example: 1001
assigned_to_user:
$ref: '#/components/schemas/BasicUser'
description: User assigned to this note
create_time:
type: string
description: Creation timestamp (ISO-8601)
example: '2024-01-10T08:00:00Z'
update_time:
type: string
description: Last update timestamp (ISO-8601)
example: '2024-03-15T10:30:00Z'
last_updated_by_user_id:
type: string
description: ID of user who last updated
example: 456
pinned_at:
type: string
description: Pin timestamp (ISO-8601), null if not pinned
example: '2024-02-18T16:45:00Z'
created_by_user_id:
type: string
description: ID of user who created
example: 789
custom_fields:
type: array
description: Custom field values for the note
example:
- id: '1'
content: Red
- id: '2'
content: Preferred
items:
$ref: '#/components/schemas/CustomFieldValueObject'
BasicUser:
type: object
properties:
id:
type: string
description: User ID
example: 456
given_name:
type: string
description: First name
example: Jane
family_name:
type: string
description: Last name
example: Doe
email_address:
type: string
description: Email address
example: jane.doe@example.com
ListCustomFieldGroupsResponse:
type: object
properties:
groups:
type: array
items:
$ref: '#/components/schemas/CustomFieldGroup'
GetNoteResponse:
type: object
properties:
id:
type: string
description: Note ID
example: 12345
text:
type: string
description: Note content
example: Called about the Q3 proposal
title:
type: string
description: Note title
example: Sales Call
type:
type: string
description: Note type
example: Call
contact_id:
type: string
description: Associated contact ID
example: 1001
assigned_to_user:
$ref: '#/components/schemas/BasicUser'
description: User assigned to this note
create_time:
type: string
description: Creation timestamp (ISO-8601)
example: '2024-01-10T08:00:00Z'
update_time:
type: string
description: Last update timestamp (ISO-8601)
example: '2024-03-15T10:30:00Z'
last_updated_by_user_id:
type: string
description: ID of user who last updated
example: 456
pinned_at:
type: string
description: Pin timestamp (ISO-8601), null if not pinned
example: '2024-02-18T16:45:00Z'
created_by_user_id:
type: string
description: ID of user who created
example: 789
custom_fields:
type: array
description: Custom field values for the note
example:
- id: '1'
content: Red
- id: '2'
content: Preferred
items:
$ref: '#/components/schemas/CustomFieldValueObject'
CustomFieldOption_2:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_2'
CreateRestCustomFieldOption:
title: CreateRestCustomFieldOption
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption'
Throwable:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
CustomFieldMetaData_2:
type: object
properties:
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
field_name:
type: string
default_value:
type: string
DefaultHttpStatusCode:
allOf:
- $ref: '#/components/schemas/HttpStatusCode'
ModelAndView:
type: object
properties:
view:
$ref: '#/components/schemas/View'
model:
type: object
additionalProperties: {}
status:
oneOf:
- $ref: '#/components/schemas/DefaultHttpStatusCode'
- $ref: '#/components/schemas/HttpStatus'
modelMap:
type: object
additionalProperties: {}
properties:
empty:
type: boolean
reference:
type: boolean
empty:
type: boolean
viewName:
type: string
NoteUser:
type: object
properties:
user_id:
type: integer
format: int64
given_name:
type: string
family_name:
type: string
HttpStatusCode:
type: object
properties:
error:
type: boolean
is1xxInformational:
type: boolean
is2xxSuccessful:
type: boolean
is3xxRedirection:
type: boolean
is4xxClientError:
type: boolean
is5xxServerError:
type: boolean
HttpStatus:
allOf:
- $ref: '#/components/schemas/HttpStatusCode'
enum:
- 100 CONTINUE
- 101 SWITCHING_PROTOCOLS
- 102 PROCESSING
- 103 EARLY_HINTS
- 200 OK
- 201 CREATED
- 202 ACCEPTED
- 203 NON_AUTHORITATIVE_INFORMATION
- 204 NO_CONTENT
- 205 RESET_CONTENT
- 206 PARTIAL_CONTENT
- 207 MULTI_STATUS
- 208 ALREADY_REPORTED
- 226 IM_USED
- 300 MULTIPLE_CHOICES
- 301 MOVED_PERMANENTLY
- 302 FOUND
- 303 SEE_OTHER
- 304 NOT_MODIFIED
- 307 TEMPORARY_REDIRECT
- 308 PERMANENT_REDIRECT
- 400 BAD_REQUEST
- 401 UNAUTHORIZED
- 402 PAYMENT_REQUIRED
- 403 FORBIDDEN
- 404 NOT_FOUND
- 405 METHOD_NOT_ALLOWED
- 406 NOT_ACCEPTABLE
- 407 PROXY_AUTHENTICATION_REQUIRED
- 408 REQUEST_TIMEOUT
- 409 CONFLICT
- 410 GONE
- 411 LENGTH_REQUIRED
- 412 PRECONDITION_FAILED
- 413 CONTENT_TOO_LARGE
- 413 PAYLOAD_TOO_LARGE
- 414 URI_TOO_LONG
- 415 UNSUPPORTED_MEDIA_TYPE
- 416 REQUESTED_RANGE_NOT_SATISFIABLE
- 417 EXPECTATION_FAILED
- 418 I_AM_A_TEAPOT
- 421 MISDIRECTED_REQUEST
- 422 UNPROCESSABLE_CONTENT
- 422 UNPROCESSABLE_ENTITY
- 423 LOCKED
- 424 FAILED_DEPENDENCY
- 425 TOO_EARLY
- 426 UPGRADE_REQUIRED
- 428 PRECONDITION_REQUIRED
- 429 TOO_MANY_REQUESTS
- 431 REQUEST_HEADER_FIELDS_TOO_LARGE
- 451 UNAVAILABLE_FOR_LEGAL_REASONS
- 500 INTERNAL_SERVER_ERROR
- 501 NOT_IMPLEMENTED
- 502 BAD_GATEWAY
- 503 SERVICE_UNAVAILABLE
- 504 GATEWAY_TIMEOUT
- 505 HTTP_VERSION_NOT_SUPPORTED
- 506 VARIANT_ALSO_NEGOTIATES
- 507 INSUFFICIENT_STORAGE
- 508 LOOP_DETECTED
- 509 BANDWIDTH_LIMIT_EXCEEDED
- 510 NOT_EXTENDED
- 511 NETWORK_AUTHENTICATION_REQUIRED
CreateRestCustomField:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption_2'
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
group_id:
type: integer
format: int64
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
user_group_id:
type: integer
format: int64
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required:
- field_type
- label
UpdateNote:
type: object
description: note
properties:
title:
type: string
body:
type: string
type:
type: string
enum:
- Appointment, Call, Email, Fax, Letter, Other
contact_id:
type: integer
format: int64
user_id:
type: integer
format: int64
CreateRestCustomFieldOption_2:
type: object
properties:
label:
type: string
View:
type: object
properties:
contentType:
type: string
Note_2:
type: object
properties:
id:
type: integer
format: int64
title:
type: string
body:
type: string
type:
type: string
enum:
- Appointment, Call, Email, Fax, Letter, Other
contact_id:
type: integer
format: int64
user_id:
type: integer
format: int64
last_updated_by:
$ref: '#/components/schemas/NoteUser'
date_created:
type: string
format: date-time
last_updated:
type: string
format: date-time
NoteQueryCommand:
type: object
properties:
limit:
type: integer
format: int32
offset:
type: integer
format: int32
user_id:
type: integer
format: int64
contact_id:
type: integer
format: int64
NoteList:
type: object
properties:
notes:
type: array
items:
$ref: '#/components/schemas/Note_2'
count:
type: integer
format: int32
next:
type: string
previous:
type: string
RequestNote:
type: object
properties:
title:
type: string
body:
type: string
type:
type: string
enum:
- Appointment, Call, Email, Fax, Letter, Other
contact_id:
type: integer
format: int64
user_id:
type: integer
format: int64
required:
- contact_id
ObjectModel_2:
type: object
properties:
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldMetaData_2'
optional_properties:
type: array
items:
type: string
uniqueItems: true
CustomFieldMetaData_3:
type: object
properties:
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
field_name:
type: string
default_value:
type: string
CreateRestCustomField_2:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption_3'
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
group_id:
type: integer
format: int64
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
user_group_id:
type: integer
format: int64
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required:
- field_type
- label
CreateRestCustomFieldOption_3:
type: object
properties:
label:
type: string
Note_3:
type: object
properties:
id:
type: integer
format: int64
title:
type: string
body:
type: string
type:
type: string
enum:
- Appointment, Call, Email, Fax, Letter, Other
contact_id:
type: integer
format: int64
user_id:
type: integer
format: int64
last_updated_by:
$ref: '#/components/schemas/NoteUser'
date_created:
type: string
format: date-time
last_updated:
type: string
format: date-time
NoteList_2:
type: object
properties:
notes:
type: array
items:
$ref: '#/components/schemas/Note_3'
count:
type: integer
format: int32
next:
type: string
previous:
type: string
ObjectModel_3:
type: object
properties:
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldMetaData_3'
optional_properties:
type: array
items:
type: string
uniqueItems: true
CreateCustomFieldOptionRequest_2:
title: CreateCustomFieldOptionRequest
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateCustomFieldOptionRequest_2'
CustomFieldOption_3:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://accounts.infusionsoft.com/app/oauth/authorize
tokenUrl: https://api.infusionsoft.com/token
scopes: {}
x-refined-from:
- infusionsoft-keap-sdk-v2-swagger-original.yml
- infusionsoft-rest-v1-2025-11-05-openapi-original.json
- infusionsoft-rest-v1-openapi-original.json
- infusionsoft-rest-v1-openapi.json
- infusionsoft-rest-v2-2025-11-05-openapi-original.json
- infusionsoft-rest-v2-openapi-original.json
- infusionsoft-rest-v2-openapi.json