---
updatedAt: 2026-08-11T08:28:17.000Z
agentTools:
  projectIndex: https://developer.joinblink.com/llms.txt
---

# Partially update/patch a user

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "SCIM V2 API",
    "version": "1.0.0",
    "title": "SCIM API"
  },
  "tags": [
    {
      "name": "User"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/Users/{id}": {
      "patch": {
        "tags": [
          "User"
        ],
        "summary": "Partially update/patch a user",
        "operationId": "patchUser",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "User id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserPatch"
              }
            },
            "application/scim+json": {
              "schema": {
                "$ref": "#/components/schemas/UserPatch"
              }
            }
          },
          "description": "Patch operations list"
        },
        "responses": {
          "200": {
            "description": "Successfully updated user",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserResponse"
                }
              },
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/UserResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              },
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Authorization failure",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              },
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Permissions denied",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              },
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              },
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Duplicate email or employeeNumber",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              },
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              },
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.joinblink.com/scim"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization"
      }
    },
    "schemas": {
      "Email": {
        "type": "object",
        "required": [
          "type",
          "value"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "work",
              "home",
              "other"
            ]
          },
          "value": {
            "type": "string"
          },
          "primary": {
            "type": "boolean"
          }
        }
      },
      "EnterpriseUser": {
        "type": "object",
        "properties": {
          "department": {
            "type": "string"
          },
          "manager": {
            "type": "object",
            "required": [
              "value",
              "$ref"
            ],
            "properties": {
              "value": {
                "type": "string"
              },
              "$ref": {
                "type": "string",
                "description": "Ref to the manager user, e.g. ../Users/{id}"
              }
            }
          },
          "employeeNumber": {
            "type": "string"
          }
        }
      },
      "BlinkUser": {
        "type": "object",
        "properties": {
          "attributes": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Custom fields with string values. Property names must match the identifier that is defined in the corresponding profile field on Blink Admin portal.",
            "example": {
              "customField1": "string",
              "customField2": "string",
              "customField3": "string"
            }
          },
          "multiAttributes": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Custom multi-value attributes with string array values. Property names must match the identifier that is defined in the corresponding profile field on Blink Admin portal.",
            "example": {
              "customMultiValueField1": [
                "value1",
                "value2"
              ]
            }
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string",
            "description": "Detail of error"
          },
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "urn:ietf:params:scim:api:messages:2.0:Error"
              ]
            }
          },
          "scimType": {
            "type": "string",
            "description": "Bad request type when status code is 400",
            "enum": [
              "uniqueness",
              "tooMany",
              "mutability",
              "sensitive",
              "invalidSyntax",
              "invalidFilter",
              "invalidPath",
              "invalidValue",
              "invalidVers",
              "noTarget"
            ]
          },
          "status": {
            "type": "string",
            "description": "Same as HTTP status code, e.g. 400, 401, etc."
          }
        }
      },
      "Meta": {
        "type": "object",
        "properties": {
          "created": {
            "type": "string",
            "format": "date-time"
          },
          "lastModified": {
            "type": "string",
            "format": "date-time"
          },
          "location": {
            "type": "string",
            "description": "Resource location URI"
          },
          "resourceType": {
            "type": "string",
            "enum": [
              "User",
              "Group"
            ]
          }
        },
        "description": "Resource metadata"
      },
      "Name": {
        "type": "object",
        "required": [
          "familyName",
          "givenName"
        ],
        "properties": {
          "familyName": {
            "type": "string"
          },
          "givenName": {
            "type": "string"
          },
          "formatted": {
            "type": "string"
          }
        }
      },
      "PatchOperation": {
        "type": "object",
        "required": [
          "op"
        ],
        "properties": {
          "op": {
            "type": "string",
            "enum": [
              "add",
              "replace",
              "remove"
            ]
          },
          "path": {
            "type": "string"
          },
          "value": {
            "type": "object",
            "description": "Corresponding 'value' of that field specified by 'path'"
          }
        }
      },
      "PhoneNumber": {
        "type": "object",
        "required": [
          "type",
          "value"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "work",
              "mobile",
              "other"
            ]
          },
          "value": {
            "type": "string"
          }
        }
      },
      "User": {
        "type": "object",
        "required": [
          "schemas",
          "userName"
        ],
        "properties": {
          "active": {
            "type": "boolean",
            "description": "User's status, e.g. enabled or disabled",
            "default": false
          },
          "emails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Email"
            }
          },
          "externalId": {
            "type": "string",
            "description": "External unique resource id defined by provisioning client"
          },
          "userName": {
            "type": "string",
            "description": "Username in identity provider"
          },
          "title": {
            "type": "string",
            "description": "The User's job title"
          },
          "name": {
            "$ref": "#/components/schemas/Name"
          },
          "phoneNumbers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PhoneNumber"
            }
          },
          "locale": {
            "type": "string",
            "description": "Indicates the User's preferred language which drives which language Blink sends communications in. Value must be a BCP 47 language tag.",
            "example": "en-US"
          },
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "urn:ietf:params:scim:schemas:core:2.0:User",
                "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
                "urn:ietf:params:scim:schemas:extension:blink:2.0:User"
              ]
            }
          },
          "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
            "$ref": "#/components/schemas/EnterpriseUser"
          },
          "urn:ietf:params:scim:schemas:extension:blink:2.0:User": {
            "$ref": "#/components/schemas/BlinkUser"
          }
        }
      },
      "UserPatch": {
        "type": "object",
        "required": [
          "Operations",
          "schemas"
        ],
        "properties": {
          "Operations": {
            "type": "array",
            "description": "Patch operations list",
            "items": {
              "$ref": "#/components/schemas/PatchOperation"
            }
          },
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "urn:ietf:params:scim:api:messages:2.0:PatchOp"
              ]
            }
          }
        }
      },
      "UserResponse": {
        "allOf": [
          {
            "$ref": "#/components/schemas/User"
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Blink generated user UUID"
              },
              "meta": {
                "$ref": "#/components/schemas/Meta"
              }
            }
          }
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true,
    "samples-languages": [
      "curl",
      "node",
      "ruby",
      "javascript",
      "python"
    ]
  }
}
```