# Update the candidate profile (/docs/reference/profile)

`PATCH https://api.getmattered.com/api/v1/developer/profile`

Changes the fields you send and leaves the rest. Send `null` to clear a field. The same fields the candidate edits in GetMattered. Free.

Authentication: `Authorization: Bearer gm_live_...` (see /authentication.md).

## Request body (application/json)

```json
{
  "type": "object",
  "properties": {
    "addressLine1": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255,
      "description": "Address line 1",
      "example": "123 Main St"
    },
    "addressLine2": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255,
      "description": "Address line 2",
      "example": "Apt 4B"
    },
    "city": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 100,
      "description": "City",
      "example": "San Francisco"
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 100,
      "description": "Country",
      "example": "US"
    },
    "githubUrl": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 500,
      "format": "uri",
      "description": "GitHub profile URL",
      "example": "https://github.com/johndoe"
    },
    "linkedinUrl": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 500,
      "format": "uri",
      "description": "LinkedIn profile URL",
      "example": "https://linkedin.com/in/johndoe"
    },
    "phone": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20,
      "description": "Phone number",
      "example": "+1-555-123-4567"
    },
    "portfolioUrl": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 500,
      "format": "uri",
      "description": "Portfolio website URL",
      "example": "https://johndoe.dev"
    },
    "relocationLocations": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "Preferred relocation locations as \"City, Country\" or \"Country\" (max per-entry stripping of middle admin segments on ingest).",
      "example": [
        "New York, United States",
        "Austin, United States"
      ]
    },
    "state": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 100,
      "description": "State or province",
      "example": "CA"
    },
    "willingToRelocate": {
      "type": "boolean",
      "description": "Willing to relocate for a job",
      "example": false
    },
    "workAuthorization": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "us_citizen",
        "permanent_resident",
        "visa_holder",
        "require_sponsorship",
        "other",
        null
      ],
      "description": "Work authorization status",
      "example": "us_citizen"
    },
    "zipCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20,
      "description": "ZIP or postal code",
      "example": "94105"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "The candidate's full name, as employers see it.",
      "example": "Jane Doe"
    }
  },
  "additionalProperties": false
}
```

## Responses

### 200: The profile after the change.

```json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "addressLine1": {
          "type": [
            "string",
            "null"
          ],
          "description": "Address line 1",
          "example": "123 Main St"
        },
        "addressLine2": {
          "type": [
            "string",
            "null"
          ],
          "description": "Address line 2",
          "example": "Apt 4B"
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "City",
          "example": "San Francisco"
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "Country",
          "example": "US"
        },
        "githubUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "GitHub profile URL",
          "example": "https://github.com/johndoe"
        },
        "linkedinUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "LinkedIn profile URL",
          "example": "https://linkedin.com/in/johndoe"
        },
        "phone": {
          "type": [
            "string",
            "null"
          ],
          "description": "Phone number",
          "example": "+1-555-123-4567"
        },
        "portfolioUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "Portfolio website URL",
          "example": "https://johndoe.dev"
        },
        "relocationLocations": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "Preferred relocation locations as \"City, Country\" or \"Country\". Middle admin segments stripped on read.",
          "example": [
            "New York, United States",
            "Austin, United States"
          ]
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "State or province",
          "example": "CA"
        },
        "willingToRelocate": {
          "type": "boolean",
          "description": "Willing to relocate for a job",
          "example": false
        },
        "workAuthorization": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "us_citizen",
            "permanent_resident",
            "visa_holder",
            "require_sponsorship",
            "other",
            null
          ],
          "description": "Work authorization status",
          "example": "us_citizen"
        },
        "zipCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "ZIP or postal code",
          "example": "94105"
        },
        "email": {
          "type": "string",
          "description": "The account email. Read-only here.",
          "example": "jane@example.com"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The candidate's full name.",
          "example": "Jane Doe"
        }
      },
      "required": [
        "addressLine1",
        "addressLine2",
        "city",
        "country",
        "githubUrl",
        "linkedinUrl",
        "phone",
        "portfolioUrl",
        "relocationLocations",
        "state",
        "willingToRelocate",
        "workAuthorization",
        "zipCode",
        "email",
        "name"
      ]
    },
    "meta": {
      "type": "object",
      "properties": {
        "duration": {
          "type": "number",
          "minimum": 0,
          "description": "Request duration in milliseconds",
          "example": 150
        },
        "performance": {
          "type": "object",
          "properties": {
            "dbQueries": {
              "type": "integer",
              "minimum": 0
            },
            "totalDbTime": {
              "type": "number",
              "minimum": 0
            }
          },
          "description": "Performance metrics (preview/local only)"
        },
        "requestId": {
          "type": "string",
          "description": "Unique request identifier",
          "example": "req_abc123"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp",
          "example": "2026-11-17T12:00:00.000Z"
        },
        "version": {
          "type": "string",
          "description": "API version",
          "example": "v1"
        }
      }
    },
    "success": {
      "type": "boolean",
      "enum": [
        true
      ]
    }
  },
  "required": [
    "data",
    "success"
  ],
  "additionalProperties": false,
  "description": "Successful API response"
}
```

### 400: Bad Request

### 401: Unauthorized

### 404: Not Found

### 429: Too Many Requests

### 500: Internal Server Error

### 503: Service Unavailable

Error responses use the envelope in /errors.md.