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

# Create Custom To Address

> Create a new custom 'to' address.



## OpenAPI

````yaml POST /customToAddresses
openapi: 3.0.1
info:
  title: Online Check Writer API
  description: API documentation for managing custom 'to' addresses.
  version: 1.0.0
servers:
  - url: https://test.onlinecheckwriter.com/api/v3
    description: Test server
  - url: https://app.onlinecheckwriter.com/api/v3
    description: Production server
security: []
paths:
  /customToAddresses:
    post:
      tags:
        - Custom To Addresses
      summary: Create a Custom To Address
      description: Create a new custom 'to' address.
      requestBody:
        description: Payload to create a new custom 'to' address.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the recipient.
                  maxLength: 50
                  example: John Doe
                companyName:
                  type: string
                  description: Company name of the recipient.
                  maxLength: 50
                  nullable: true
                  example: Company A
                addressLine1:
                  type: string
                  description: First line of the address.
                  maxLength: 100
                  example: Address 1
                addressLine2:
                  type: string
                  description: Second line of the address.
                  maxLength: 100
                  nullable: true
                  example: Address 2
                city:
                  type: string
                  description: City of the address.
                  maxLength: 100
                  example: City
                state:
                  type: string
                  description: State code (2-letter abbreviation).
                  maxLength: 2
                  example: ST
                zip:
                  type: string
                  description: Zip code of the address.
                  maxLength: 15
                  example: '123345'
                phone:
                  type: string
                  description: Phone number of the recipient.
                  maxLength: 15
                  nullable: true
                  example: '1234567890'
                email:
                  type: string
                  description: Email address of the recipient.
                  nullable: true
                  example: john.doe@example.com
                note:
                  type: string
                  description: An internal note for the address.
                  maxLength: 200
                  nullable: true
                  example: Note.
              required:
                - name
                - addressLine1
                - city
                - state
                - zip
            example:
              name: John Doe
              companyName: Company A
              addressLine1: Address 1
              addressLine2: Address 2
              city: City
              state: ST
              zip: '123456'
              phone: '1234567890'
              email: john.doe@example.com
              note: Note.
      responses:
        '201':
          description: Custom 'to' address created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Encrypted ID of the custom 'to' address.
                        example: 5EJy7VeBQGzn1m3
                      name:
                        type: string
                        description: Name of the recipient.
                        example: John Doe
                      companyName:
                        type: string
                        description: Company name of the recipient.
                        nullable: true
                        example: Company A
                      addressLine1:
                        type: string
                        description: First line of the address.
                        example: Address 1
                      addressLine2:
                        type: string
                        description: Second line of the address.
                        nullable: true
                        example: Address 2
                      city:
                        type: string
                        description: City of the address.
                        example: City
                      state:
                        type: string
                        description: State code (2-letter abbreviation).
                        example: ST
                      zip:
                        type: string
                        description: Zip code of the address.
                        example: '123456'
                      phone:
                        type: string
                        description: Phone number of the recipient.
                        nullable: true
                        example: '1234567890'
                      email:
                        type: string
                        description: Email address of the recipient.
                        nullable: true
                        example: john.doe@example.com
                      note:
                        type: string
                        description: An internal note for the address.
                        nullable: true
                        example: Note.
              examples:
                successResponse:
                  value:
                    success: true
                    data:
                      id: 5EJy7VeBQGzn1m3
                      name: John Doe
                      companyName: Company A
                      addressLine1: Address 1
                      addressLine2: Address 2
                      city: City
                      state: ST
                      zip: '123456'
                      phone: '1234567890'
                      email: john.doe@example.com
                      note: Note.
        '401':
          description: Unauthorized. Missing or invalid token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        '422':
          description: Validation failed or duplicate address.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  errorMsg:
                    type: string
                    example: Validation failed for address input.
              examples:
                validationError:
                  value:
                    success: false
                    errorMsg: The name field is required.
                duplicateAddress:
                  value:
                    success: false
                    errorMsg: This address already exists.
                    customToAddressId: 5EJy7VeBQGzn1m3
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````