Skip to main content
POST
/
email_addresses
/
{id}
Update an email address
curl --request POST \
  --url https://api.pocketflows.com/email_addresses/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "reply_to": "<string>",
  "username": "<string>"
}
'
{
  "id": "<string>",
  "email_address": "<string>",
  "display_name": "<string>",
  "reply_to": "<string>",
  "business": "<string>",
  "one_off": true,
  "custom_domain": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the email address

Body

application/json
​
display_name
string

The display name of the email address

​
reply_to
string | null

The reply-to address of the email address

​
username
string

The username of the email address - the part that comes before the @

Response

200 - application/json

The updated EmailAddress object

​
id
string
required

The ID of the email address

​
email_address
string
required

The email address

​
display_name
string
required

The display name of the email address

​
reply_to
string | null
required

The reply-to address

​
business
string | null
required

The business associated with this email address

​
one_off
boolean
required

Whether the email address is one-off

​
custom_domain
string | null
required

The custom domain associated with this email address