---
title: "Create or update the job description"
method: PUT
path: "/api/jobs/{id}/description"
tags: ["Job description"]
---

# Create or update the job description

`PUT /api/jobs/{id}/description`

## Request

- Base URL: `https://your-server`
- URL: `https://your-server/api/jobs/{id}/description`
- Auth: OAuth 2
  - Authorization code: `/oauth/authorize`
  - Client credentials
  - Token URL: `/oauth/token`
- TypeScript: <https://skmtc.dev/sitecore/apis/jobs-api/docs/api/jobs/:id/description/put.ts> (a function with typed inputs; its response is checked against the schema)

Creates a job description entity if it does not exist or updates the job description entity. It confirms that the job exists and that the user has permission to access it. Properties or relations not included in the request will be set to null.

## Path parameters

- `id` integer, required

## Request body

- JobDescriptionResource: Represents a job description resource with various properties and relations.
  - `id` integer, nullable: The unique job description ID.
  - `identifier` string, nullable: The unique job description identifier.
  - `properties` object, nullable: The job description properties.
  - `relations` object, nullable: The job description relations.
  - `is_root_taxonomy_item` boolean, nullable: A value indicating whether the job description is a root taxonomy item.
  - `is_path_root` boolean, nullable: A value indicating whether the job description is a path root.
  - `entity_definition` Link: Represents a link to a resource.
    - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to.
    - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to.
    - `title` string, nullable: Gets or sets the title that describes this link.
    - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template.
  - `is_system_owned` boolean: A value indicating whether the job description is system owned.
  - `inherits_security` boolean: A value indicating whether the job description inherits security.
  - `self` Link: Represents a link to a resource.
    - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to.
    - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to.
    - `title` string, nullable: Gets or sets the title that describes this link.
    - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template.

## Response `201`

Job description successfully created.

## Other responses

- `204`: Job description successfully updated.
- `400`: Request not valid or error during operation.
- `401`: Unauthorized request.
- `404`: Entity not found or user not authorized.

---

[API](https://skmtc.dev/sitecore/apis/jobs-api.md) - [All operations](https://skmtc.dev/sitecore/apis/jobs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sitecore/apis/jobs-api/revisions/365efd74790f?raw)