Create Job

post

https://api.acculynx.com/api/v2/jobs

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

contact

object

required

The existing contact to link as the primary contact for this job. Required.

leadSource

object

The lead source that identifies how this job was originated.

locationAddress

object

The physical address of the job location.

priority

string

enum

The priority level for this job.

Allowed:

jobCategory

object

The job category to assign to this job. Must reference a valid category configured in company settings.

workType

object

The work type to assign to this job. Must reference a valid work type configured in company settings.

tradeTypes

array of objects

The trade types to assign to this job. Each entry must reference a valid trade type configured in company settings.

tradeTypes

notes

string

length ≤ 1000

A note or remark for this new job.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

201The job was created successfully. The response contains the new job's unique ID and a link to retrieve the full job record.

400The request was malformed or contained invalid field values. Check the error response body for details.

401The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.

403The API key does not have permission to perform this operation. Contact your administrator to request the required access.

404The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.

429The rate limit for this operation has been exceeded. Use the RateLimit-* response headers to determine when you can retry.