## Create a note

`client.Note.New(ctx, body) (*NoteCreateResponse, error)`

**post** `/v1/notes`

Creates a new note record.

The note author is automatically set to the API key owner.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `notes:create`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `body NoteNewParams`

  - `Fields param.Field[NoteNewParamsFields]`

    Field values for the new note. `$title` is required; `$content` is optional. See **[Fields and relationships](/using-the-api/fields-and-relationships/)** for value type details.

    - `Title string`

      Title of the note.

    - `Content string`

      Content of the note as markdown formatted text.

  - `Relationships param.Field[NoteNewParamsRelationships]`

    Relationships to set on the new note. System relationships use a `$` prefix (e.g. `$account`, `$opportunity`). Each value is a single entity ID or an array of IDs. The note author is automatically set to the API key owner.

    - `Account NoteNewParamsRelationshipsAccountUnion`

      ID(s) of accounts to associate with this note.

      - `string`

      - `type NoteNewParamsRelationshipsAccountArray []string`

    - `Opportunity NoteNewParamsRelationshipsOpportunityUnion`

      ID(s) of opportunities to associate with this note.

      - `string`

      - `type NoteNewParamsRelationshipsOpportunityArray []string`

### Returns

- `type NoteCreateResponse struct{…}`

  - `ID string`

    Unique identifier for the entity.

  - `CreatedAt string`

    ISO 8601 timestamp of when the entity was created.

  - `Fields map[string, NoteCreateResponseField]`

    Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.

    - `Value NoteCreateResponseFieldValueUnion`

      The field value, or null if unset.

      - `string`

      - `float64`

      - `bool`

      - `type NoteCreateResponseFieldValueArray []string`

      - `type NoteCreateResponseFieldValueAddress struct{…}`

        - `City string`

          City name.

        - `Country string`

          2-letter ISO 3166-1 alpha-2 country code.

        - `Latitude float64`

          Latitude coordinate.

        - `Longitude float64`

          Longitude coordinate.

        - `PostalCode string`

          Postal or ZIP code.

        - `State string`

          State or province.

        - `Street string`

          Street address line 1.

        - `Street2 string`

          Street address line 2.

      - `type NoteCreateResponseFieldValueFullName struct{…}`

        - `FirstName string`

          The contact's first name.

        - `LastName string`

          The contact's last name.

    - `ValueType string`

      The data type of the field.

      - `const NoteCreateResponseFieldValueTypeAddress NoteCreateResponseFieldValueType = "ADDRESS"`

      - `const NoteCreateResponseFieldValueTypeCheckbox NoteCreateResponseFieldValueType = "CHECKBOX"`

      - `const NoteCreateResponseFieldValueTypeCurrency NoteCreateResponseFieldValueType = "CURRENCY"`

      - `const NoteCreateResponseFieldValueTypeDatetime NoteCreateResponseFieldValueType = "DATETIME"`

      - `const NoteCreateResponseFieldValueTypeEmail NoteCreateResponseFieldValueType = "EMAIL"`

      - `const NoteCreateResponseFieldValueTypeFullName NoteCreateResponseFieldValueType = "FULL_NAME"`

      - `const NoteCreateResponseFieldValueTypeMarkdown NoteCreateResponseFieldValueType = "MARKDOWN"`

      - `const NoteCreateResponseFieldValueTypeMultiSelect NoteCreateResponseFieldValueType = "MULTI_SELECT"`

      - `const NoteCreateResponseFieldValueTypeNumber NoteCreateResponseFieldValueType = "NUMBER"`

      - `const NoteCreateResponseFieldValueTypeSingleSelect NoteCreateResponseFieldValueType = "SINGLE_SELECT"`

      - `const NoteCreateResponseFieldValueTypeSocialHandle NoteCreateResponseFieldValueType = "SOCIAL_HANDLE"`

      - `const NoteCreateResponseFieldValueTypeTelephone NoteCreateResponseFieldValueType = "TELEPHONE"`

      - `const NoteCreateResponseFieldValueTypeText NoteCreateResponseFieldValueType = "TEXT"`

      - `const NoteCreateResponseFieldValueTypeURL NoteCreateResponseFieldValueType = "URL"`

  - `HTTPLink string`

    URL to view the entity in the Lightfield web app, or null.

  - `Relationships map[string, NoteCreateResponseRelationship]`

    Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

    - `Cardinality string`

      Whether the relationship is `has_one` or `has_many`.

    - `ObjectType string`

      The type of the related object (e.g. `account`, `contact`).

    - `Values []string`

      IDs of the related entities.

  - `UpdatedAt string`

    ISO 8601 timestamp of when the entity was last updated, or null.

  - `ExternalID string`

    External identifier for the entity, or null if unset.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  noteCreateResponse, err := client.Note.New(context.TODO(), githubcomlightfldlightfieldgo.NoteNewParams{
    Fields: githubcomlightfldlightfieldgo.NoteNewParamsFields{
      Title: "$title",
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", noteCreateResponse.ID)
}
```

#### Response

```json
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}
```