Update user

Partially update a user by their ID

PATCH

/v1/users/{id}

PATCH

/users/{id}

curl -X PATCH "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "email": "[email protected]",
  "type": "employee",
  "personalEmail": "[email protected]",
  "departmentKey": "string",
  "teamKey": "string",
  "jobKey": "string",
  "countryCode": "ASC",
  "managerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "idpStatus": "active",
  "hrStatus": "active",
  "customFields": {
    "key": "string"
  }
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

name
string
email
string<email>
type
enum<string>
One of:
employee
external
service_account
agent
personalEmail
string<email> | null
departmentKey
string | null
teamKey
string | null
Deprecated alias of departmentKey. Prefer departmentKey.
jobKey
string | null
countryCode
enum<string> | null
One of:
ASC
AND
ARE
AFG
ATG
AIA
AFI
ALB
ARM
ANT
AGO
ATA
ARG
ASM
AUT
AUS
ABW
ALA
AZE
BIH
BRB
BGD
BEL
BFA
BGR
BHR
BDI
BEN
BLM
BMU
BRN
BOL
BES
ATB
BRA
BHS
BTN
BUR
BVT
BWA
BLR
BYS
BLZ
CAN
CCK
COD
CAF
COG
CHE
CIV
COK
CHL
CMR
CHN
COL
CPT
CRI
CSK
SCG
CTE
CUB
CPV
CUW
CXR
CYP
CZE
DDR
DEU
DGA
DJI
DNK
DMA
DOM
DHY
DZA
ECU
EST
EGY
ESH
ERI
ESP
ETH
EUE
FIN
FJI
FLK
FSM
FRO
ATF
FRA
FXX
GAB
GBR
GRD
GEO
GEL
GUF
GGY
GHA
GIB
GRL
GMB
GIN
GLP
GNQ
GRC
SGS
GTM
GUM
GNB
GUY
HKG
HMD
HND
HRV
HTI
HUN
HVO
IDN
IRL
ISR
IMN
IND
IOT
IRQ
IRN
ISL
ITA
JEY
JAM
JOR
JPN
JTN
KEN
KGZ
KHM
KIR
COM
KNA
PRK
KOR
KWT
CYM
KAZ
LAO
LBN
LCA
LIE
LKA
LBR
LSO
LTU
LUX
LVA
LBY
MAR
MCO
MDA
MNE
MAF
MDG
MHL
MID
MKD
MLI
MMR
MNG
MAC
MNP
MTQ
MRT
MSR
MLT
MUS
MDV
MWI
MEX
MYS
MOZ
NAM
NCL
NER
NFK
NGA
NHB
NIC
NLD
NOR
NPL
ATN
NRU
NTZ
NIU
NZL
OMN
PAN
PCI
PER
PYF
PNG
PHL
PAK
POL
SPM
PCN
PRI
PSE
PRT
PUS
PLW
PRY
PCZ
QAT
REU
RHO
ROU
SRB
RUS
RWA
SAU
SLB
SYC
SDN
SWE
SGP
SHN
SVN
SJM
SVK
SKM
SLE
SMR
SEN
SOM
SUR
SSD
STP
SUN
SLV
SXM
SYR
SWZ
TAA
TCA
TCD
TGO
THA
TJK
TKL
TLS
TKM
TUN
TON
TMP
TUR
TTO
TUV
TWN
TZA
UKR
UGA
UMI
USA
URY
UZB
VAT
VCT
VDR
VEN
VGB
VIR
VNM
VUT
WLF
WAK
WSM
XKX
YMD
YEM
MYT
YUG
ZAF
ZMB
ZAR
ZWE
managerId
string | null
startDate
any of | null
terminationDate
any of | null
idpStatus
enum<string> | null
One of:
active
suspended
archived
deprovisioned
hrStatus
enum<string> | null
One of:
active
terminated
pending
customFields
map of any of

Response

application/json200

id
string
required
type
enum<string>
required
One of:
employee
external
service_account
agent
email
string
required
personalEmail
string | null
required
name
string
required
idpStatus
enum<string> | null
required
One of:
active
suspended
archived
deprovisioned
hrStatus
enum<string> | null
required
One of:
active
terminated
pending
jobKey
string | null
required
countryCode
string | null
required
departmentKey
string | null
required
startDate
string<date-time> | null
required
terminationDate
string<date-time> | null
required
emails
UserEmail[]
required
job
HrJobEmbed | null
required
country
HrCountry | null
required
department
TeamEmbed | null
required
sources
UserSource[]
required
connectorId
string | null
required
The connector this user belongs to: the id of its connection, which every connector route accepts. Null when no connector holds it.
customFields
map of any of
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

PATCH

/users/{id}

curl -X PATCH "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "email": "[email protected]",
  "type": "employee",
  "personalEmail": "[email protected]",
  "departmentKey": "string",
  "teamKey": "string",
  "jobKey": "string",
  "countryCode": "ASC",
  "managerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "idpStatus": "active",
  "hrStatus": "active",
  "customFields": {
    "key": "string"
  }
}'

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

Update user - Corma Help Center | Productlane

API referenceUsers

Update user

Partially update a user by their ID

PATCH

/v1/users/{id}

PATCH

/users/{id}

curl -X PATCH "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "email": "[email protected]",
  "type": "employee",
  "personalEmail": "[email protected]",
  "departmentKey": "string",
  "teamKey": "string",
  "jobKey": "string",
  "countryCode": "ASC",
  "managerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "idpStatus": "active",
  "hrStatus": "active",
  "customFields": {
    "key": "string"
  }
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

name
string
email
string<email>
type
enum<string>
One of:
employee
external
service_account
agent
personalEmail
string<email> | null
departmentKey
string | null
teamKey
string | null
Deprecated alias of departmentKey. Prefer departmentKey.
jobKey
string | null
countryCode
enum<string> | null
One of:
ASC
AND
ARE
AFG
ATG
AIA
AFI
ALB
ARM
ANT
AGO
ATA
ARG
ASM
AUT
AUS
ABW
ALA
AZE
BIH
BRB
BGD
BEL
BFA
BGR
BHR
BDI
BEN
BLM
BMU
BRN
BOL
BES
ATB
BRA
BHS
BTN
BUR
BVT
BWA
BLR
BYS
BLZ
CAN
CCK
COD
CAF
COG
CHE
CIV
COK
CHL
CMR
CHN
COL
CPT
CRI
CSK
SCG
CTE
CUB
CPV
CUW
CXR
CYP
CZE
DDR
DEU
DGA
DJI
DNK
DMA
DOM
DHY
DZA
ECU
EST
EGY
ESH
ERI
ESP
ETH
EUE
FIN
FJI
FLK
FSM
FRO
ATF
FRA
FXX
GAB
GBR
GRD
GEO
GEL
GUF
GGY
GHA
GIB
GRL
GMB
GIN
GLP
GNQ
GRC
SGS
GTM
GUM
GNB
GUY
HKG
HMD
HND
HRV
HTI
HUN
HVO
IDN
IRL
ISR
IMN
IND
IOT
IRQ
IRN
ISL
ITA
JEY
JAM
JOR
JPN
JTN
KEN
KGZ
KHM
KIR
COM
KNA
PRK
KOR
KWT
CYM
KAZ
LAO
LBN
LCA
LIE
LKA
LBR
LSO
LTU
LUX
LVA
LBY
MAR
MCO
MDA
MNE
MAF
MDG
MHL
MID
MKD
MLI
MMR
MNG
MAC
MNP
MTQ
MRT
MSR
MLT
MUS
MDV
MWI
MEX
MYS
MOZ
NAM
NCL
NER
NFK
NGA
NHB
NIC
NLD
NOR
NPL
ATN
NRU
NTZ
NIU
NZL
OMN
PAN
PCI
PER
PYF
PNG
PHL
PAK
POL
SPM
PCN
PRI
PSE
PRT
PUS
PLW
PRY
PCZ
QAT
REU
RHO
ROU
SRB
RUS
RWA
SAU
SLB
SYC
SDN
SWE
SGP
SHN
SVN
SJM
SVK
SKM
SLE
SMR
SEN
SOM
SUR
SSD
STP
SUN
SLV
SXM
SYR
SWZ
TAA
TCA
TCD
TGO
THA
TJK
TKL
TLS
TKM
TUN
TON
TMP
TUR
TTO
TUV
TWN
TZA
UKR
UGA
UMI
USA
URY
UZB
VAT
VCT
VDR
VEN
VGB
VIR
VNM
VUT
WLF
WAK
WSM
XKX
YMD
YEM
MYT
YUG
ZAF
ZMB
ZAR
ZWE
managerId
string | null
startDate
any of | null
terminationDate
any of | null
idpStatus
enum<string> | null
One of:
active
suspended
archived
deprovisioned
hrStatus
enum<string> | null
One of:
active
terminated
pending
customFields
map of any of

Response

application/json200

id
string
required
type
enum<string>
required
One of:
employee
external
service_account
agent
email
string
required
personalEmail
string | null
required
name
string
required
idpStatus
enum<string> | null
required
One of:
active
suspended
archived
deprovisioned
hrStatus
enum<string> | null
required
One of:
active
terminated
pending
jobKey
string | null
required
countryCode
string | null
required
departmentKey
string | null
required
startDate
string<date-time> | null
required
terminationDate
string<date-time> | null
required
emails
UserEmail[]
required
job
HrJobEmbed | null
required
country
HrCountry | null
required
department
TeamEmbed | null
required
sources
UserSource[]
required
connectorId
string | null
required
The connector this user belongs to: the id of its connection, which every connector route accepts. Null when no connector holds it.
customFields
map of any of
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

PATCH

/users/{id}

curl -X PATCH "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "email": "[email protected]",
  "type": "employee",
  "personalEmail": "[email protected]",
  "departmentKey": "string",
  "teamKey": "string",
  "jobKey": "string",
  "countryCode": "ASC",
  "managerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "idpStatus": "active",
  "hrStatus": "active",
  "customFields": {
    "key": "string"
  }
}'

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}