Skip to content
vocapable.Docs

Record your company's National Do Not Call SAN (owner only)

PUT
/v1/workspace/national-dnc/san
curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/national-dnc/san \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "account_ref": "example", "area_codes": [ "example" ], "expires_at": "2026-04-15T12:00:00Z" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceSanRegistration

Record (or refresh) the company’s SAN - the owner only.

object
account_ref
required
Account Ref
string
>= 1 characters <= 64 characters /^[A-Za-z0-9-]+$/
area_codes
required
Area Codes
Array<string>
>= 1 items <= 400 items
expires_at
Any of:
string format: date-time
Examplegenerated
{
  "account_ref": "example",
  "area_codes": [
    "example"
  ],
  "expires_at": "2026-04-15T12:00:00Z"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceNationalDncSetup

PRD E13-R3: the owner’s National Do Not Call setup - the SAN the company screens its marketing lists under (upstream, on its own side: adr/0018), and the attestation on record. Vocapable keeps both on file and shows them on every consent ledger; it never checks a number against the registry, and nothing here says it does.

object
san
required
Any of:
WorkspaceSanSubscription

The company’s own National Do Not Call Registry subscription (its SAN), on file.

object
account_hint
required
Account Hint
string
area_codes
required
Area Codes
Array<string>
status
required
Status
string
effective_at
required
Effective At
string format: date-time
expires_at
required
Any of:
string format: date-time
attested
required
Attested
boolean
attested_by
required
Any of:
string
attested_at
required
Any of:
string format: date-time
can_edit
required
Can Edit
boolean
registry_url
Registry Url
string
default: https://telemarketing.donotcall.gov
guidance
required
Guidance
string
Example
{
  "registry_url": "https://telemarketing.donotcall.gov"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}