Creating a job using the Okappy API

Okappy is a connected field service management platform consisting of companies, employees and devices.  Companies can connect to customers, subcontractors and employees. Add jobs and then assign those jobs to an employee or subcontractor.

To create a job using the Okappy API, follow the instructions below

First you will need to get an up to date authentication token.  For further information see authenticating with Okappy.

Add a job using the following endpoint.

POST /jobs

The token should be a string taken from the “access_token” field of a response to an authorise request.

No parameters

The body data of the request should contain a JSON object but sent with content type application/json. It should have the following basic structure:

{
"Name" : "Joe Bloggs",
"Reference" : "PO 34534",
"Address1" : "35 Kingsland Road, London, E2 8AN",
"Telephone" : "0207 099 5698",
"Description" : "Check boiler and repair if required"
}

The following table lists the fields that may be present in the body data:

Notes:

• You can provide the connection id and/or customer name of your customer, otherwise the job will default to yourself.
• You can retrieve your connection id using the connections endpoint.
• If the customer name is provided, please ensure it matches your customers name including position of any spaces and spelling. Capitalisation does not matter.
• If both a connection id and customer name is provided, the customer name will take precedence.

Reference: For further information about creating jobs with a template, see https://www.okappy.com/support-article/creating-job-templates/