Skip to main content
PUT
Update compliance configuration

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
enabled
boolean

Enable or disable compliance for this org.

callback_url
string

Default webhook URL for async compliance results.

lesson_tags_all
string[]

Lessons must have every tag in this list to be in scope.

lesson_tags_any
string[]

Lessons must have at least one tag in this list to be in scope.

completed_after
string

Relative time window for lesson completions (e.g. "-1 year").

released_only
boolean

When true, only released lessons count toward compliance.

released_after
string

Optional: only lessons released after this time count.

submission_enabled
boolean

Include form submissions in compliance scoring.

submission_completed_statuses
string[]

Submission statuses that count as completed.

submission_collection_ids
string[]

Limit scoring to specific submission collection IDs.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

Compliance configuration. All fields are.