Modify organization details

POST /organizations/{organization-id}/modify

Updates organization information including description, email, website URL, and tags. Only non-null fields in the request will be updated.

Path parameters

organization-id string Required

External ID of the organization to modify

Minimum length is 1, maximum length is 100.

application/json

Body Required

Responses

200 application/json

Organization modified successfully
Hide response attribute Show response attribute object
- success boolean
400 application/json

Bad Request - Validation errors or constraint violations
Hide response attributes Show response attributes object
- error string Required
  
  Error type or category
- message string Required
  
  Human-readable error message
- timestamp string(date-time) Required
  
  Timestamp when the error occurred
- success boolean
  
  Indicates if the operation was successful
- details object
  
  Additional error details
  
  Additional properties are allowed.
401 application/json

Unauthorized - Invalid or missing authentication token
Hide response attributes Show response attributes object
- error string Required
  
  Error type or category
- message string Required
  
  Human-readable error message
- timestamp string(date-time) Required
  
  Timestamp when the error occurred
- success boolean
  
  Indicates if the operation was successful
- details object
  
  Additional error details
  
  Additional properties are allowed.
403 application/json

Forbidden - Insufficient permissions
Hide response attributes Show response attributes object
- error string Required
  
  Error type or category
- message string Required
  
  Human-readable error message
- timestamp string(date-time) Required
  
  Timestamp when the error occurred
- success boolean
  
  Indicates if the operation was successful
- details object
  
  Additional error details
  
  Additional properties are allowed.
404 application/json

Not Found - Organization not found
Hide response attributes Show response attributes object
- error string Required
  
  Error type or category
- message string Required
  
  Human-readable error message
- timestamp string(date-time) Required
  
  Timestamp when the error occurred
- success boolean
  
  Indicates if the operation was successful
- details object
  
  Additional error details
  
  Additional properties are allowed.
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- error string Required
  
  Error type or category
- message string Required
  
  Human-readable error message
- timestamp string(date-time) Required
  
  Timestamp when the error occurred
- success boolean
  
  Indicates if the operation was successful
- details object
  
  Additional error details
  
  Additional properties are allowed.

POST /organizations/{organization-id}/modify

curl \
 --request POST 'http://api.example.com/organizations/org-12345/modify' \
 --header "Content-Type: application/json" \
 --data '{"tags":["technology","startup","ai"],"email":"contact@example.com","description":"Updated organization description","website-url":"https://www.example.com"}'

Request examples

{
  "tags": [
    "technology",
    "startup",
    "ai"
  ],
  "email": "contact@example.com",
  "description": "Updated organization description",
  "website-url": "https://www.example.com"
}

{
  "description": "New description only"
}

Response examples (200)

{
  "success": true
}

Response examples (400)

{
  "error": "Bad Request",
  "details": {
    "validation_errors": {
      "organization-id": "Organization Id is required"
    }
  },
  "message": "Validation failed",
  "success": false,
  "timestamp": "2025-01-15T10:30:00Z"
}

{
  "error": "Bad Request",
  "message": "Constraint violation: Organization Id is required",
  "success": false,
  "timestamp": "2025-01-15T10:30:00Z"
}

Response examples (401)

{
  "error": "401 UNAUTHORIZED",
  "message": "Token not valid: Token has expired",
  "success": false,
  "timestamp": "2025-01-15T10:30:00Z"
}

{
  "error": "401 UNAUTHORIZED",
  "message": "Access Denied",
  "success": false,
  "timestamp": "2025-01-15T10:30:00Z"
}

Response examples (403)

{
  "error": "Forbidden",
  "message": "Insufficient permissions to modify this organization",
  "success": false,
  "timestamp": "2025-01-15T10:30:00Z"
}

Response examples (404)

{
  "error": "404 NOT_FOUND",
  "message": "Organization not found",
  "success": false,
  "timestamp": "2025-01-15T10:30:00Z"
}

Response examples (500)

{
  "error": "Internal Server Error",
  "message": "An unexpected error occurred. Please try again later.",
  "success": false,
  "timestamp": "2025-01-15T10:30:00Z"
}