---
title: "Create Dispatch Note"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/operations/postDispatchNote"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md

# Create Dispatch Note

`POST` `/api/fulfillments/notes`

Operation ID: `postDispatchNote`

Create an internal load note for the given dispatch.

## Header parameters

- `Content-Type` (string, required) - The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v1+json`.

## Request body

Content types: `application/json`

## Responses

- `201` - Created. Successful request.
- `400` - Bad Request. Check the request payload. **Scenarios:** - Request body is invalid JSON format.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found.
- `409` - Conflict. Update not allowed based on the current resource state. **Scenarios:** - Dispatch is in archived status.
- `422` - Unprocessable Entity. Errors found in the request. **Scenarios:** - `message` is required. - `message` exceeds maximum length of 250 characters. - Invalid `visibilityType` value.
- `429` - Too Many Requests. Rate limit exceeded.
- `500` - Error.
- `503` - Service Unavailable. Temporary service interruption.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Fulfillment API
  version: 1.0.0
servers:
  - url: https://fulfillment-api.centraldispatch.com
    description: Production server
paths:
  /api/fulfillments/notes:
    post:
      tags:
        - Dispatch
      summary: Create Dispatch Note
      description: Create an internal load note for the given dispatch.
      operationId: postDispatchNote
      parameters:
        - name: Content-Type
          in: header
          description: The major version of the API to make a request against. This is a
            custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to
            request a resource from version 1.x.x of an API, the Content-Type
            header should be set to `application/vnd.coxauto.v1+json`.
          required: true
          schema:
            type: string
          example: application/vnd.coxauto.v1+json
      requestBody:
        description: "`CreateNoteRequest`"
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateNoteRequest"
            examples:
              ex.:
                value:
                  dispatchId: d159acc0-e89b-12d3-a456-426614174000
                  message: Carrier called - pickup rescheduled for tomorrow.
                  visibilityType: INTERNAL
      responses:
        "201":
          description: Created. Successful request.
          headers:
            Location:
              description: Contains the fully qualified URL of the newly created or updated
                resource. The final segment of the URL will equal the ID of the
                resource.
              schema:
                type: string
              example: "8675309"
        "400":
          description: |-
            Bad Request. Check the request payload.

            **Scenarios:**

             - Request body is invalid JSON format.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "404":
          description: Not Found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "409":
          description: |-
            Conflict. Update not allowed based on the current resource state.

            **Scenarios:**

             - Dispatch is in archived status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "422":
          description: |-
            Unprocessable Entity. Errors found in the request.

            **Scenarios:**

             - `message` is required.
             - `message` exceeds maximum length of 250 characters.
             - Invalid `visibilityType` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "429":
          description: Too Many Requests. Rate limit exceeded.
        "500":
          description: Error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "503":
          description: Service Unavailable. Temporary service interruption.
      security:
        - Bearer: []
security:
  - Bearer: []
components:
  schemas:
    CreateNoteRequest:
      type: object
      properties:
        dispatchId:
          type: string
          description: The ID of the dispatch.
          format: uuid
          example: d159acc0-e89b-12d3-a456-426614174000
        message:
          type: string
          description: The content of the note.
          example: Carrier called - pickup rescheduled for tomorrow.
        visibilityType:
          type: string
          description: "The visibility type of the note. Allowed values: `INTERNAL`.
            Defaults to `INTERNAL` if not provided."
          nullable: true
          example: INTERNAL
      description: Details of a note.
      nullable: true
    ErrorsAlt:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: "#/components/schemas/ErrorAlt"
          description: A collection of errors.
          nullable: true
      description: An error occurred, and the request could not be completed.
    ErrorAlt:
      type: object
      properties:
        errorID:
          type: string
          description: The ID of the error.
          nullable: true
          example: 157a16f0-503d-4256-ba60-a4876e8eb9bb
        code:
          type: string
          description: The code used for the issue.
          nullable: true
          example: resource.issue_type
        description:
          type: string
          description: A detailed message.
          nullable: true
          example: The issue happened because something is wrong.
        properties:
          type: array
          items:
            $ref: "#/components/schemas/ErrorAltProperty"
          description: Properties related to the issue.
          nullable: true
      description: Details of an error or issue.
    ErrorAltProperty:
      type: object
      properties:
        property:
          type: string
          description: The name of the property.
          nullable: true
          example: person
        value:
          type: string
          description: The value of the property.
          nullable: true
          example: J0hn D03
      description: Details of an error's property.
  securitySchemes:
    Bearer:
      type: http
      scheme: Bearer
```