Skip to main content
POST
/
clients
/
{id}
/
rules
Create Client Rule
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/rules \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "field_id": 111,
  "operator": "is not",
  "tag_id": null,
  "value": "Value"
}
'
{
  "fields": [
    {
      "id": "<string>",
      "field_id": "<string>",
      "field_type": "<string>",
      "field_name": "<string>",
      "operator": "<string>",
      "answers": [
        {
          "id": "<string>",
          "display": "<string>"
        }
      ],
      "value": "<string>"
    }
  ],
  "credentials": [
    {
      "id": "<string>",
      "credentials_id": "<string>",
      "field_id": "<string>",
      "field_type": "<string>",
      "field_name": "<string>",
      "name": "<string>",
      "operator": "<string>",
      "answers": [
        {
          "id": "<string>",
          "display": "<string>"
        }
      ],
      "value": "<string>"
    }
  ],
  "has_tags": [
    {
      "rule_id": "<string>",
      "id": "<string>",
      "text": "<string>"
    }
  ],
  "does_not_have_tags": [
    {
      "rule_id": "<string>",
      "id": "<string>",
      "text": "<string>"
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Client ID

Body

application/json
field_id
integer
required
operator
string
required
tag_id
string | null
value

Response

OK

fields
object[]
credentials
object[]
has_tags
object[]
does_not_have_tags
object[]