Delete Pay Rate

The "Delete Pay Rate" endpoint removes a specific pay rate entry identified by user ID and effective date.

Endpoint

DELETE https://api.connecteam.com/pay-rates/v1/pay-rates/users/USERID/{effectiveDate}

Authentication

  • API Key or OAuth 2.0
  • OAuth Scope: pay_rates.delete

Path Parameters

ParameterTypeRequiredDescription
userIdintegerYesThe user ID
effectiveDatestring (YYYY-MM-DD)YesThe effective date of the pay rate to delete

Behavior

  • This operation cannot be undone.
  • Returns 404 if no pay rate exists for the given user and effective date combination — even if the user has pay rates on other dates.
  • Returns 409 (HAS_LOCKED_DAYS) if the effective date conflicts with approved or locked timesheet days.
  • Other pay rates for the same user are not affected — only the specific entry matching the effective date is removed.
  • After deletion, the pay rate will no longer appear in GET responses.
🚧

Locked Days Protection

If the user has approved or locked timesheet days on or after the effective date, the delete request will be rejected with HTTP 409 and error code HAS_LOCKED_DAYS.

Response

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "success": true
  }
}

Error Codes

HTTP StatusError CodeDescription
400Invalid date format (must be YYYY-MM-DD)
401Missing authentication
403Invalid API key or insufficient OAuth scope
404No pay rate found for the specified user ID and effective date
409HAS_LOCKED_DAYSEffective date conflicts with approved or locked timesheet days

Pay Rates API Reference