| Authorization token required | true |
| Admin Authorization token required | false |
<CreateTagRequest> ## CreateTagRequest
<tag name="{tag-name}" [rgb="{rgb-color}"] [color="{color} (Byte)"] /> ## TagSpec
</CreateTagRequest>
elements and attributes you can define within a
<CreateTagRequest> element:
| XPath | Required / Optional | Description |
| /tag | Optional (0 or 1) | Tag specification |
| /tag@name | Required (only 1) | Type: String Tag name |
| /tag@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
| /tag@color | Optional (0 or 1) | Type: Byte color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
<CreateTagResponse> ## CreateTagResponse
<tag id="{tag-id}" [name="{tag-name}"] [color="{color} (Byte)"] [rgb="{rgb-color}"]
[u="{unread-count} (Integer)"] [n="{item-count} (Integer)"] [d="{date} (Long)"] [rev="{revision} (Integer)"]
[md="{change-date} (Long)"] [ms="{modified-sequence} (Integer)"]> ## TagInfo
(<meta [section="{section}"]> ## MailCustomMetadata
(<a n="{key}">{value}</a> ## KeyValuePair)*
</meta>)*
<retentionPolicy> ## RetentionPolicy
<purge>
(<policy [type="{retention-policy-type} (user | system)"] [id="{id}"] [name="{name}"]
[lifetime="{policy-duration}"] /> ## Policy)*
</purge>
</retentionPolicy>
</tag>
</CreateTagResponse>
elements and attributes you can define within a
<CreateTagResponse> element:
| XPath | Required / Optional | Description |
| /tag | Optional (0 or 1) | Information about the newly created tag |
| /tag@id | Required (only 1) | Type: String ID |
| /tag@name | Optional (0 or 1) | Type: String Name |
| /tag@color | Optional (0 or 1) | Type: Byte color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
| /tag@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
| /tag@u | Optional (0 or 1) | Type: Integer Unread count. Only present iff value > 0 |
| /tag@n | Optional (0 or 1) | Type: Integer Item count. Only present iff value > 0 |
| /tag@d | Optional (0 or 1) | Type: Long Date |
| /tag@rev | Optional (0 or 1) | Type: Integer Revision |
| /tag@md | Optional (0 or 1) | Type: Long Modified date in seconds |
| /tag@ms | Optional (0 or 1) | Type: Integer Modified sequence |
| /tag/meta | Optional (0 or more) | Custom metadata |
| /tag/meta@section | Optional (0 or 1) | Type: String Section. Normally present. If absent this indicates that CustomMetadata info is present but there are no sections to report on. |
| /tag/meta/a | Optional (0 or more) | Type: {value} Key value pairs Description for element text content:Value |
| /tag/meta/a@n | Required (only 1) | Type: String Key |
| /tag/retentionPolicy | Optional (0 or 1) | Retention policy |
| /tag/retentionPolicy/purge | Required (only 1) | |
| /tag/retentionPolicy/purge/policy | Optional (0 or more) | |
| /tag/retentionPolicy/purge/policy@type | Optional (0 or 1) | Type: user | system Retention policy type |
| /tag/retentionPolicy/purge/policy@id | Optional (0 or 1) | Type: String ID |
| /tag/retentionPolicy/purge/policy@name | Optional (0 or 1) | Type: String Name |
| /tag/retentionPolicy/purge/policy@lifetime | Optional (0 or 1) | Type: String Duration |