Update a Group

patch

https://api.pactsafe.com/v1.1/groups/{group_id}

Update a Group by ID

Path Params

group_id

integer

required

Body Params

name

string

key

string

description

string

tags

type

string

enum

Allowed:

style

string

enum

Allowed:

custom_styles

string

Custom CSS styles to apply to the embedded clickwrap group.

rendered_by_user

boolean

expect_agreed_click

boolean

expect_disagreed

boolean

container_selector

string

The CSS selector for the group container element.

signer_id_selector

string

The CSS selector for the input element containing the signer ID value.

form_selector

string

The CSS selector for the form element the group belongs to.

block_submission

boolean

Defaults to true

force_scroll

boolean

Defaults to false

auto_run

boolean

Defaults to true

display_all

boolean

Defaults to true

alert_message

string

Defaults to Before you can submit this form, you must accept all of our legal contracts.

acceptance_language

string

The language to display alongside the group checkbox.

confirmation_email

boolean

Defaults to false

hide_record_summary

boolean

Defaults to false

opt_out_language

string

target_jurisdictions

array of strings

target_jurisdictions

target_selector

string

position

string

enum

Allowed:

open_legal_center

boolean

Defaults to true

always_visible

boolean

Defaults to false

badge_text

string

The text to display on the floating browsewrap badge.

instructions

string

protected_url

boolean

redirect_url

string

contracts

array of objects

contracts

validate_unique_classifications

array of strings

validate_unique_classifications

dynamic

boolean

Defaults to false

render_data

object

notification_email

string

The email address to send internal notifications to when a group is accepted.

snapshots_enabled

boolean

snapshot_config

string

snapshot

object

snapshot_locations

array of strings

snapshot_locations

download_contracts

boolean

Defaults to false

Responses

400

Bad request.

401

The requester is unauthorized.

403

Forbidden.

404

Not found.

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated Group