set_person_interview_lead_time

Set the person's short-notice period

All MCP toolsWrite

Save the person's short-notice period (their interview lead-time setting), or pass null to clear it back to the product default of one calendar day. value is a non-negative integer; unit is "day" (calendar days in the person's saved time zone, the boundary landing on a local midnight) or "hour" (rolling hours from now); at most 14 days or 336 hours; a value above that refuses with zero writes. While the person has availability registered, their own screen lists a proposed interview slot that starts before the boundary as out of the options, and the entrusted coordinator answers only slots on or after it: a filtering of the choice, never a refusal, so nobody's accept is stopped by it. Read the current setting and the boundary it draws with list_availability first, and read it back there after saving. Change it on the person's own instruction (such as "only slots further out, please"), never for the agent's own convenience. A setting, not profile data: writing it never changes the profile version.

Input schema

{
  "type": "object",
  "properties": {
    "personId": {
      "type": "string",
      "format": "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)$",
      "description": "The person whose short-notice period to set (persons.id — self)."
    },
    "leadTime": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "value": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991,
              "description": "How many units of lead the person wants; 0 = offer up to now."
            },
            "unit": {
              "type": "string",
              "enum": [
                "day",
                "hour"
              ],
              "description": "How the lead value counts: 'day' = calendar days in the person's time zone (the boundary lands on a local midnight), 'hour' = rolling hours from now."
            }
          },
          "required": [
            "value",
            "unit"
          ],
          "additionalProperties": false,
          "description": "The person's interview lead-time setting: how far ahead a proposed slot must start for their own screen to offer it as a choice while they have availability registered (the calendar hatches the period before that). Display only — it refuses no accept, the person's or their agent's; the entrusted coordinator answers only the slots that screen offers (on or after the boundary, inside the availability)."
        },
        {
          "type": "null"
        }
      ],
      "description": "The setting to save ({ value, unit } with unit \"day\" or \"hour\"), or null to clear it back to the product default."
    }
  },
  "required": [
    "personId",
    "leadTime"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

{
  "type": "object",
  "properties": {
    "personId": {
      "type": "string",
      "format": "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)$"
    },
    "leadTime": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "value": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991,
              "description": "How many units of lead the person wants; 0 = offer up to now."
            },
            "unit": {
              "type": "string",
              "enum": [
                "day",
                "hour"
              ],
              "description": "How the lead value counts: 'day' = calendar days in the person's time zone (the boundary lands on a local midnight), 'hour' = rolling hours from now."
            }
          },
          "required": [
            "value",
            "unit"
          ],
          "additionalProperties": false,
          "description": "The person's interview lead-time setting: how far ahead a proposed slot must start for their own screen to offer it as a choice while they have availability registered (the calendar hatches the period before that). Display only — it refuses no accept, the person's or their agent's; the entrusted coordinator answers only the slots that screen offers (on or after the boundary, inside the availability)."
        },
        {
          "type": "null"
        }
      ],
      "description": "The saved setting — null when cleared (readers then apply the product default of one calendar day)."
    }
  },
  "required": [
    "personId",
    "leadTime"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

On this page