CG Scanning API V2
5.2.0
  • latest
  • 5.2.0
HomeDocs
HomeDocs
5.2.0
  • latest
  • 5.2.0
  1. Organizations
  • Common Error Responses
  • Authentication
  • Filtering Data
  • Getting Started
  • Authentication
    • User Confirmation
      • Confirm a User
      • Show confirmation form
    • User Invitation
      • Accept an invitation
      • Pre-Accept invitation check
    • Password Reset
      • Forgot Password
      • Reset Password
    • Impersonation
      • Impersonate user
      • Impersonate user
    • MFA
      • Check 2fa
      • Send SMS OTP
    • Sign in authentication
      POST
    • Sign in with recovery code
      POST
    • Sign out authentication
      DELETE
  • Advanced Reports
    • List Advanced Reports
      GET
    • Create an advanced report
      POST
    • Show an advanced report
      GET
    • Update an advanced report
      PUT
    • Delete an advanced report
      DELETE
    • Delete advanced reports
      DELETE
    • Generates an advanced report file
      GET
    • Downloads an advanced report file
      GET
  • Audit
    • Get all events
    • Get event by id
  • Notifications
    • List Notifications
    • Show a notification
    • Delete a notification
    • Mark as read a notification
    • Mark as seen a notification
    • Mark as read all notifications
    • Mark as seen all notifications
  • Exceptions
    • List Exceptions
    • Create Exception
    • Update Exception
    • Show an exception
    • Delete an exception
    • Show exception details
    • Delete exceptions
    • Activate exceptions
    • Reset exceptions
    • Show the exceptions statistics
  • Hosts
    • List of hosts
    • Host details
    • List of most vulnerable hosts
  • Organizations
    • Organization Subscriptions
      • Retrieves all subscriptions of organization
      • Retrieves all active subscriptions of organization
      • Show a subscription of organization
      • 'Update organization's subscription'
      • Assign features to a subscription
      • Revoke features from a subscription
    • Subscribe to a plan
      POST
    • List organizations
      GET
    • Create Organization
      POST
    • List dependent subscriptions
      GET
    • Retrieve an organization
      GET
    • Update an organization
      PUT
    • Delete an organization
      DELETE
    • Subscribe an organization to a plan
      POST
    • Unsubscribe an organization from a plan
      POST
    • Change users Organization
      PUT
    • Export organizations
      GET
  • Whitelabel Settings
    • Show the white label settings
    • Show the white label settings
    • Update white label settings
  • Port Lists
    • List port lists
    • Create a port list
    • Show a port list
    • Update a port list
    • Delete a port list
    • List activated port lists
    • Add a port range to a port list
    • Delete a port range to a port list
    • Activate a port list
    • Deactivate a port list
    • Updates the app_type of a port list
    • Sync the a port lists
  • Reports
    • List Reports
    • Show a report
    • Delete a report
    • Delete reports
    • Generates a report file
    • Downloads a report file
    • Check if a report file exists
  • Scanners
    • List scanners
    • Create scanner
    • Show scanner
    • Update scanner
    • Delete scanner
    • List activated scanners
    • Activate scanner
    • Deactivate scanner
    • Update scanner app type
    • Assign a scanner to an organization
    • Verify a scanner
  • Scans
    • Scan Histories
      • List of history for a scan
      • History details for a scan
    • Scan Hosts
      • List of hosts for a scan
      • Host details for a scan
    • Scan Vulnerabilities
      • List of vulnerabilities for a scan
      • Show vulnerability details
      • Statistics for a scan
    • List scans
    • Create Scan
    • Show a scan
    • Updates a scan
    • Delete a scan
    • Delete scans
    • Start a scan
    • Stop a scan
    • List upcoming scans
    • List recent scans that have been completed
    • List of the running scans
    • Create Scan from Wizard
  • Schedules
    • List Schedules
    • Create Schedule
    • Updates a schedule
    • Show a schedule
    • Delete a schedule
    • Delete schedules
    • Calculate First Time Schedule Date
    • Calculate Next Schedule Dates
  • Targets
    • List targets
    • Create Target
    • Show a target
    • Updates a target
    • Delete a target
    • Delete targets
  • User
    • User 2FA
      • Enable 2FA
      • Verify 2FA installation
      • Disable 2FA
      • Lookup phone number
      • Default 2FA method
      • Generate Recovery Codes
      • Get Recovery Codes
    • User Preferences
      • Get users notification preferences
      • Change users product
      • Enable user's event notification preference
      • Disable user's event notification preference
    • Get current user
    • Update current user
    • Change current user password
    • Get current user active plans (Not implemented yet)
    • Get organization members
    • Get current user products
    • Get current organization
    • Update current organization
    • Get subscriptions history
    • Change users product
    • Checks if authorization token is valid
    • Get current user permissions
    • Check if the user can be deleted
    • Delete my account
    • Generates a new access token
    • Revokes the current access token
    • (Admin) Transfers all the resources from the user to another user
  • Users
    • List Users
    • Create User
    • Show User
    • Update User
    • Delete a User
    • Create Customer
    • Invite User
    • Resend Confirmation Instructions
    • Import Users
    • Check if a user can be deleted
    • Inherit all the resources from a user
    • Export all users to a CSV file
    • Set partner
    • Unset partner
  • Vulnerabilities
    • List of vulnerabilities
    • Vulnerability details
    • Total Vulnerabilities (widget)
    • Top Vulnerabilities (widget)
    • PCI Compliant (widget)
    • (AI) Send prompt about a given Vulnerability
    • (AI) Chat history about a given Vulnerability
  • Webhooks
    • Deliveries
      • List all deliveries for a webhook
      • Get a delivery for a webhook
    • List all webhooks
    • Create a webhook
    • Show a webhook
    • Update a webhook
    • Delete a webhook
    • Activate a webhook
    • Deactivate a webhook
  1. Organizations

Update an organization

PUT
/v2/organizations/{id}
Organizations
Last modified:2025-04-24 10:59:46
Update an organization

Request

Path Params
id
string 
required
Body Params application/json
organization
object 
optional
name
string 
required
Organization's Name
company_name
string 
required
Organization's Company Name
description
string 
optional
Organization's Description
address
string 
optional
Organization's Address
city
string 
optional
Organization's City
state
string 
optional
Organization's State
zipcode
string 
optional
Organization's Zip Code
country
string 
optional
Organization's Country
phone
string 
optional
Organization's Phone Number
website
string 
optional
Organization's Website
email
string 
optional
Organization's Email
contact_name
string 
optional
Primary Contact Person's Name
contact_title
string 
optional
Primary Contact Person's Title
contact_phone
string 
optional
Primary Contact Person's Phone Number
contact_email
string 
optional
Primary Contact Person's Email
Example
{
  "organization": {
    "name": "string",
    "company_name": "string",
    "description": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "zipcode": "string",
    "country": "string",
    "phone": "string",
    "website": "string",
    "email": "string",
    "contact_name": "string",
    "contact_title": "string",
    "contact_phone": "string",
    "contact_email": "string"
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/v2/organizations/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "organization": {
        "name": "string",
        "company_name": "string",
        "description": "string",
        "address": "string",
        "city": "string",
        "state": "string",
        "zipcode": "string",
        "country": "string",
        "phone": "string",
        "website": "string",
        "email": "string",
        "contact_name": "string",
        "contact_title": "string",
        "contact_phone": "string",
        "contact_email": "string"
    }
}'

Responses

🟢200OK
organization updated
This response does not have a body.
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-04-24 10:59:46
Previous
Retrieve an organization
Next
Delete an organization
Built with