Skip to main content
API Explorer|API Explorer
Alerting & Response/On-Call
POSTOnCallSince 1.0SynchronousAuth Required

ApplyOnCallResolution

Apply a specific conflict resolution suggestion to affected schedules

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • suggestionIdStringRequired

    ID of the adjustment suggestion to apply

Responses

200 OK

On success, this API returns the following response structure.

  • suggestionIdString

    ID of the suggestion that was applied

    Example: sugg-11223344

  • affectedCountInteger

    Number of schedules affected by applying this resolution

    Example: 2

  • updatedSchedulesList

    Schedules that were modified as part of this resolution

    Example: (nested array)

    • uuidString

      Unique identifier of the schedule

      Example: sched-00112233

    • nameString

      Human-readable name of the schedule

      Example: Platform On-Call

    • descriptionString

      Brief description of the schedule purpose

      Example: 24x7 platform on-call rotation

    • timezoneString

      IANA timezone name for the schedule

      Example: Asia/Shanghai

    • rotationTypeString

      Rotation type: daily, weekly, or custom

      Example: weekly

    • shiftDurationString

      Duration of each shift as a Go duration string

      Example: 168h

    • membersList

      Ordered list of members participating in the rotation

      Example: (nested array)

      • userIdString

        User identifier of the on-call member

        Example: user-abc123

      • userNameString

        Display name of the on-call member

        Example: Alice Smith

      • orderInteger

        Rotation order position of the member within the schedule

        Example: 1

    • startDateString

      Timestamp when the schedule rotation begins

      Example: 2026-01-15T08:00:00Z

    • createDateString

      Timestamp when the schedule was created

      Example: 2026-01-15T08:00:00Z

    • lastOpDateString

      Timestamp of the last modification to the schedule

      Example: 2026-01-15T08:00:00Z

  • statusString

    Final status of the apply operation

    Example: success

  • messageString

    Human-readable message describing the apply result

    Example: Resolution applied successfully

Endpoint

POST/api/v1/oncall/resolutions/{suggestionId}/apply

/api/v1/oncall/resolutions/{suggestionId}/apply

Operation ID

ApplyOnCallResolution

Permalink

Request Example

curl -X POST '{host}/api/v1/oncall/resolutions/{suggestionId}/apply' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{}'

Response Example

200
{
  "suggestionId": "sugg-11223344",
  "affectedCount": 2,
  "updatedSchedules": [
    {}
  ],
  "status": "success",
  "message": "Resolution applied successfully"
}

Change History

This API has no change history records yet.

View all change history