Skip to main content
POST
/
claimed-domains
Claim a domain
curl --request POST \
  --url https://api.withampersand.com/v1/claimed-domains \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "domain": "xyz@withampersand.com",
  "parentId": "orgId",
  "parentType": "org"
}'
This response does not have an example.

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
domain
string
required

Accepts an email address, domain name, or URL. The domain will be automatically extracted: for emails, the portion after @ is used (e.g., "user@example.com" becomes "example.com"); for URLs, the hostname is extracted (e.g., "https://www.example.com" becomes "example.com").

Example:

"xyz@withampersand.com"

​
parentId
string
required

ID of the parent entity claiming the domain

Example:

"orgId"

​
parentType
string
required

Type of the parent entity

Example:

"org"

Response

Domain claimed successfully

⌘I