Update

Beta

PUT

/tags/v1/:id/:version

Updates a tag. The path must contain the most recent version to prevent races.

AuthorizationBearer

OAuth authentication of the form <token>.

idstringRequired

The unique identifier for a Tag.

versionstringRequired

This endpoint expects an object.

valuestringRequired

descriptionstringOptional

alertbooleanOptional

This endpoint returns an object.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

idstring

The unique identifier for a Tag.

organization_idstring

The organization that owns this object.

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

valuestring

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

alertboolean

descriptionstring

$	curl -X PUT https://pre-api.joincandidhealth.com/tags/v1/id/version \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"value": "value"
>	}'

1	{
2	"deactivated": true,
3	"id": "id",
4	"organization_id": "organization_id",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"updating_user_id": "updating_user_id",
7	"value": "value",
8	"version": 1,
9	"alert": true,
10	"description": "description"
11	}