latestOpenAPI 3.0.12026-08-192092911.2 MB
916e669fc527
Persons
Remove a flag from a person
Remove a flag from a person.
Important: the flagId route parameter is the flag type ID — the same ID returned by GET /flags?entityType=ContactUser (requires the flags:read scope) and by GET /persons/{personId}/flags. It is not a history record ID, unlike the DELETE endpoint on other entity flag controllers (e.g. Purchase Orders, Sales Opportunities).
Removing a flag is permanent; no history of the removal is retained. (required scope contacts:persons:write)
delete/v1/persons/{personId}/flags/{flagId}
Path parameters
personIdstring uuid required
The unique identifier of the person
flagIdinteger required
The flag type ID to remove (not a history record ID)
Headers
Customer-Idinteger required
The customer identifier
Response
No Content