Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 3.4 KB

README.md

File metadata and controls

61 lines (41 loc) · 3.4 KB

OrganizationDomain

(organizationDomain)

Overview

Available Operations

  • update - Update an organization domain.

update

Updates the properties of an existing organization domain.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;
use Clerk\Backend\Models\Operations;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$requestBody = new Operations\UpdateOrganizationDomainRequestBody();

$response = $sdk->organizationDomain->update(
    organizationId: '<id>',
    domainId: '<id>',
    requestBody: $requestBody

);

if ($response->organizationDomain !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
organizationId string ✔️ The ID of the organization the domain belongs to
domainId string ✔️ The ID of the domain
requestBody Operations\UpdateOrganizationDomainRequestBody ✔️ N/A

Response

?Operations\UpdateOrganizationDomainResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors 400, 404, 422 application/json
Errors\SDKException 4XX, 5XX */*