Set the tap page's address

POST

/api/v1/cards/tap-page/domain

curl --request POST \
  --url https://digize.com/api/v1/cards/tap-page/domain \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "hostname": "example" }'

• Digize

Sets the address on the business’s own domain new cards’ links are on, such as review.brightwave.com: a custom hostname, with the records to add at its DNS provider. Cards made before keep their address.

Needs the settings:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

hostname

required

string

>= 4 characters <= 253 characters

Example ^generated

{
  "hostname": "example"
}

Responses

200

Done

Media typeapplication/json

object

heading

required

string

>= 1 characters <= 80 characters

ratingStyle

required

string

Allowed values: stars faces

threshold

required

integer

>= 3 <= 5

destination

required

string

Allowed values: google facebook

positive

required

object

heading

required

string

>= 1 characters <= 60 characters

message

required

string

<= 240 characters

button

required

string

>= 1 characters <= 40 characters

skip

required

boolean

negative

required

object

heading

required

string

>= 1 characters <= 60 characters

prompt

required

string

<= 160 characters

askContact

required

boolean

thanks

required

string

>= 1 characters <= 240 characters

publicLinkForAll

required

boolean

fallbackUrl

required

string

<= 500 characters /^https:\/\/[^\s/.]+\.\S+$/

hostname

required

The address new cards’ links are on, or empty until one is set up.

string

domainStatus

required

Any of:

string

string

Allowed values: active pending_dns verifying failed

null

null

records

required

Array<object>

object

type

required

string

Allowed values: CNAME TXT MX

name

required

string

value

required

string

priority

number

status

required

string

Allowed values: found missing mismatch

purpose

required

string

optional

boolean

verifiedAt

required

Any of:

string

string format: date-time

null

null

error

required

string | null

domains

required

Array<object>

object

hostname

required

string

status

required

string

Allowed values: active pending_dns verifying failed

certificate

required

string

Allowed values: active issuing waiting failed

records

required

Array<object>

object

type

required

string

Allowed values: CNAME TXT MX

name

required

string

value

required

string

priority

number

status

required

string

Allowed values: found missing mismatch

purpose

required

string

optional

boolean

error

required

string | null

addedAt

required

string format: date-time

verifiedAt

required

Any of:

string

string format: date-time

null

null

checkedAt

required

string format: date-time

url

required

string

updatedAt

required

Any of:

string

string format: date-time

null

null

updatedBy

required

string | null

Example

{
  "ratingStyle": "stars",
  "destination": "google",
  "domainStatus": "active",
  "records": [
    {
      "type": "CNAME",
      "status": "found"
    }
  ],
  "domains": [
    {
      "status": "active",
      "certificate": "active",
      "records": [
        {
          "type": "CNAME",
          "status": "found"
        }
      ]
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}