Job Templates

Create a job from a template

Changed on

Creates a new job by cloning an existing job template. All template entities (tasks, materials, checklists, quotes, custom fields) are cloned to the new job.

Field Overrides

Only the following fields can be overridden when creating a job from a template:

  • job_description - Job description
  • company_uuid - UUID of the company/client
  • company_name - Name of the company/client (will lookup existing or create new)
  • job_address - Street address for the job

Note: You cannot specify both company_uuid and company_name. If company_name is provided, the system will first search for an existing company with that name. If found, it will use that company's UUID. If not found, a new company will be created.

Any other fields in the request body will be ignored.

OAuth Scope

This endpoint requires the following OAuth scope create_jobs.

post/jobtemplate/{uuid}/job.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/jobtemplate/{uuid}/job.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: create_jobs

Path parameters

uuidstring uuid required

UUID of the job template to clone from

Request body

job_descriptionstring

Job description

company_uuidstring uuid

UUID of the company/client. Cannot be used together with company_name.

company_namestring

Name of the company/client. If a company with this name exists, it will be used. Otherwise, a new company will be created. Cannot be used together with company_uuid.

job_addressstring

Street address for the job

Response

Job created successfully

jobUUIDstring uuid required

UUID of the created job

locationstring required

API path to the created job resource

messagestring required

Success message

Changes

  • 5793f2e4c841Revision changes
    • breaking

      request body became required

  • 458a25fd933fRevision changes
    • info

      the security scope create_jobs was added to the endpoint's security scheme oauth2

    • info

      the security scope manage_jobs was removed from the endpoint's security scheme oauth2