Cognis
Commerce Domains

Patch Brand Link

PATCH
/org/{orgId}/ecom/domain/{domainId}

Public API endpoint: ecomDomain.patchBrandLink

Required scopes: org:ecom:domain:write

Authorization

bearerAuth
AuthorizationBearer <token>

API key (prefix: cogn_) from Account → Developer

In: header

Path Parameters

orgId*string

Organization ID (prefix: org_)

domainId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3013/api/v1/org/string/ecom/domain/string" \  -H "Content-Type: application/json" \  -d '{    "brandId": "string"  }'
{
  "success": true,
  "data": {
    "id": "1",
    "domain": "acme.com",
    "verified": true,
    "serviceTarget": "webshop",
    "createdAt": "2025-01-01T19:42:28.687Z",
    "updatedAt": "2025-01-02T10:15:00.000Z",
    "orgId": "1",
    "brandId": "10",
    "createdBy": null,
    "edgeProvisioningId": null,
    "edgeProvisioningStatus": null,
    "records": [
      {
        "type": "A",
        "value": "192.168.1.1"
      },
      {
        "type": "CNAME",
        "value": "edge.example.com",
        "name": "www"
      }
    ]
  },
  "message": "Success",
  "traceId": "req_abc123"
}
{
  "success": false,
  "message": "Invalid data",
  "errors": [
    {
      "code": 400,
      "message": "Invalid data"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unauthorized",
  "errors": [
    {
      "code": 401,
      "message": "Unauthorized"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Forbidden",
  "errors": [
    {
      "code": 403,
      "message": "Forbidden"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Not found",
  "errors": [
    {
      "code": 404,
      "message": "Not found"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Conflict",
  "errors": [
    {
      "code": 409,
      "message": "Conflict"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "string",
  "errors": [
    {
      "code": 0,
      "message": "string",
      "details": {}
    }
  ],
  "traceId": "string",
  "params": {},
  "readableMessage": "string"
}
{
  "success": false,
  "message": "Rate limit exceeded",
  "errors": [],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unexpected error",
  "errors": [
    {
      "code": 500,
      "message": "Unexpected error"
    }
  ],
  "traceId": "req_xxx"
}