Jobs (API) | Documentation de l'API Inbox Manager

Job queue endpoints

GET/api/accounts/{account_id}/jobs

List queue jobs for an account with role-aware payload projection. More Jobs

Responses

200application/json

schemaobject

dataarrayrequired

itemanyOfrequired

Variant

A queue job representing provider or internal work derived from tasks and retriable independently.

JobJob

Nested fields truncated. Expand to continue inline, or use the model link.

A queue job representing provider or internal work derived from tasks and retriable independently.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

meta

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/jobs/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123}'

const payload = {"query":"string","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/jobs/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/jobs/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/jobs/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/jobs/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/jobs/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/jobs/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/jobs/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/jobs/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123}
uri = URI("${BASE_URL}/api/accounts/acc123/jobs/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/jobs/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/jobs/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/jobs/search-delete

Delete jobs selected by query with optional dry-run confirmation. More Jobs

Body application/json

querystringrequired

dry_runboolean

confirmboolean

limitinteger

Responses

200application/json

schemaobject

dataobjectrequired

deleted_countintegerrequired

deleted_idsarrayrequired

itemstringrequired

dry_runbooleanrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/jobs/search-delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","dry_run":true,"confirm":true,"limit":123}'

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/jobs/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/jobs/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/jobs/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/jobs/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","dry_run":true,"confirm":true,"limit":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/jobs/search-delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","dry_run":true,"confirm":true,"limit":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/jobs/search-delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","dry_run":true,"confirm":true,"limit":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/jobs/search-delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","dry_run":true,"confirm":true,"limit":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/jobs/search-delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","dry_run":true,"confirm":true,"limit":123}
uri = URI("${BASE_URL}/api/accounts/acc123/jobs/search-delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","dry_run":true,"confirm":true,"limit":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/jobs/search-delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/jobs/search-delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"dry_run\":true,\"confirm\":true,\"limit\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/jobs/{job_id}

Delete a job record by ID. More Jobs

Responses

204

No Content

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/jobs/job123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/jobs/job123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/jobs/job123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/jobs/job123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/jobs/job123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/jobs/job123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/jobs/job123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/jobs/job123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/jobs/job123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/jobs/job123")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/jobs/job123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/jobs/job123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/jobs/{job_id}

Retrieve one job by ID. More Jobs

Responses

200application/json

schemaobject

dataanyOfrequired

Variant

A queue job representing provider or internal work derived from tasks and retriable independently.

JobJob

A queue job representing provider or internal work derived from tasks and retriable independently.

idstringrequired

Job identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

task_idstring | nullrequired

Task identifier.

source_kindrequired

queue_namestringrequired

job_typestringrequired

dedupe_keystringrequired

payloadrequired

attemptsintegerrequired

max_attemptsintegerrequired

available_atstringrequired

claimed_atstring | nullrequired

succeeded_atstring | nullrequired

failed_atstring | nullrequired

resolved_atstring | nullrequired

resolved_bystring | nullrequired

User identifier.

resolution_notestring | nullrequired

last_error_codestring | nullrequired

last_error_detailstring | nullrequired

versionintegerrequired

created_atstringrequired

updated_atstringrequired

Option 2object

idstringrequired

Job identifier.

task_idstring | nullrequired

statusstringrequired

run_atstring | nullrequired

completed_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/jobs/job123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/jobs/job123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/jobs/job123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/jobs/job123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/jobs/job123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/jobs/job123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/jobs/job123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/jobs/job123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/jobs/job123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/jobs/job123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/jobs/job123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/jobs/job123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/jobs/{job_id}

Update mutable job scheduling and note fields. More Jobs

Body application/json

available_atstring

notestring | null

Responses

200application/json

schemaobject

dataJobrequired

A queue job representing provider or internal work derived from tasks and retriable independently.

idstringrequired

Job identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

task_idstring | nullrequired

Task identifier.

source_kindrequired

queue_namestringrequired

job_typestringrequired

dedupe_keystringrequired

payloadrequired

attemptsintegerrequired

max_attemptsintegerrequired

available_atstringrequired

claimed_atstring | nullrequired

succeeded_atstring | nullrequired

failed_atstring | nullrequired

resolved_atstring | nullrequired

resolved_bystring | nullrequired

User identifier.

resolution_notestring | nullrequired

last_error_codestring | nullrequired

last_error_detailstring | nullrequired

versionintegerrequired

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/jobs/job123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"available_at":"string","note":"value"}'

const payload = {"available_at":"string","note":"value"};
const url = "${BASE_URL}/api/jobs/job123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"available_at":"string","note":"value"};
const url = "${BASE_URL}/api/jobs/job123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"available_at":"string","note":"value"};
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/jobs/job123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"available_at":"string","note":"value"};
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/jobs/job123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"available_at":"string","note":"value"};
const { body } = await request("${BASE_URL}/api/jobs/job123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"available_at":"string","note":"value"}
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/jobs/job123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"available_at":"string","note":"value"}
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/jobs/job123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"available_at":"string","note":"value"}`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/jobs/job123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"available_at":"string","note":"value"}
uri = URI("${BASE_URL}/api/jobs/job123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"available_at":"string","note":"value"};
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/jobs/job123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/jobs/job123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"available_at\":\"string\",\"note\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/jobs/{job_id}/resolve

Mark a failed job as resolved with optional note. More Jobs

Body application/json

notestring | null

Responses

200application/json

schemaobject

dataJobrequired

A queue job representing provider or internal work derived from tasks and retriable independently.

idstringrequired

Job identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

task_idstring | nullrequired

Task identifier.

source_kindrequired

queue_namestringrequired

job_typestringrequired

dedupe_keystringrequired

payloadrequired

attemptsintegerrequired

max_attemptsintegerrequired

available_atstringrequired

claimed_atstring | nullrequired

succeeded_atstring | nullrequired

failed_atstring | nullrequired

resolved_atstring | nullrequired

resolved_bystring | nullrequired

User identifier.

resolution_notestring | nullrequired

last_error_codestring | nullrequired

last_error_detailstring | nullrequired

versionintegerrequired

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/jobs/job123/resolve" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"note":"value"}'

const payload = {"note":"value"};
const url = "${BASE_URL}/api/jobs/job123/resolve";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"note":"value"};
const url = "${BASE_URL}/api/jobs/job123/resolve";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"note":"value"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/jobs/job123/resolve",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"note":"value"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/jobs/job123/resolve",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"note":"value"};
const { body } = await request("${BASE_URL}/api/jobs/job123/resolve", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"note":"value"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/jobs/job123/resolve", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"note":"value"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/jobs/job123/resolve", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"note":"value"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/jobs/job123/resolve", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"note":"value"}
uri = URI("${BASE_URL}/api/jobs/job123/resolve")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"note":"value"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/jobs/job123/resolve", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/jobs/job123/resolve");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"note\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/jobs/{job_id}/retry

Reset failed job state so it can be attempted again. More Jobs

Body application/json

bodyobject

Responses

200application/json

schemaobject

dataJobrequired

A queue job representing provider or internal work derived from tasks and retriable independently.

idstringrequired

Job identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

task_idstring | nullrequired

Task identifier.

source_kindrequired

queue_namestringrequired

job_typestringrequired

dedupe_keystringrequired

payloadrequired

attemptsintegerrequired

max_attemptsintegerrequired

available_atstringrequired

claimed_atstring | nullrequired

succeeded_atstring | nullrequired

failed_atstring | nullrequired

resolved_atstring | nullrequired

resolved_bystring | nullrequired

User identifier.

resolution_notestring | nullrequired

last_error_codestring | nullrequired

last_error_detailstring | nullrequired

versionintegerrequired

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/jobs/job123/retry" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const payload = {};
const url = "${BASE_URL}/api/jobs/job123/retry";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {};
const url = "${BASE_URL}/api/jobs/job123/retry";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/jobs/job123/retry",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/jobs/job123/retry",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {};
const { body } = await request("${BASE_URL}/api/jobs/job123/retry", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/jobs/job123/retry", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/jobs/job123/retry", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/jobs/job123/retry", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {}
uri = URI("${BASE_URL}/api/jobs/job123/retry")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/jobs/job123/retry", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/jobs/job123/retry");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/jobs/{job_id}/trigger

Claim and execute a queued job immediately. More Jobs

Body application/json

bodyobject

Responses

200application/json

schemaobject

dataJobrequired

A queue job representing provider or internal work derived from tasks and retriable independently.

idstringrequired

Job identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

task_idstring | nullrequired

Task identifier.

source_kindrequired

queue_namestringrequired

job_typestringrequired

dedupe_keystringrequired

payloadrequired

attemptsintegerrequired

max_attemptsintegerrequired

available_atstringrequired

claimed_atstring | nullrequired

succeeded_atstring | nullrequired

failed_atstring | nullrequired

resolved_atstring | nullrequired

resolved_bystring | nullrequired

User identifier.

resolution_notestring | nullrequired

last_error_codestring | nullrequired

last_error_detailstring | nullrequired

versionintegerrequired

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/jobs/job123/trigger" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const payload = {};
const url = "${BASE_URL}/api/jobs/job123/trigger";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {};
const url = "${BASE_URL}/api/jobs/job123/trigger";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/jobs/job123/trigger",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/jobs/job123/trigger",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {};
const { body } = await request("${BASE_URL}/api/jobs/job123/trigger", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/jobs/job123/trigger", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/jobs/job123/trigger", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/jobs/job123/trigger", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {}
uri = URI("${BASE_URL}/api/jobs/job123/trigger")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/jobs/job123/trigger", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/jobs/job123/trigger");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Job

idstringrequired

Job identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

task_idstring | nullrequired

Task identifier.

source_kindrequired

queue_namestringrequired

job_typestringrequired

dedupe_keystringrequired

payloadrequired

attemptsintegerrequired

max_attemptsintegerrequired

available_atstringrequired

claimed_atstring | nullrequired

succeeded_atstring | nullrequired

failed_atstring | nullrequired

resolved_atstring | nullrequired

resolved_bystring | nullrequired

User identifier.

resolution_notestring | nullrequired

last_error_codestring | nullrequired

last_error_detailstring | nullrequired

versionintegerrequired

created_atstringrequired

updated_atstringrequired

ProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

Jobs

Contents

List jobs

Search jobs

Search and delete jobs

Delete job

Get job

Patch job

Resolve job

Retry job

Trigger job

Models

Features

Types

Contents

Models

Related Features and Types

Features

Types