Update Organization

Update an Organization

Request Details

path Parameters

Field	Type	Required	Description
id	string	Yes	The ID of the organization to update

body Parameters

Field	Type	Required	Description
name	string	Yes	The organization name
email	string	Yes	The organization email address
phone	string	Yes	The organization phone number
website	string	Yes	The organization website URL
locations	array OrganizationLocation	Yes	List of physical or operational locations for the organization
settings	object OrganizationSettings	No	Organization specific settings
admin	object AdminMember	Yes	Primary organization holder or main contact

Sample Request & Response

PATCH

/v1/organizations/me

Sample Request

Headers:

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Path Parameters:

{
  "id": "string (required) - The ID of the organization to update"
}

Body:

{
  "name": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "website": "example_string",
  "locations": [
    {
      "id": "example_string",
      "name": "example_string",
      "about": "example_string",
      "country": "example_string",
      "region": "example_string",
      "city": "example_string"
    }
  ],
  "settings": {
    "logoUrl": "example_string",
    "webhook": {
      "enabled": true,
      "url": "example_string",
      "events": [
        "resume.parsed"
      ]
    }
  },
  "admin": {
    "firstName": "example_string",
    "lastName": "example_string",
    "email": "example_string",
    "phone": "example_string",
    "settings": {
      "password": "example_string",
      "profilePictureUrl": "example_string"
    }
  }
}

Sample Response (200)

{
  "id": "example_string",
  "name": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "approved": true,
  "website": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "domain": {
    "name": "example_string",
    "verified": true,
    "requestedAt": "2025-07-26T12:00:00Z"
  },
  "locations": [
    {
      "id": "example_string",
      "name": "example_string",
      "about": "example_string",
      "country": "example_string",
      "region": "example_string",
      "city": "example_string"
    }
  ],
  "settings": {
    "logoUrl": "example_string",
    "webhook": {
      "enabled": true,
      "url": "example_string",
      "events": [
        "resume.parsed"
      ]
    }
  },
  "admin": {
    "firstName": "example_string",
    "lastName": "example_string",
    "email": "example_string",
    "phone": "example_string",
    "settings": {
      "profilePictureUrl": "example_string"
    }
  }
}