Create a scheduling group atomically

POST

api

workforce

scheduling-groups

Error

A valid request URL is required to generate request examples

{
  "outcome": "committed",
  "replayed": true,
  "request_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request": {},
  "record": {}
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Existing Atlas integration connection with explicit api:connect plus appropriate native domain grants. atlas_ingest_ and browser cookies are not accepted.

Headers

X-Workspace-Id

string<uuid>

required

Selector within saved grants and current issuer authority; never grants authority.

Idempotency-Key

string<uuid>

required

Retain the exact key and body across retries and transports.

Body

application/json

name

string

required

Required string length: 1 - 120

timezone

string

required

operating_open

string

required

Pattern: ^(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d)?$

operating_close

string

required

Pattern: ^(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d)?$

slot_minutes

integer

default:30

Required range: 1 <= x <= 240

allowed_max_ooo_pct

number

default:100

Required range: x <= 100

ceiling_profile

object | null

Show child attributes

minimum_floor

number | null

Required range: x >= 0

warn_threshold

number | null

Required range: 0 <= x <= 100

include_pending

boolean

default:true

operating_profile

object | null

Show child attributes

default_forecast_group_id

string<uuid> | null

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

forecast_group_operation_key

string<uuid> | null

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

request_key

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

expected_forecast_revision

integer

Expected current revision when linking an existing forecast group. Setup preview captures this automatically.

Required range: x >= 1

Response

Authorized native result. Configuration success does not establish operational readiness.

outcome

any

required

replayed

boolean

required

request_key

string<uuid>

required

record_id

string<uuid>

required

request

object

required

Immutable original actor, person, kind, parent and configuration evidence.

record

object

required

Current native group or membership row; the original request is retained separately.

Error

A valid request URL is required to generate request examples

{
  "outcome": "committed",
  "replayed": true,
  "request_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request": {},
  "record": {}
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

API foundations

Conversation REST API

Forecasting

Forecasting REST API

Workforce

Workforce REST API

Integrations

Atlas concepts

Build with Atlas

Changes

Create a scheduling group atomically

Authorizations

Headers

Body

Response