Help Center> Simple Message Notification> API Reference> APIs> Application Endpoint Operations> Updating Application Endpoint Attributes
View PDF

Updating Application Endpoint Attributes

Function

This API is used to update application endpoint attributes.

URI

PUT /v2/{project_id}/notifications/endpoints/{endpoint_urn}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

See Obtaining a Project ID.

endpoint_urn

Yes

String

Specifies the unique resource identifier of the application endpoint. You can obtain it according to Querying the Endpoints of an Application.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

enabled

No

String

Specifies whether a device is enabled. The value can be true or false.

user_data

No

String

Specifies description or additional information about the endpoint. The value is a UTF-8 encoded string not exceeding 2048 bytes.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Example Requests

Updating application endpoint attributes

POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints

{
  "enabled" : "false",
  "user_data" : "This is an APNS token for user001"
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.