Pay & Compensation
Incentives

Delete an Incentive

Delete an incentive.

one_time incentives that have the following status CANNOT be deleted:

  • processing
  • paid

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage expenses (employment_payments)-Manage incentives (incentive:write)
delete/v1/incentives/{id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/incentives/{id}
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, incentive:write, employment_payments, all:write)

Path parameters

idstring required

Incentive ID

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.