Add Tags to a Document

POST 
/api/v8/partner/documents/:document_id/tags

Add existing Tags or create new Tags and add it to a Document.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

application/json

Body

anyOf

TagPOSTRequest

tags string[]required

Possible values: >= 1

Responses

200

List of Tags assigned to a specific Document.

application/json

Schema

Schema

anyOf
TagsResponse
tags object[]required
The list of tags.
Array [
id integerrequired
The unique identifier of the tag.
name stringrequired
The value of the tag.
]

Example (from schema)

{}

201

List of Tags assigned to a specific Document.

application/json

Schema

Schema

anyOf
TagsResponse
tags object[]required
The list of tags.
Array [
id integerrequired
The unique identifier of the tag.
name stringrequired
The value of the tag.
]

Example (from schema)

{}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

503

Service is temporaly unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporaly unavailable. Please try again later

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string",
  "details": [
    {}
  ]
}

Loading...