Push Tag (PUT)
Updates tag information
Description
Updates the tag referenced by the tagName of the application referenced by the applicationId.
Method
PUT
Path
/apps/applicationId/tags/tagName
Example
https://example.com:443/imfpush/v1/apps/myapp/tags/sports
Path Parameters
- applicationId
- The name or identifier of the application
- tagName
- The name of the tag
Header Parameters
Some header parameters are optional.
- Accept-Language
- (Optional) The preferred language to use for error messages. Default:en-US
- Authorization
- The token with the scope "tags.write" and "push.application.<applicationId>" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.
- Content-Type
- Specify the JSON content type. For example: application/json. This parameter has to be mandatorily set.
Produces
application/json
Payload
The details of the tag.
JSON Example
{
"description" : "Description about SampleTag",
"name" : "SampleTag",
}
Payload Properties
The payload has the following properties:- description
- The description of the tag
- name
- An unique name of the tag in the application
Response
The details of the tag.
JSON Example
{
"createdMode" : "API",
"createdTime" : "2015-08-22T18:19:58Z",
"description" : "Description about SampleTag",
"href" : "https://example.com:443/imfpush/v1/apps/testApp/tags/SampleTag",
"lastUpdatedTime" : "2015-08-22T18:19:58Z",
"name" : "SampleTag",
}
Response Properties
The response has the following properties:
- createdMode
- Defaults to API
- createdTime
- The time at which the tag was created
- description
- The description of the tag
- href
- The URL to the tag
- lastUpdatedTime
- The time at which the tag was last updated
- name
- An unique name of the tag in the application
Errors
400Bad Request - The request was not understood by the push server. An invalid JSON could result in this error code.401
Unauthorized - The caller is either not authenticated or not authorized to make this request.404
The tag with the specified tagName is not found.405
Unsupported Content type - The content type specified in Content-Type header is not application/json.406
Unsupported Accept type - The content type specified in Accept header is not application/json.500
An internal error occurred.