Add tags to a W-2

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

Add existing tags or create new tags and add them to a W-2.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

application/json

Body

tags string[]required

Possible values: non-empty

Responses

200

List of tags assigned to a specific W-2.

application/json

Schema

Schema

tags object[]required
The list of tags.
Array [
id integerrequired
The unique identifier of the tag.
name stringrequired
Possible values: non-empty
The value of the tag.
]

Example (from schema)

{
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

201

List of tags assigned to a specific W-2.

application/json

Schema

Schema

tags object[]required
The list of tags.
Array [
id integerrequired
The unique identifier of the tag.
name stringrequired
Possible values: non-empty
The value of the tag.
]

Example (from schema)

{
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

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)

{}

403

User error

application/json

Schema

Schema

oneOf

AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED

status string

Default value: fail

error string

Default value: Authentication credentials were not provided.

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)

{}

413

Request body too large

application/json

Schema

Schema

oneOf

REQUEST_BODY_TOO_LARGE

status string

Default value: fail

error string

Default value: Request body too large

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)

{}

500

Unexpected error

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

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

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 120 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

General error response

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string"
}

Loading...