Update a job

PATCH

/v1/jobs/{id}

const url = 'https://shareout.site/v1/jobs/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"title":"example","description":"example","schedule":"example","enabled":true,"config":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://shareout.site/v1/jobs/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "description": "example", "schedule": "example", "enabled": true, "config": {} }'

Enable/pause, change schedule, title, description, or config.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Request Body^required

application/json

object

title

string

nullable <= 200 characters

description

string

nullable <= 1000 characters

schedule

string

enabled

boolean

config

object

Example ^generated

{
  "title": "example",
  "description": "example",
  "schedule": "example",
  "enabled": true,
  "config": {}
}

Responses

200

Updated

Update a job

Authorizations

Parameters

Path Parameters

Request Body required

Example generated

Responses

200

Request Body^required

Example ^generated