v3

latestSwagger 2.02026-08-067506752.0 MB

change

Make a change to a change

patch/v1/org/{orgId}/change/{changeId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

changeIdstring required

Change id

Query parameters

processIdstring

Process id of person creation

Request body

datestring date

date of change

announceDatestring date

for HIRE and DEPART changes, the announce date, if the announce date is different from the date of change

status'ACTIVE' | 'STRUCK' | 'CONFLICT' | 'INACTIVE' | 'PROPOSED'

whether the change is active or not

departType'VOLUNTARY' | 'INVOLUNTARY'

for DEPART changes, the type of departure

departRegret'REGRET' | 'NONREGRET'

for DEPART changes, whether the departure is regrettable

reasonstring

the reason of the change

promotionType'PROMOTION' | 'DEMOTION' | 'NONE'

if it's a promotion or a demotion

notestring

note on the change

approvalNotestring

approval/rejection note

Example request

{
  "job": {
    "jobId": "588f7ee98f138b19220041a7",
    "orgId": "588f7ee98f138b19220041a7",
    "snapshotId": "588f7ee98f138b19220041a7",
    "title": "Senior Engineer",
    "relationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "groupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "personId": "588f7ee98f138b19220041a7",
    "backfillPersonId": "588f7ee98f138b19220041a7",
    "jobCodeId": "588f7ee98f138b19220041a7",
    "backfillByJobId": "588f7ee98f138b19220041a7",
    "upcoming": [
      {
        "id": "588f7ee98f138b19220041a7",
        "personId": "588f7ee98f138b19220041a7",
        "otherPersonId": "588f7ee98f138b19220041a7"
      }
    ],
    "scenarioId": "588f7ee98f138b19220041a7",
    "scenarioChangedId": "588f7ee98f138b19220041a7"
  },
  "update": {
    "addRelationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "removeRelationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "addGroupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "removeGroupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "grant": {
      "stock": "GOOG"
    },
    "backfillPersonId": "588f7ee98f138b19220041a7",
    "jobCodeId": "588f7ee98f138b19220041a7"
  },
  "approvalNote": "Not acceptable"
}

Response

no content