POST/v1/RightsRequestConfig

Create Rights Request Config

Not yet documented — no summary in the API source.

RequiresAuthorization: Bearer sk_...tenant_id

Request body application/json

idstringnullable
tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
regulation_idstringrequiredmin length 1
request_typestringrequiredmin length 1
namestringnullable
state_machine_namestringnullable
stepsarray of objectRightRequestStepnullable
namestringrequiredmin length 1
identifierstringrequiredmin length 1
typestringrequiredmin length 1
orderinteger (int32)required
nextinteger (int32)
configobjectrconfig
email_template_idstringnullable
actionstringnullable
variable_to_check_for_choicestringnullable
variable_to_check_for_sending_emailstringnullable
variable_to_check_valuestringnullable
if_failedstringnullable
if_successstringnullable
end_typestringnullable
fulfillment_typestringnullable
link_to_update_formboolean
link_to_access_formboolean
link_to_change_consent_formboolean
hitl_template_idstringnullable
blockingboolean
completion_requirementsarray of objectStepCompletionMapnullable
errorStatesarray of objectErrorStatenullable
namestringnullable
messagestringnullable
actionstringnullable
optionalboolean
disabledboolean
startAtstringnullable
sf_configstringnullable

Responses

object RightRequestConfig — same shape as the request body.

curl --request POST \
  --url 'https://api.4comply.io/v1/RightsRequestConfig' \
  --header 'Authorization: Bearer sk_...' \
  --header 'tenant_id: your-tenant-id' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenant_id": "your-tenant-id",
  "created_at": "2026-09-07T12:00:00Z",
  "updated_at": "2026-09-07T12:00:00Z",
  "regulation_id": "00000000-0000-0000-0000-000000000000",
  "request_type": "string",
  "name": "Example name",
  "state_machine_name": "Example name",
  "steps": [
    {
      "name": "Example name",
      "identifier": "string",
      "type": "string",
      "order": 1,
      "next": 1,
      "config": {
        "email_template_id": "user@example.com",
        "action": "string",
        "variable_to_check_for_choice": "string",
        "variable_to_check_for_sending_email": "user@example.com",
        "variable_to_check_value": "string",
        "if_failed": "string",
        "if_success": "string",
        "end_type": "string",
        "fulfillment_type": "string",
        "link_to_update_form": true,
        "link_to_access_form": true,
        "link_to_change_consent_form": true,
        "hitl_template_id": "00000000-0000-0000-0000-000000000000",
        "blocking": true,
        "completion_requirements": [
          {
            "workflow_step_completion_config_id": "00000000-0000-0000-0000-000000000000",
            "is_required": true,
            "name": "Example name"
          }
        ]
      },
      "errorStates": [
        {
          "name": "Example name",
          "message": "Example text",
          "action": "string"
        }
      ],
      "optional": true,
      "disabled": true
    }
  ],
  "startAt": "2026-09-07T12:00:00Z",
  "sf_config": "string"
}'