Check a name for the workspace's address

GET

/api/v1/workspace/address/check

curl --request GET \
  --url 'https://digize.com/api/v1/workspace/address/check?name=example' \
  --header 'x-api-key: <x-api-key>'

• Digize

Whether a name could be the workspace’s address: 3 to 40 lowercase letters, digits and dashes, not one the platform keeps for itself, and not another workspace’s.

Needs the settings:read permission.

Authorizations

• apiKey
• bearer

Parameters

Query Parameters

name

required

string

<= 64 characters

Responses

200

Done

Media typeapplication/json

object

name

required

string

available

required

boolean

reason

required

string | null

Example ^generated

{
  "name": "example",
  "available": true,
  "reason": "example"
}

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"
  }
}

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"
  }
}