---
updatedAt: 2026-07-14T23:30:31.000Z
agentTools:
  projectIndex: https://apidocs.acculynx.com/llms.txt
---

# Create Job

Use this endpoint to create a new job. The job is created in the `Lead` milestone with no assigned representative (Unassigned). The `contact` field is required and links an existing contact as the primary contact for the job.

This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota.


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.2614.0",
    "title": "AccuLynx API V2",
    "description": "If you are experiencing issues integrating with this API, please work with your web developer to review your programming before reaching out to us with an issue as we do not provide web development consulting services.\n\nAPI keys are for our customers only. If you are a business that is looking to integrate with AccuLynx, either on behalf of our customers or on your own, please [click here](https://docs.google.com/forms/d/e/1FAIpQLSeTvS614N9crtmFR4PVjgetlTKEhhjVGCFaodP8QLdFG_Qb8Q/viewform) to request access. Failure to do so can result in suspension of the AccuLynx account.\n\nThe AccuLynx API provides customers programmatic access to their data within AccuLynx.\n\nThe base url for these endpoints: is <b>https://api.acculynx.com/api/v2</b>\n\nUsing SwaggerHub, you have the ability to test against a virtual server or you can test against the API itself. The virtual server is a mock server that allows you to test your calls without affecting your production data. Testing against the virtual server will always respond with a fixed response regardless of your inputs. It is provided to give you a production model of the information returned.\n\nTesting against the API requires an API Key and will affect your real production data. Get your API key from your [AccuLynx API page](https://my.acculynx.com/apikeys). From the Servers list box below, select the api.acculynx.com site. When you click on green Authorize button next to the Servers list box, you will be prompted for a Bearer token. Enter your API Key and click Authorize again.\n\nTo make it easier to connect AccuLynx to other applications you use, we have made our Zapier integration publicly available. Instead of contacting us to help you enable the use of Zapier to integrate additional applications with AccuLynx, you can now get started by going to the Zapier website ([https://zapier.com](https://zapier.com)) and searching for the AccuLynx application. Zaps are automated tasks that you run over and over again between AccuLynx and other online applications. We have an action that allows you to pair with a trigger to create leads in AccuLynx and a trigger as well as other actions and triggers coming in the near future! To get started search for AccuLynx on the Zapier website!\n\nIf you don’t already have a Zapier account, create one or log into your [https://zapier.com/account](https://zapier.com/account).\n\nAccuLynx Action ZAP basic documentation: [https://support.acculynx.com/hc/en-us/articles/360034839751-Creating-a-Zap-with-Zapier](https://support.acculynx.com/hc/en-us/articles/360034839751-Creating-a-Zap-with-Zapier)",
    "termsOfService": "https://my.acculynx.com/signin/TermsView",
    "contact": {
      "email": "api@acculynx.com",
      "url": "https://api.acculynx.com/"
    },
    "license": {
      "name": "Proprietary",
      "url": "https://my.acculynx.com/signin/TermsView"
    }
  },
  "servers": [
    {
      "description": "AccuLynx Production Base Url",
      "url": "https://api.acculynx.com/api/v2"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "jobs",
      "description": "Manage jobs and their associated data, including address, contacts, custom fields, financials, history, insurance, measurements, messages, milestones, payments, and representatives."
    }
  ],
  "paths": {
    "/jobs": {
      "post": {
        "summary": "Create Job",
        "description": "Use this endpoint to create a new job. The job is created in the `Lead` milestone with no assigned representative (Unassigned). The `contact` field is required and links an existing contact as the primary contact for the job.\n\nThis endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota.\n",
        "operationId": "createJob",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/jobPost"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The job was created successfully. The response contains the new job's unique ID and a link to retrieve the full job record.\n",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/jobLink"
                    }
                  ]
                }
              }
            },
            "links": {
              "getJobById": {
                "description": "The `id` value returned in the response can be used as the `jobId` parameter in `GET /jobs/{jobId}`.\n",
                "operationId": "getJob",
                "parameters": {
                  "jobId": "$response.body#/id"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/403Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/404NotFound"
          },
          "429": {
            "$ref": "#/components/responses/429TooManyRequests"
          }
        },
        "tags": [
          "jobs"
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "error": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The URI of an explanation of the error",
            "example": "https://tools.ietf.org/html/rfc7235#section-3.1"
          },
          "title": {
            "type": "string",
            "description": "Error description",
            "example": "This error happened."
          },
          "status": {
            "type": "number",
            "description": "HTTP status code",
            "example": 400
          },
          "detail": {
            "type": "string",
            "description": "Any details available for this error",
            "example": "More info about this error."
          },
          "traceId": {
            "type": "string",
            "description": "An identifier that may be useful to AccuLynx support",
            "example": "|40f2a8f1-4db865dd47a69226."
          }
        },
        "required": [
          "type",
          "title",
          "status"
        ]
      },
      "jobLink": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The job's unique ID.",
            "example": "e591bf22-9828-4144-bca8-42cbb8c6e2c0"
          },
          "_link": {
            "type": "string",
            "description": "The URI of this Job.",
            "example": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
          }
        }
      },
      "contactId": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier of the contact."
          }
        },
        "required": [
          "id"
        ]
      },
      "leadSourcePost": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "be6f252d-5aa6-49e3-a2e2-470a67f88711",
            "description": "The unique identifier of the lead source."
          }
        },
        "required": [
          "id"
        ]
      },
      "jobAddressPost": {
        "type": "object",
        "properties": {
          "street1": {
            "type": "string",
            "description": "The primary street address line.",
            "example": "123 Main St.",
            "maxLength": 250
          },
          "street2": {
            "type": "string",
            "description": "An optional secondary address line, such as a suite or unit number.",
            "example": "Apt 2",
            "maxLength": 50
          },
          "city": {
            "type": "string",
            "description": "The city name.",
            "example": "Peoria",
            "maxLength": 50
          },
          "state": {
            "type": "string",
            "description": "The state or province code.",
            "example": "MI",
            "maxLength": 50
          },
          "country": {
            "type": "string",
            "description": "The ISO 3166-1 alpha-2 country code.",
            "example": "US",
            "maxLength": 50
          },
          "zipCode": {
            "type": "string",
            "description": "The postal or ZIP code.",
            "example": "61603",
            "maxLength": 50
          }
        },
        "required": [
          "street1",
          "city",
          "state",
          "country",
          "zipCode"
        ]
      },
      "jobPriorityPost": {
        "type": "string",
        "enum": [
          "Urgent",
          "High",
          "Normal"
        ],
        "example": "Normal",
        "description": "The priority level for this job."
      },
      "jobCategoryPost": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the job category.",
            "example": 130
          }
        }
      },
      "workTypePost": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the work type.",
            "example": 103
          }
        }
      },
      "tradeTypePost": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The trade type unique identifier.",
            "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      },
      "jobPost": {
        "type": "object",
        "properties": {
          "contact": {
            "$ref": "#/components/schemas/contactId",
            "description": "The existing contact to link as the primary contact for this job. Required."
          },
          "leadSource": {
            "$ref": "#/components/schemas/leadSourcePost",
            "description": "The lead source that identifies how this job was originated."
          },
          "locationAddress": {
            "$ref": "#/components/schemas/jobAddressPost",
            "description": "The physical address of the job location."
          },
          "priority": {
            "$ref": "#/components/schemas/jobPriorityPost",
            "description": "The priority level for this job."
          },
          "jobCategory": {
            "$ref": "#/components/schemas/jobCategoryPost",
            "description": "The job category to assign to this job. Must reference a valid category configured in company settings."
          },
          "workType": {
            "$ref": "#/components/schemas/workTypePost",
            "description": "The work type to assign to this job. Must reference a valid work type configured in company settings."
          },
          "tradeTypes": {
            "type": "array",
            "description": "The trade types to assign to this job. Each entry must reference a valid trade type configured in company settings.",
            "items": {
              "$ref": "#/components/schemas/tradeTypePost"
            }
          },
          "notes": {
            "type": "string",
            "description": "A note or remark for this new job.",
            "maxLength": 1000,
            "example": "Job created for repairs at some place."
          }
        },
        "required": [
          "contact"
        ]
      }
    },
    "responses": {
      "401Unauthorized": {
        "description": "The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "400BadRequest": {
        "description": "The request was malformed or contained invalid field values. Check the error response body for details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "404NotFound": {
        "description": "The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "429TooManyRequests": {
        "description": "The rate limit for this operation has been exceeded. Use the RateLimit-* response headers to determine when you can retry.",
        "headers": {
          "RateLimit-Limit": {
            "description": "The maximum number of requests permitted in the current window.",
            "schema": {
              "type": "integer"
            }
          },
          "RateLimit-Remaining": {
            "description": "The number of requests remaining in the current window (always 0 on a 429 response).",
            "schema": {
              "type": "integer"
            }
          },
          "RateLimit-Reset": {
            "description": "Seconds until the rate limit window resets. Same as `Retry-After` on a 429.",
            "schema": {
              "type": "integer"
            }
          },
          "RateLimit-Policy": {
            "description": "The policy and window that was exceeded (e.g., `company-write:hourly` or `company-write:daily`).",
            "schema": {
              "type": "string"
            }
          },
          "Retry-After": {
            "description": "Seconds to wait before retrying the request.",
            "schema": {
              "type": "integer"
            }
          }
        },
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            },
            "example": "Hourly rate limit exceeded. Please try again later."
          }
        }
      },
      "403Forbidden": {
        "description": "The API key does not have permission to perform this operation. Contact your administrator to request the required access.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      }
    }
  }
}
```