1
0
forked from docs/doc-exports
doc-exports/docs/smn/api-ref/en-us_topic_0036017301.html
Zaoxu, Li 152a7d9381 SMN API DOC
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-06-20 15:01:38 +00:00

9.4 KiB

Updating a Topic

Description

  • API name

    UpdateTopic

  • Function

    Update the topic display name.

URI

  • URI format

    PUT /v2/{project_id}/notifications/topics/{topic_urn}

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID

    See Obtaining a Project ID.

    topic_urn

    Yes

    String

    Unique resource ID of a topic. You can obtain it by referring to Querying Topics.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    display_name

    Yes

    String

    Topic display name, which is presented as the name of the email sender in email messages

    The display name cannot exceed 192 bytes.

  • Example request
    PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2
    { 
        "display_name": "testtest222"
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    request_id

    String

    Request ID, which is unique

  • Example response
    {
        "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085"
    }

Returned Value

See Returned Value.

Error Codes

See Error Codes.