PATCH: Update a Collaboration Registration Form

Ingrid

https://api.bitsighttech.com/ratings/v1/client-access-links/collab_form_guid

Edit the properties (name and description) of a registration form for clients to register for the Client/Vendor Access Program.

Available for Cyber Insurance users.

Parameters

Parameter	Values
guid [Path] Identify the form to update.	[String] Form unique identifier [`collab_form_guid`]. See GET: Collaboration Forms.
name [Body] Assign a name for the form.	[String]
description [Body] Provide a description of the form.	[String]
is_active [Body] Determine if the form is active.	[Boolean] `true` = The form is active. `false` = The form is inactive.

Example Request

cURL Example

curl 'https://api.bitsighttech.com/ratings/v1/client-access-links/19caa9ab-0560-4661-9d02-3364b13714ec' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{
  "name": "Example name",
  "description": "Example description",
  "is_active": true
}' --compressed

JSON Example

{
  "name": "Example name", 
  "description": "Example description",
  "is_active": true
}

Example Response

{
  "guid": "19caa9ab-0560-4661-9d02-3364b13714ec",
  "link": "https://service.bitsighttech.com/app/static/pages/access-request?token=19caa9ab-0560-4661-9d02-3364b13714ec",
  "name": "Example name",
  "description": "Example description",
  "is_active": true,
  "created_time": "2024-01-29T17:37:54.968848Z",
  "updated_time": "2024-01-29T17:37:54.968893Z",
  "created_by": {
    "guid": "de5750f0-f60b-4478-9bfc-08m20e71f4b2",
    "formal_name": "User One"
  },
  "updated_by": null
}

Response Attributes

Field		Description
guid String [`collab_form_guid`]		The unique identifier of this collaboration registration form.
link String		The form URL.
name String		The name of this form.
description String		A description of this form.
is_active Boolean		true = This form is active.
created_time String [`YYYY-MM-DDTHH:MM:SSZ`]		The date and time when this form was created.
updated_time String [`YYYY-MM-DDTHH:MM:SSZ`]		The date and time when this form was last updated.
created_by Object		The user who created this form.
	guid String [`user_guid`]	This user’s unique identifier.
	formal_name String	This user's name.
updated_by Object		The user who last updated this form.
	guid String [`user_guid`]	This user’s unique identifier.
	formal_name String	This user's name.

Status Codes

See the common errors and status codes.

Code	Description
`200` – Okay	Everything worked as expected.
`400` – Bad Request	This can often be due to missing a required parameter.
`401` – No Authentication	No valid API token was provided.
`403` – Unauthorized	You do not have permission to access this resource.
`404` – Not Found	The specified resource could not be found.

February 12, 2024: Published.