PUT /api/v1/org/captcha

Replaces the CAPTCHA settings object for your organization

Note: You can disable CAPTCHA for your organization by setting captchaId and enabledPages to null.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
_links Object No

Link relations for the CAPTCHA settings object

_links.self Object No
_links.self.href String Yes

Link URI

_links.self.templated Boolean No

Indicates whether the Link Object's href property is a URI template.

_links.self.name String No

Link name

_links.self.type String No

The media type of the link. If omitted, it is implicitly application/json.

_links.self.hints Object No

Describes allowed HTTP verbs for the href

_links.self.hints.allow[] Array No
captchaId String No

The unique key of the associated CAPTCHA instance

enabledPages[] Array No

An array of pages that have CAPTCHA enabled

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.