Update a job | 1099Policy API documentation

Update a job Run in API Explorer

PUT /api/v1/jobs/{job_id}

Updates the specific job by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

job string Required

The ID of the desired job (e.g., jb_jsb9KEcTpc).

application/json

Body

address object

The job address where the work will be done. Exclude if job will be done remotely.

Additional properties are allowed.
Hide address attributes Show address attributes object
- country string | null
  
  2-letter country code.
- line1 string
  
  Address line 1 (Street address/PO Box).
- line2 string | null
  
  Address line 2 (Apartment/Suite/Unit/Building).
- locality string
  
  City/District/Suburb/Town/Village.
- postalcode string
  
  ZIP or postal code.
- region string
  
  2-letter state code.
custom_metadata object

Set of key-value pairs that you can attach to an object. Used to store additional information about the job in a structured format.

Additional properties are allowed.
description string

A description of the job that includes the role, responsibilities and necessary qualifications.
entity string

The ID of an existing entity for whom the job is being done.
name string

The name of the contractor job role.
wage integer

A positive integer representing the wage (e.g., 1500 cents is $15.00). The minimum wage amount is 100 cents US. The maximum wage amount is 1000000000 cents US ($10,000,000).

Minimum value is 100, maximum value is 1000000000.
wage_type string

One of flatfee, hourly, unit or blended.

Values are flatfee, hourly, unit, or blended.
years_experience integer

The number of years of experience required to be eligible for the job.

Responses

200 application/json

Returns an job object if a valid job ID was provided. Returns an error otherwise.
Hide response attributes Show response attributes object
- address object
  
  Additional properties are allowed.
  
  Hide address attributes Show address attributes object
  
  country string | null
  
  2-letter country code.
  
  line1 string
  
  Address line 1 (Street address/PO Box).
  
  line2 string | null
  
  Address line 2 (Apartment/Suite/Unit/Building).
  
  locality string
  
  City/District/Suburb/Town/Village.
  
  postalcode string
  
  ZIP or postal code.
  
  region string
  
  2-letter state code.
- category_code string
  
  The category code that 1099Policy creates for a group of similarly classified jobs.
  
  Job category codes are pre-approved by 1099Policy so you can offer contractors insurance to new jobs on your platform in real time.
  
  To generate pre-approved category codes for a group of similarly classified jobs visit the 1099Policy Dashboard.
- created integer(int64)
  
  Time at which the object was created. Measured in seconds since the Unix epoch.
- custom_metadata object
  
  Set of key-value pairs that you can attach to the job object. Used for storing additional information in a structured format. Individual keys can be unset by posting an empty value to them. Pass an empty value, e.g. {}, to custom_metadata to unset all keys.
  
  Additional properties are allowed.
- description string
  
  A description of the job that includes the role, responsibilities and necessary qualifications.
- entity string
  
  The entity ID for whom the work is being done.
- id string
- name string
  
  The name of the contractor job role.
- wage integer
  
  A positive integer representing the total wage (e.g., 1500 cents is $15.00). The minimum wage amount is 100 cents US. The maximum wage amount is 100000000 cents US ($1,000,000).
  
  Minimum value is 100, maximum value is 100000000.
- wage_type
  
  One of flatfee, hourly, unit or blended.
  
  Values are flatfee, hourly, unit, or blended.
- years_experience integer
  
  The number of years of experience required to be eligible for the job.

PUT /api/v1/jobs/{job_id}

curl \
 --request PUT 'https://api.1099policy.com/api/v1/jobs/{job_id}' \
 --header "Content-Type: application/json" \
 --data '{"name":"Field technician","wage":1500,"entity":"en_Ah3tqYn","address":{"line1":"123 Main St","region":"CA","locality":"San Francisco","postalcode":94105},"wage_type":"hourly","description":"Install fiber optic cable from back to the front of the store.","years_experience":5}'

Request example

{
  "name": "Field technician",
  "wage": 1500,
  "entity": "en_Ah3tqYn",
  "address": {
    "line1": "123 Main St",
    "region": "CA",
    "locality": "San Francisco",
    "postalcode": 94105
  },
  "wage_type": "hourly",
  "description": "Install fiber optic cable from back to the front of the store.",
  "years_experience": 5
}

Response examples (200)

{
  "allOf": [
    {
      "name": "Field technician",
      "wage": 15000,
      "entity": "en_Ah3tqYn",
      "wage_type": "flatfee",
      "description": "Install fiber optic cable from back to the front of the store.",
      "category_code": "jc_MTqpkbkp6G",
      "custom_metadata": {
        "campaign": "Volvo"
      },
      "x-bump-ref-name": "job",
      "years_experience": 10
    },
    {
      "id": "jb_jsb9KEcTpc"
    }
  ]
}