Skip to main content
PUT
/
contract
/
v1
/
compensations
/
{compensationId}
Update a compensation
curl --request PUT \
  --url https://api-{region}.sesametime.com/contract/v1/compensations/{compensationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "comment": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Comision por ventas",
    "quantity": 1500,
    "percentage": 10.5,
    "currency": "MXN",
    "recurrence": 1,
    "code": "<string>",
    "comment": "<string>",
    "createdAt": "2020-01-01T10:00:00+01:00",
    "updatedAt": "2020-01-01T10:00:00+01:00"
  },
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.sesametime.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
compensationId
string<uuid>
required

The compensation ID

Body

application/json
​
name
string
required

Compensation name

​
status
enum<string>
required

Compensation status

Available options:
active,
inactive
​
code
string | null

External code (for Contpaqi integration)

​
comment
string | null

Optional comment

Response

Successful response

​
data
object
​
meta
object