People
Update a person
Changes the given fields of one person owned by the authenticated team and returns the updated person. A rename to a first and last name already used on the team answers conflict without changing anything. People on other teams or sub-teams, or above the token's classification ceiling, are reported as not found.
patchhttps://api.govdash.us/v1/people/{id}
Authorization
Your API key as a bearer token, for example Bearer gd_live_....
See Authentication for how to create a key.
Path parameters
Person identifier.
Headers
The dated API version this request is written against. Responses keep that version's shape after newer versions ship.
One of:
Body
application/jsonFields to change. Send at least one; omitted fields keep their values, and null clears a nullable field. first_name and last_name can be replaced but not cleared.
Name prefix, title, or rank such as Dr., CPL, or Gen.
First (given) name.
Middle name.
Last (family) name. The full name must be unique within the team.
Name suffix such as Jr., Sr., or III.
Email address.
Phone number.
LinkedIn profile URL.
Response
200 · application/jsonA person in the team's Data Library.
Person identifier.
Object type, always person.
Data classification of the person.
One of:
Full display name, combined from the name parts.
Name prefix, title, or rank such as Dr., CPL, or Gen.
First (given) name.
Middle name.
Last (family) name.
Name suffix such as Jr., Sr., or III.
Email address.
Phone number.
LinkedIn profile URL.
When the person was last updated.
Companies and agencies the person works for. Employers the token cannot read are left out.
Show child attributesHide child attributes
Identifier of the employing company.
Identifier of the employing agency.
Whether this is the person's primary employment.
Errors
Every error returns a stable error.code to branch on and an error.message that says what went wrong, like the examples below. See Errors for how to handle each one.
The body is empty, has a field this endpoint doesn't accept, or a field has the wrong type. The message names the field.
Invalid request body: Expected a value with at least 1 entry
The key's service account doesn't have the permission this needs, or your team's access has ended.
You do not have permission to perform this action.
The record doesn't exist, belongs to another team, or is above the key's classification.
The requested resource was not found.
A record like this already exists. Use it instead of creating another.
The request conflicts with an existing resource.
The request is well formed, but GovDash won't make this change. The message says why, when it can.
The request failed validation.
You sent too many requests. Wait the seconds in the retry-after header, then retry.
This access token exceeded its write rate limit.
Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.
An unexpected error occurred.
GovDash is briefly unavailable and didn't run the request. Retry after retry-after.
The service is temporarily unavailable. Try again later.