---
updatedAt: 2026-05-14T14:32:15.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Create a draft resignation for an employment

This API endpoint allows you to create a draft resignation for an employment.

**This endpoint requires the `X-Oyster-Actor-Email` header when using client credentials authentication.**

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "offboardingBase": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "cancelledAt": {
            "type": "string",
            "nullable": true
          },
          "initiatedAt": {
            "type": "string",
            "nullable": true
          },
          "cancelReason": {
            "type": "string",
            "nullable": true
          },
          "requestorId": {
            "type": "string",
            "nullable": true
          },
          "requestor": {
            "type": "object",
            "nullable": true,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "email"
            ]
          },
          "category": {
            "type": "object",
            "nullable": true,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "lastDayOn": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "state",
          "cancelledAt",
          "initiatedAt",
          "cancelReason",
          "requestorId",
          "requestor",
          "category",
          "lastDayOn"
        ]
      },
      "offboarding": {
        "allOf": [
          {
            "$ref": "#/components/schemas/offboardingBase"
          },
          {
            "type": "object",
            "properties": {
              "engagement": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "countryCode": {
                    "type": "string"
                  },
                  "startDate": {
                    "type": "string",
                    "nullable": true
                  },
                  "probationEndOn": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "id",
                  "name",
                  "countryCode",
                  "startDate",
                  "probationEndOn"
                ]
              },
              "lastWorkingDayOn": {
                "type": "string",
                "nullable": true
              },
              "estimatedPayrollMonth": {
                "type": "string",
                "nullable": true
              },
              "pto": {
                "type": "object",
                "nullable": true,
                "properties": {
                  "intendedPto": {
                    "type": "number",
                    "nullable": true
                  },
                  "ptoDaysRemaining": {
                    "type": "string",
                    "nullable": true
                  },
                  "reportedPtoTaken": {
                    "type": "number",
                    "nullable": true
                  },
                  "ptoInaccurateNote": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "intendedPto",
                  "ptoDaysRemaining",
                  "reportedPtoTaken",
                  "ptoInaccurateNote"
                ]
              },
              "mutualTermination": {
                "type": "boolean",
                "nullable": true
              },
              "notes": {
                "type": "string",
                "nullable": true
              },
              "roeCode": {
                "type": "string",
                "nullable": true
              },
              "additionalPayments": {
                "type": "array",
                "nullable": true,
                "items": {
                  "type": "object",
                  "properties": {
                    "payTypeId": {
                      "type": "string"
                    },
                    "amount": {
                      "type": "object",
                      "nullable": true,
                      "properties": {
                        "decimal": {
                          "type": "string",
                          "nullable": true
                        },
                        "currencyCode": {
                          "type": "string",
                          "nullable": true
                        }
                      }
                    },
                    "allowance": {
                      "type": "string",
                      "nullable": true
                    },
                    "redundancyPayment": {
                      "type": "string",
                      "nullable": true
                    },
                    "paymentPeriod": {
                      "type": "string",
                      "nullable": true
                    },
                    "paymentPeriodDuration": {
                      "type": "number",
                      "nullable": true
                    },
                    "paymentFrequency": {
                      "type": "string",
                      "nullable": true
                    },
                    "numRecurringPayments": {
                      "type": "number",
                      "nullable": true
                    },
                    "percentOfAnnualGross": {
                      "type": "string",
                      "nullable": true
                    },
                    "note": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "required": [
                    "payTypeId",
                    "amount",
                    "allowance",
                    "redundancyPayment",
                    "paymentPeriod",
                    "paymentPeriodDuration",
                    "paymentFrequency",
                    "numRecurringPayments",
                    "percentOfAnnualGross",
                    "note"
                  ]
                }
              },
              "proposedOffboardingDate": {
                "type": "string",
                "nullable": true
              },
              "reason": {
                "type": "string",
                "nullable": true
              },
              "earlyOffboardingRequested": {
                "type": "boolean",
                "nullable": true
              },
              "earlyOffboardingReason": {
                "type": "string",
                "nullable": true
              },
              "commissionDetails": {
                "type": "string",
                "nullable": true
              },
              "teamMemberOwedCommission": {
                "type": "boolean",
                "nullable": true
              },
              "communicatedWithTeamMember": {
                "type": "boolean",
                "nullable": true
              },
              "communicatedWithManager": {
                "type": "boolean",
                "nullable": true
              },
              "noteToTheContractor": {
                "type": "string",
                "nullable": true
              },
              "lastPayment": {
                "type": "object",
                "nullable": true,
                "$ref": "#/components/schemas/amount"
              }
            },
            "required": [
              "id",
              "engagement",
              "state",
              "cancelledAt",
              "initiatedAt",
              "cancelReason",
              "requestorId",
              "requestor",
              "category",
              "lastDayOn",
              "lastWorkingDayOn",
              "estimatedPayrollMonth",
              "pto",
              "mutualTermination",
              "notes",
              "roeCode",
              "additionalPayments",
              "proposedOffboardingDate",
              "reason",
              "earlyOffboardingRequested",
              "earlyOffboardingReason",
              "commissionDetails",
              "teamMemberOwedCommission",
              "communicatedWithTeamMember",
              "communicatedWithManager",
              "noteToTheContractor",
              "lastPayment"
            ]
          }
        ]
      },
      "amount": {
        "type": "object",
        "properties": {
          "decimal": {
            "type": "string",
            "pattern": "^\\d+([.]\\d+)?$"
          },
          "currencyCode": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3
          }
        },
        "required": [
          "decimal",
          "currencyCode"
        ]
      }
    }
  },
  "paths": {
    "/v0.1/offboardings/employments/resignations": {
      "post": {
        "summary": "Create a draft resignation for an employment",
        "tags": [
          "Offboarding"
        ],
        "description": "This API endpoint allows you to create a draft resignation for an employment.\n\n**This endpoint requires the `X-Oyster-Actor-Email` header when using client credentials authentication.**",
        "security": [
          {
            "bearer_auth": [
              "manage"
            ]
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Successfully creates a resignation",
            "content": {
              "application/json": {
                "examples": {
                  "Successfully creates a resignation": {
                    "value": {
                      "data": {
                        "id": "A5af31e4",
                        "engagement": {
                          "id": "A5540727",
                          "name": "Willie Mraz",
                          "countryCode": "US",
                          "startDate": "2022-10-15",
                          "probationEndOn": null
                        },
                        "state": "DRAFT",
                        "initiatedAt": null,
                        "cancelledAt": null,
                        "cancelReason": null,
                        "requestorId": "A91f5060",
                        "requestor": {
                          "id": "A91f5060",
                          "name": "Emely Langworth",
                          "email": "co_employer1@paucek.test"
                        },
                        "category": {
                          "id": "B473f979",
                          "name": "Better Opportunity",
                          "parentCategory": {
                            "id": "Aac4f7e8",
                            "name": "Resignation"
                          }
                        },
                        "lastDayOn": null,
                        "lastWorkingDayOn": null,
                        "estimatedPayrollMonth": "2024-10",
                        "pto": {
                          "intendedPto": 11.5,
                          "ptoDaysRemaining": null,
                          "reportedPtoTaken": 23.5,
                          "ptoInaccurateNote": null
                        },
                        "mutualTermination": null,
                        "notes": "Some notes",
                        "roeCode": null,
                        "additionalPayments": null,
                        "proposedOffboardingDate": "2024-10-15",
                        "reason": "Some reason",
                        "earlyOffboardingRequested": null,
                        "earlyOffboardingReason": null,
                        "commissionDetails": null,
                        "teamMemberOwedCommission": null,
                        "communicatedWithTeamMember": false,
                        "communicatedWithManager": false,
                        "noteToTheContractor": null,
                        "lastPayment": null
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/offboarding"
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "engagementId": {
                    "type": "string",
                    "minLength": 1,
                    "pattern": "^[\\w+\\-]{8,9}$"
                  },
                  "categoryId": {
                    "type": "string",
                    "minLength": 1,
                    "pattern": "^[\\w+\\-]{8,9}$"
                  },
                  "proposedOffboardingDate": {
                    "type": "string",
                    "format": "date",
                    "minLength": 1
                  },
                  "intendedPto": {
                    "type": "number",
                    "minimum": 0
                  },
                  "communicatedWithManager": {
                    "type": "boolean"
                  },
                  "reason": {
                    "type": "string",
                    "minLength": 1
                  },
                  "notes": {
                    "type": "string",
                    "minLength": 1
                  },
                  "reportedPtoTaken": {
                    "type": "number",
                    "minimum": 0
                  }
                },
                "required": [
                  "engagementId",
                  "categoryId",
                  "proposedOffboardingDate",
                  "intendedPto",
                  "communicatedWithManager"
                ]
              },
              "examples": {
                "Successfully creates a resignation": {
                  "summary": "Successfully creates a resignation",
                  "value": {
                    "engagementId": "A5540727",
                    "categoryId": "B473f979",
                    "proposedOffboardingDate": "2024-10-15",
                    "intendedPto": 11.5,
                    "communicatedWithManager": false,
                    "reason": "Some reason",
                    "notes": "Some notes",
                    "reportedPtoTaken": 23.5
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```