Skip to content
vocapable.Docs

Claim an email domain (then publish its TXT record and verify)

POST
/v1/workspace/sso/domains
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/sso/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "domain": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceSsoDomainCreate
object
domain
required
Domain
string
>= 3 characters <= 253 characters
Examplegenerated
{
  "domain": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceSsoDomain
object
id
required
Id
string
domain
required
Domain
string
record_name
required
Record Name
string
record_value
required
Record Value
string
verified_at
required
Any of:
string format: date-time
last_checked_at
required
Any of:
string format: date-time
Examplegenerated
{
  "id": "example",
  "domain": "example",
  "record_name": "example",
  "record_value": "example",
  "verified_at": "2026-04-15T12:00:00Z",
  "last_checked_at": "2026-04-15T12:00:00Z"
}

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": {}
    }
  ]
}