Add an Annotation Header

Add an annotation header to your system. Use the get annotation headers request to check that none of the annotations already in the system are similar to the annotation header that you want to add. Use the update annotation header request to rename, enable/disable an existing annotation header if applicable.

Endpoint

Method: POST

URL: /annotation/header

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`id`	Integer	A space for the ID of the annotation header, leave this blank, the ID will be auto-generated as part of the request.	N/A
`header`	String	The name of the annotation header to add, this is what will be used as part of the actual annotations.	Required
`enabled`	Boolean	Enable (`true`) or disable (`false`) the header for use in your system once it's created.	Required

Note

The header and enabled parameters can be updated later using the update annotation header request.

See Sample Request for an example.

Response and Error Code

Response Code	Condition
201	Created

Response Parameter

Parameter Name	Data Type	Description
`id`	Integer	The auto-generated ID of the annotation header just created.
`header`	String	The name of the annotation header just created, this is what will be used as part of the actual annotations.
`enabled`	Boolean	If the header is Enabled (`true`) or disabled (parameter will not be displayed if false) for use in your system.

See Sample Response for an example.

Sample Request

{
    "id": "",
    "header": "Example Header 1",
    "enabled": true
}

Sample Response

{
    "id": "2563",
    "header": "Example Header 1",
    "enabled": true
}

In this section:

Uniphore Customer Portal