Skip to main content
PUT
/
api
/
adm
/
companyProjects
/
{id}
/
general
Update Project General Information
curl --request PUT \
  --url https://localhost:44371/api/adm/companyProjects/{id}/general \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Updates basic project settings including name, description, callback URLs for payment flows, and active status. Common use cases include renaming projects, updating return/cancel URLs, changing descriptions, or activating/deactivating projects.

​
Input

  • Path Parameter: id (guid, required) — Unique identifier of the project to update.
  • Body: model (CompanyProjectGeneralInfoUpdateCommandRequest, required) — Updated information including:
    • id (guid, required) — Project identifier (must match path parameter).
    • name (string, optional) — New project name.
    • description (string, optional) — Updated description.
    • returnUrl (string, optional) — Payment success redirect URL.
    • cancelUrl (string, optional) — Payment cancellation redirect URL.
    • isActive (bool, optional) — Active status.

​
Output

Returns a CompanyProjectUpdateCommandResponse indicating whether the update was successful.

​
Example Request

PUT /api/admin/companyProjects/7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a/general-info
Content-Type: application/json
Authorization: Bearer {token}

{
  "id": "7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a",
  "name": "E-Commerce Application v2",
  "description": "Updated payment processing for online store",
  "returnUrl": "https://example.com/payment/success",
  "cancelUrl": "https://example.com/payment/cancelled",
  "isActive": true
}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Errors

  • 400 Bad Request — Missing required fields, validation errors, duplicate project name within company, or invalid URL format.
  • 404 Not Found — No project exists with the specified ID.

​
Notes

  • Setting isActive to false prevents the project from processing new transactions.
  • Return and cancel URLs must be absolute URLs (include protocol and domain).
  • Project name changes do not affect existing transactions or historical data.
  • This endpoint does not modify payment processor or security settings.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string<guid>
required

The unique identifier of the project to update.

Body

application/json

The updated project information including name, description, return URL, cancel URL, and status.

Base structure for command requests that modify data. Represents the payload used to update the general project information.

​
projectName
string
required

Project Name

Maximum string length: 50
​
id
string<guid>

The identifier of the project being updated.

​
phone
string | null

The public phone number for the project.

Maximum string length: 25
​
isActive
boolean

Indicates whether the project is active.

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard command response indicating the result of a data modification. Represents the response returned after updating project information.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null