Update Organization
Update the main organization's details, including its name, branding images, and contact information. This endpoint allows you to modify key organization attributes for branding and identification purposes.
HTTP Method and URL
PUT
{{host}}/api/v2/organizations?user_type=ENTERPRISE_API
Authentication Requirements
Requires a valid user token in the request headers.
Path and Query Parameters
user_type(query, required): Must be set toENTERPRISE_API.
Request Body
Send as multipart/form-data:
-
name(string, required): The new name for the organization. -
photo(file, optional): Banner image for the organization. -
avatar(file, optional): Round avatar image for branding.
Example Request
plaintextPUT {{host}}/api/v2/organizations? user_type=ENTERPRISE_APIHeaders: Authorization: Bearer {USER-TOKEN}Body (form-data): name: test org photo: [file] avatar: [file]
Example Successful Response
json{ "status": "success", "message": "Organization updated successfully."}
Error Responses
-
400 Bad Request: Invalid or missing fields in the request body. -
401 Unauthorized: Authentication failed or missing token. -
404 Not Found: Organization not found. -
415 Unsupported Media Type: Incorrect file type for photo or avatar.
Usage Notes
-
Only users with appropriate permissions can update organization details.
-
If you upload images, ensure they meet the required format and size constraints.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
