Add a flag to a person

Apply a flag to a person.

Person flags differ from other entity flag endpoints: adding a flag does not create a history record — it tags the person with the flag type directly. This operation is idempotent: if the flag is already applied the request succeeds with 204 No Content and the person's flags are unchanged.

The flagId must be a flag type ID configured for the ContactUser entity type. Use GET /flags?entityType=ContactUser (requires the flags:read scope) to find valid flag IDs for this customer. (required scope contacts:persons:write)

post/v1/persons/{personId}/flags

Path parameters

personIdstring uuid required

The unique identifier of the person

Headers

Customer-Idinteger required

The customer identifier

Request body

flagIdinteger

The ID of the flag to apply to the person

Example request

{
  "flagId": 42
}

Response

No Content