EmailGuard

API reference

Download spec
patch

Update team

Updates mutable team profile fields (name, emoji, URL, email). Send only the fields you want to change; omitted fields are left unchanged except `name`, which is required on every request.

Required API key scope
account:update
/api/v1/team

Code samples

curl --request PATCH \
  --url https://api.emailguard.co/api/v1/team \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Parameters

Request body

Team profile fields to update

emailstring

Contact email address for the team workspace.

emojistring

Single grapheme emoji shown as the team avatar in the product UI.

namestringrequired

Human-readable team name.

urlstring

Public website URL for the team.

Responses

200
OK
OK
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

emailstring

Contact email for the workspace.

emojistring

Avatar emoji.

idstring

Team UUID.

namestring

Display name.

typestring

Team kind (for example team or personal).

urlstring

Public website URL.

messagestring

Human-readable detail when the code is not OK.

400
Bad Request
Bad Request
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

401
Unauthorized
Unauthorized
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

403
Forbidden
Forbidden
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.