> ## Documentation Index
> Fetch the complete documentation index at: https://detrack.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a contact

> POST /dn/contacts adds one contact to your address book. Send a name or company and an address.

Add one contact to your Detrack address book. A contact needs `deliver_to_collect_from` or `company_name`, and an `address` unless you send `address_1`, `address_2`, or `address_3`. The response is the new contact with its `id`, and the `Location` header has its URL.

Detrack doesn't check for duplicates, so creating the same contact twice saves it twice. To change a contact you've already saved, use [Update a contact](https://detrack.mintlify.site/api-reference/contacts/update.md). To add up to 100 contacts in one request, use [Bulk create contacts](https://detrack.mintlify.site/api-reference/contacts/bulk-create.md).

See [Contacts](https://detrack.mintlify.site/concepts/contacts.md) for how addresses and groups work.


## OpenAPI

````yaml POST /dn/contacts
openapi: 3.0.3
info:
  title: Detrack REST API v2
  version: '2.0'
  description: >-
    Detrack REST API v2. Checked against detrack-webapp origin/main (production)
    on 2026-09-29: dn_jobs.rb @ d246ad006, dn_depots.rb @ 2a5f387, dn_routes.rb
    @ 50a73a9, app_helper.rb @ d745ad2, dn_jobs_helper.rb @ d296e30,
    job_decorator.rb @ 3041da7, run_location_decorator.rb @ 0f0274d,
    vehicle_route_plan_decorator.rb and tsp_route_decorator.rb @ 7d1f3ef,
    data_export.rb @ ed4e135. Vehicle check submissions checked against
    origin/main on 2026-11-03: dn_vehicle_checklist_submissions.rb @ 3071523d1,
    vehicle_checklist_submission_decorator.rb @ f4002c957,
    vehicle_checklist_submission.rb @ b80aea03c,
    vehicle_checklist_submission_rules.rb @ e55194ed7. Contacts checked against
    origin/main on 2026-11-04: dn_contacts.rb, contacts_helper.rb and contact.rb
    @ a1b3694a0, contact_decorator.rb @ a51f1eab7.
servers:
  - url: https://app.detrack.com/api/v2
security:
  - apiKey: []
tags:
  - name: Jobs
    description: Deliveries and collections.
  - name: Depots
    description: Saved warehouse and pickup locations.
  - name: Contacts
    description: Your address book of saved recipients.
  - name: Routes
    description: Optimized multi-stop plans across vehicles.
  - name: Vehicle checks
    description: >-
      Checklists your drivers submit for a vehicle, such as start-of-day and
      end-of-day checks.
paths:
  /dn/contacts:
    post:
      tags:
        - Contacts
      summary: Create a contact
      operationId: createContact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - data
              properties:
                data:
                  $ref: '#/components/schemas/ContactInput'
            example:
              data:
                deliver_to_collect_from: James Li
                address: 61 Kaki Bukit Ave 1, Singapore 417943
                phone_number: '65432178'
      responses:
        '201':
          description: The created contact. The `Location` header has its URL.
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://app.detrack.com/api/v2/dn/contacts/65263b0c29e804cae4fedd76
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Contact'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ContactValidationFailed'
        default:
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    ContactInput:
      type: object
      description: >-
        Contact fields you can send. On update, send only the fields you want to
        change. A contact needs `deliver_to_collect_from` or `company_name`.
      properties:
        deliver_to_collect_from:
          type: string
          description: Recipient's name. Required unless you send `company_name`.
          example: James Li
        company_name:
          type: string
          description: Required unless you send `deliver_to_collect_from`.
        last_name:
          type: string
        address:
          type: string
          description: >-
            Full address. Required unless you send `address_1`, `address_2`, or
            `address_3`. On create, Detrack adds any `address_1` to `address_3`,
            `city`, `state`, and `postal_code` you send to the end of `address`,
            so send the full address here or the parts, not both.
          example: 61 Kaki Bukit Ave 1, Singapore 417943
        address_1:
          type: string
          description: Address line 1.
        address_2:
          type: string
          description: Address line 2.
        address_3:
          type: string
          description: Address line 3.
        postal_code:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        address_lat:
          type: number
        address_lng:
          type: number
        phone_number:
          type: string
          example: '65432178'
        fax_number:
          type: string
        notify_email:
          type: string
          example: test@example.com
        job_time:
          type: string
        customer:
          type: string
        zone:
          type: string
        instructions:
          type: string
        boxes:
          type: string
        cubic_meters:
          type: number
        cartons:
          type: integer
        pieces:
          type: integer
        envelopes:
          type: integer
        pallets:
          type: integer
        remarks:
          type: string
        account_number:
          type: string
        sales_person:
          type: string
        sender_phone_number:
          type: string
        pick_up_from:
          type: string
        pick_up_time:
          type: string
        pick_up_address:
          type: string
        pick_up_address_1:
          type: string
        pick_up_address_2:
          type: string
        pick_up_address_3:
          type: string
        pick_up_city:
          type: string
        pick_up_state:
          type: string
        pick_up_country:
          type: string
        pick_up_postal_code:
          type: string
        pick_up_zone:
          type: string
        pick_up_lat:
          type: number
        pick_up_lng:
          type: number
        groups:
          type: array
          description: >-
            Groups the contact belongs to, by `id`. If your API key's user only
            has access to some groups, a new contact must be in at least one of
            them. If the user has exactly one group and you don't send `groups`,
            the contact goes in that group.
          items:
            type: object
            required:
              - id
            properties:
              id:
                type: string
                example: 5e8b2f1a29e804cae4fe0a11
        items:
          type: array
          description: >-
            Saved line items. On update, the items you send are added to or
            change the contact's items; they don't replace the list.
          items:
            $ref: '#/components/schemas/ContactItemInput'
    Contact:
      type: object
      description: >-
        A saved recipient. Empty fields are `null`. The pick-up fields
        (`pick_up_*`) are returned only if your account uses point-to-point
        jobs.
      properties:
        id:
          type: string
          readOnly: true
          example: 65263b0c29e804cae4fedd76
        deliver_to_collect_from:
          type: string
          nullable: true
          description: Recipient's name.
          example: James Li
        last_name:
          type: string
          nullable: true
        job_time:
          type: string
          nullable: true
        customer:
          type: string
          nullable: true
        company_name:
          type: string
          nullable: true
          example: Detrack
        address:
          type: string
          nullable: true
          example: 61 Kaki Bukit Ave 1, Singapore 417943
        postal_code:
          type: string
          nullable: true
        address_1:
          type: string
          nullable: true
        address_2:
          type: string
          nullable: true
        address_3:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        address_lat:
          type: number
          nullable: true
        address_lng:
          type: number
          nullable: true
        phone_number:
          type: string
          nullable: true
          example: '65432178'
        fax_number:
          type: string
          nullable: true
        notify_email:
          type: string
          nullable: true
          example: test@example.com
        zone:
          type: string
          nullable: true
        instructions:
          type: string
          nullable: true
        boxes:
          type: string
          nullable: true
        cubic_meters:
          type: number
          nullable: true
        cartons:
          type: integer
          nullable: true
        pieces:
          type: integer
          nullable: true
        envelopes:
          type: integer
          nullable: true
        pallets:
          type: integer
          nullable: true
        remarks:
          type: string
          nullable: true
        account_number:
          type: string
          nullable: true
        sales_person:
          type: string
          nullable: true
        pick_up_from:
          type: string
          nullable: true
        pick_up_time:
          type: string
          nullable: true
        pick_up_address:
          type: string
          nullable: true
        pick_up_address_1:
          type: string
          nullable: true
        pick_up_address_2:
          type: string
          nullable: true
        pick_up_address_3:
          type: string
          nullable: true
        pick_up_city:
          type: string
          nullable: true
        pick_up_state:
          type: string
          nullable: true
        pick_up_country:
          type: string
          nullable: true
        pick_up_postal_code:
          type: string
          nullable: true
        pick_up_zone:
          type: string
          nullable: true
        pick_up_lat:
          type: number
          nullable: true
        pick_up_lng:
          type: number
          nullable: true
        sender_phone_number:
          type: string
          nullable: true
        groups:
          type: array
          items:
            $ref: '#/components/schemas/ContactGroup'
        items:
          type: array
          items:
            $ref: '#/components/schemas/ContactItem'
    ContactItemInput:
      type: object
      description: >-
        An item to add, change, or remove. Without an `id`, it's added. Items
        with neither `sku` nor `description` are ignored.
      properties:
        id:
          type: string
          description: Send an existing item's `id` to change or remove that item.
        _destroy:
          type: boolean
          description: With `id`, set to `true` to remove the item.
        sku:
          type: string
          example: '12345678'
        description:
          type: string
          example: iPad
        quantity:
          type: number
          example: 2
        unit_price:
          type: number
        fixed_price:
          type: number
        minimum_quantity:
          type: number
        position:
          type: integer
          description: >-
            Order of the item in the contact's list. Defaults to its position in
            the array.
    ContactGroup:
      type: object
      properties:
        id:
          type: string
          example: 5e8b2f1a29e804cae4fe0a11
        name:
          type: string
          example: North
    ContactItem:
      type: object
      properties:
        id:
          type: string
          readOnly: true
          example: 6526409e29e804cae4fedd81
        sku:
          type: string
          nullable: true
          example: '12345678'
        description:
          type: string
          nullable: true
          example: iPad
        quantity:
          type: number
          nullable: true
          example: 2
        unit_price:
          type: number
          nullable: true
        fixed_price:
          type: number
          nullable: true
        minimum_quantity:
          type: number
          nullable: true
        position:
          type: integer
          description: Order of the item in the contact's list.
          example: 0
    Error:
      type: object
      properties:
        code:
          type: string
          example: not_found
        message:
          type: string
          example: Could not find job with this DO number
    ValidationError:
      type: object
      properties:
        code:
          type: string
          example: validation_failed
        message:
          type: string
          example: Validation Failed
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    FieldError:
      type: object
      properties:
        field:
          type: string
          example: do_number
        codes:
          type: array
          items:
            type: string
          example:
            - can't be blank
  responses:
    BadRequest:
      description: The request body isn't valid JSON.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: invalid_json_format
    Unauthorized:
      description: >-
        The API key is missing or invalid. A missing `X-API-KEY` returns `{
        "error": "Missing Authorization header" }`; an invalid key returns `{
        "code": "invalid_key", "message": "Invalid key" }`.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                title: Missing key
                required:
                  - error
                properties:
                  error:
                    type: string
                    example: Missing Authorization header
              - type: object
                title: Invalid key
                required:
                  - code
                properties:
                  code:
                    type: string
                    example: invalid_key
                  message:
                    type: string
                    example: Invalid key
          example:
            code: invalid_key
            message: Invalid key
    Forbidden:
      description: Your API key's user doesn't have permission for this action.
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: string
                example: forbidden
          example:
            code: forbidden
    ContactValidationFailed:
      description: >-
        The contact couldn't be saved (`validation_failed`), or `data` is
        missing or isn't an object (`invalid_data`). A contact needs
        `deliver_to_collect_from` or `company_name`, and needs `address` unless
        it has `address_1`, `address_2`, or `address_3`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
          example:
            code: validation_failed
            message: Validation Failed
            errors:
              - field: deliver_to_collect_from
                codes:
                  - or company can't be blank
              - field: company_name
                codes:
                  - or name can't be blank
    ServerError:
      description: >-
        Unexpected server error. Retry with exponential backoff, and contact
        Detrack support if it persists.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Your Detrack API key, from **Integrations > API Key** in the dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.