Skip to content
Swft Docs

Assign a custom checkout hostname to a merchant.

POST
/agencies/{workspaceId}/merchants/{merchantId}/custom-domain
 
curl --request POST \
  --url https://api.swft.co.uk/agencies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/merchants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/custom-domain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "hostname": "example" }'

Pass hostname for a fully-qualified domain on the shared Swft zone (e.g. checkout.example.com). Pass subdomain to provision under the partner’s delegated zone — the workspace must have partner_default_zone_id + partner_default_zone_apex configured (typically a one-time setup done by Swft when the partner delegates their sub-zone via NS records).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspaceId
required
string format: uuid
merchantId
required
string format: uuid

Header Parameters

Section titled “Header Parameters ”
idempotency-key
required
string
>= 1 characters

Request Body

Section titled “Request Body ”
Media type application/json
Any of:
object
hostname
required
string
/^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$/i/
Example generated
{
  "hostname": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Hostname registered. Customer must add the verification record(s).

Media type application/json
object
hostname
required
string
cname_target
required
string
ssl_status
required
string
ownership_verification
required
object
type
required
string
name
required
string
value
required
string
cloudflare_id
required
string
Example generated
{
  "hostname": "example",
  "cname_target": "example",
  "ssl_status": "example",
  "ownership_verification": {
    "type": "example",
    "name": "example",
    "value": "example"
  },
  "cloudflare_id": "example"
}

400

Section titled “400 ”

Bad request — malformed input or missing/invalid parameters.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

401

Section titled “401 ”

Missing or invalid authentication.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

403

Section titled “403 ”

Authenticated but not authorised (e.g. wrong workspace).

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

409

Section titled “409 ”

Conflict — idempotency-key reuse, duplicate resource, etc.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

429

Section titled “429 ”

Rate-limited.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

500

Section titled “500 ”

Internal server error.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}