contacts

PATCH /api/v1/contacts/{pk}/oncall/

Set the on-call schedule for a contact.

Sample data (JSON):

# Set always on-call
{
    "state": "ACTIVE"
}

# Set weekly on-call schedule
{
    "state": "SCHEDULED",
    "schedule": [{
        "type": "WEEKLY",
        "from_time": "03:15",
        "to_time": "18:30",
        "weekdays": [6, 0]
    }]
}

# Set monthly schedule
{
    "state": "SCHEDULED",
    "schedule": [{
        "type": "MONTHLY",
        "from_time": "03:15",
        "to_time": "18:30",
        "monthday": 7
    }]
}

or

{
    "state": "SCHEDULED",
    "schedule": [{
        "type": "MONTHLY",
        "from_time": "03:15",
        "to_time": "18:30",
        "monthday_from": 7,
        "monthday_to": 9
    }]
}

Request

Path parameters

pkstring required

Request body

state'ACTIVE' | 'SUPPRESSED' | 'SCHEDULED' required

Whether to use an on-call schedule. Either ACTIVE (always on call) or SCHEDULED (use defined schedule).

Response

state'ACTIVE' | 'SUPPRESSED' | 'SCHEDULED' required

Whether to use an on-call schedule. Either ACTIVE (always on call) or SCHEDULED (use defined schedule).

Changes

No recorded changes to this operation across all 1 revision of this API.