Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB
Notes

Create note

Create note

post/crm/notes

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

The unique identifier of the note

titlestring nullable

The title of the note

contentstring nullable

The content of the note.

owner_idstring nullable

The user that owns the note.

contact_idstring nullable

The contact that is related to the note.

company_idstring nullable

The company that is related to the note.

opportunity_idstring nullable

The opportunity that is related to the note.

activity_idstring nullable

The activity that is related to the note.

lead_idstring nullable

The lead that is related to the note.

activeboolean nullable

Whether the Note is active or not.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_bystring nullable

The user that last updated the note.

created_bystring nullable

The user that created the note.

updated_atstring nullable

The timestamp when the note was last updated

created_atstring nullable

The timestamp when the note was created

Example request

{
  "id": "12345",
  "title": "Meeting Notes",
  "content": "Office hours are 9AM-6PM",
  "owner_id": "12345",
  "contact_id": "12345",
  "company_id": "12345",
  "opportunity_id": "12345",
  "activity_id": "12345",
  "lead_id": "12345",
  "active": true,
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Note created

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "notes",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}