Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Create Job

Use this endpoint to create a job in the milestone Lead (Unassigned).

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

post/jobs

Request body

priority'Urgent' | 'High' | 'Normal'

Priority of lead (Urgent, High, Normal).

notesstring

A note or remark for this new Jobs.

Example request

{
  "leadSource": {
    "id": "be6f252d-5aa6-49e3-a2e2-470a67f88711"
  },
  "locationAddress": {
    "street1": "123 Main St.",
    "street2": "Apt 2",
    "city": "Peoria",
    "state": "MI",
    "country": "US",
    "zipCode": "61603"
  },
  "priority": "Normal",
  "jobCategory": {
    "id": 130
  },
  "workType": {
    "id": 103
  },
  "tradeTypes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "notes": "Job created for repairs at some place."
}

Response

job created

idstring uuid

The job's unique ID.

_linkstring

The URI of this Job.

Example response

{
  "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
  "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
}