Update TLS organization | regfish DNS & TLS API

PATCH

/tls/organization/{organization_id}

TLSOrganizationsByID

Authentication

x-api-keyapplication/json

Getting startedAuthentication Regfish ConsoleCreate an API key in the regfish console and test it

Parameters

Name

Type

Format

Required

Description

organization_id

path

string

—

Required

Public TLS organization ID

Request body

application/jsonRequired

Partial TLS organization payload

tlsOrganizationPatchRequest

{
  "edit_mode": "create_replacement",
  "organization": "example",
  "first_name": "example",
  "last_name": "example"
}

Fields

Name

Type

Format

Required

Description

edit_mode

create_replacement, update_provider

string

—

Optional

—

organization

string

—

Optional

—

first_name

string

—

Optional

—

last_name

string

—

Optional

—

address

string

—

Optional

—

postal_code

string

—

Optional

—

city

string

—

Optional

—

country_code

string

—

Optional

—

phone

string

—

Optional

—

email

string

—

Optional

—

Request example

PATCH

curl --request PATCH \
  --url 'https://api.regfish.com/tls/organization/hdl_7K9QW3M2ZT8HJ' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{
  "edit_mode": "create_replacement",
  "organization": "example",
  "first_name": "example",
  "last_name": "example"
}'

Responses

200

TLS organization updated

application/jsontlsOrganizationResponse

Response example 200

{
  "success": true,
  "code": 0,
  "response": {
    "id": "hdl_7K9QW3M2ZT8HJ",
    "organization": "example",
    "status": "ready",
    "usable_for_ordering": true,
    "first_name": "example",
    "last_name": "example",
    "address": "example",
    "postal_code": "example",
    "city": "example",
    "country_code": "example",
    "phone": "example",
    "email": "example"
  }
}

400

Invalid request payload

application/jsonError

Response example 400

{
  "success": false,
  "message": "Invalid request payload",
  "error": "Invalid request payload"
}

401

Unauthorized

application/jsonError

Response example 401

{
  "success": false,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

404

TLS organization not found

application/jsonError

Response example 404

{
  "success": false,
  "message": "TLS organization not found",
  "error": "TLS organization not found"
}

500

Unexpected error

application/jsonError

Response example 500

{
  "success": false,
  "message": "Unexpected error",
  "error": "Unexpected error"
}

Authentication

Parameters

Request body

Fields

Request example

Responses

Become part of the community