Skip to content

Update an email recipient

PUT
/api/v1/email/recipients/{id}
curl --request PUT \
--url http://127.0.0.1:58259/api/v1/email/recipients/1 \
--header 'Content-Type: application/json' \
--data '{ "email": "hello@example.com", "name": "example", "defaultRecipient": true }'

Update an existing email recipient configuration.

id
required
integer format: int64

ID of the email recipient

Media type application/json

Email recipient creation request

object
email
required
string format: email
0 <= 255 characters
name
required
string
0 <= 100 characters
defaultRecipient
boolean
Example generated
{
"email": "hello@example.com",
"name": "example",
"defaultRecipient": true
}

Email recipient updated successfully

Media type */*
object
id
integer format: int64
userId
integer format: int64
email
string
name
string
defaultRecipient
boolean