Set or clear the team notification address

PUT

/api/v1/notification-email

curl --request PUT \
  --url https://api.deploybase.eu/api/v1/api/v1/notification-email \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example" }'

Requests a new team notification address, or clears it with null or “”. An address equal to a confirmed member’s own address in this team is in force at once (verified). Any other address becomes pending and is sent one confirmation email; the current address keeps receiving mail until it is confirmed. Every owner and the previous address are told. Caps: 5 changes and 3 confirmation emails per team per day; the per-address cap across teams is silent. Admin only, and the caller’s own email must be confirmed.

Authorizations

• BearerAuth

Request Body

The new address, or null to clear

Media type application/json

object

email

string

Example ^generated

{
  "email": "example"
}

Responses

200

OK

Media type application/json

object

status

Status is verified (in force now: the address is a confirmed member’s own), pending (a confirmation was mailed to it) or none (cleared).

string

Example ^generated

{
  "status": "example"
}

400

INVALID_EMAIL or ADDRESS_NOT_ALLOWED

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

RESOURCE_NOT_FOUND: the team does not exist

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

429

RATE_LIMIT_EXCEEDED

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

500

INTERNAL_ERROR

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

A required check is unavailable

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}