Updated on 2026-01-12 GMT+08:00

Creating a Publisher

Function

This API is used to create a publisher.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{domain_id}/publisher/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant ID, that is, domain ID of a user.

Constraints:

N/A

Range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for .

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition:

Publisher name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

user_id

No

String

Definition:

User ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

No

String

Definition:

Publisher description.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

logo_url

No

String

Definition:

Publisher icon URL.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

website

No

String

Definition:

Publisher website URL.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

support_url

Yes

String

Definition:

Publisher help address.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

source_url

No

String

Definition:

Source code address of the publisher.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

en_name

Yes

String

Definition:

Publisher name (English).

Constraints:

N/A

Value range:

N/A

Default value:

N/A

publisher_unique_id

No

String

Definition:

Publisher ID. Obtain the ID by calling the API for querying publisher details.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

String

Definition:

Whether the calling is successful.

Value range:

  • true: The calling is successful.

  • false: The calling fails.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/publisher/create

{
  "name" : "aaa",
  "en_name" : "aaa",
  "website" : "",
  "support_url" : "aaa@aa.com",
  "source_url" : "",
  "description" : "",
  "logo_url" : ""
}

Example Responses

Status code: 200

OK

true

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.