Revenue

Add rule

Changed on

Add rule sends kind protected_address and value buyer@example.com. The server lowercases the address, stores an active rule, and returns that rule with the sha256 of the stored address.

post/v1/revenue-workspaces/current/communication-privacy-rules

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/revenue-workspaces/current/communication-privacy-rules
  • Auth: HTTP bearer

Request body

kind'protected_address' | 'protected_domain' | 'blocked_address' | 'blocked_domain' required

Rule kind. Add rule leaves the default protected address selected.

valuestring required

Address or domain typed into the rule field.

Example request

{
  "kind": "protected_address",
  "value": "buyer@example.com"
}

Response

Stored privacy rule.

activeboolean required

New rules are stored active.

idstring uuid required

Rule id.

kind'protected_address' | 'protected_domain' | 'blocked_address' | 'blocked_domain' required

Stored rule kind.

valuestring required

Normalized address or domain.

valueHashstring required

sha256 of the normalized value.

Example response

{
  "active": true,
  "id": "3b8dfa9b-a7b2-46ea-982c-622a914c00e5",
  "kind": "protected_address",
  "value": "buyer@example.com",
  "valueHash": "sha256:6a6c26195c3682faa816966af789717c3bfa834eee6c599d667d2b3429c27cfd"
}

Changes