Skip to main content
POST
File an increase, promotion or adjustment of pay

Authorizations

Authorization
string
header
required

Authorization: Bearer atk_live_… (a sandbox's keys are atk_test_…). Created in the API keys section of the Integrations settings; the secret is shown once.

Headers

Idempotency-Key
string
required

Unique per request; reuse it only to retry the same request with the same body. Remembered 24 hours.

Maximum string length: 255
If-Match
string

Optional: the employee's ETag, to refuse early when the record changed since you read it.

Path Parameters

id
string
required

The employee id.

Query Parameters

company_id
string

One of the key's companies.

validate_only
boolean

true: answer 200 with what would happen (the approval steps and who they resolve to, the knock-ons), and write nothing.

Body

application/json
kind
enum<string>
required

Increase, promotion or adjustment. A correction or a removal is made in andteam (422, code not-supported).

Available options:
increase,
promotion,
adjustment
effectiveDate
string<date>
required

The day the new pay takes effect, after their latest pay change.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
components
object[]
required

The whole package from that date, as the tenant's compensation catalogue defines it.

Required array length: 1 - 200 elements
reason
string

Why, in words. Kept as the change's note.

Maximum string length: 500
requestedBy
string

Optional: the andteam user id or work email of the person this is requested by (the hiring manager in your ATS, say), instead of the key's requester. They are checked for the same permission over this employee; if the check fails the request is refused (requester-not-allowed), never put back on the key's requester.

Required string length: 1 - 320

Response

validate_only=true: what would happen. Nothing was written.

wouldBe
object
required
steps
object[]
required
changedComponentIds
string[]
required