Create Email

Create email

curl --request POST \
  --url https://api.wellapp.ai/v1/emails \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": {
    "value": "[email protected]",
    "is_primary": true,
    "label": "work"
  },
  "relationships": {
    "persons": {
      "data": [
        {
          "type": "people",
          "id": "people1"
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "company",
          "id": "company_tenant"
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "workspace",
          "external_workspace_id": "fygr_123"
        },
        {
          "type": "workspace",
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ]
    }
  }
}
'

{
  "data": {
    "type": "email",
    "id": "email1-uuid",
    "attributes": {
      "value": "[email protected]",
      "is_primary": true,
      "is_verified": true,
      "label": "work",
      "created_at": "2023-06-15T10:30:00Z",
      "updated_at": "2023-06-15T10:30:00Z"
    },
    "relationships": {
      "persons": {
        "data": [
          {
            "type": "people",
            "id": "person1-uuid"
          }
        ]
      },
      "companies": {
        "data": [
          {
            "type": "company",
            "id": "company1-uuid"
          }
        ]
      },
      "workspaces": {
        "data": [
          {
            "type": "workspace",
            "id": "workspace1-uuid"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "people",
      "id": "person1-uuid",
      "attributes": {
        "first_name": "Sarah",
        "last_name": "Wilson",
        "full_name": "Sarah Wilson",
        "created_at": "2023-06-15T09:00:00Z",
        "updated_at": "2023-06-15T09:00:00Z"
      }
    },
    {
      "type": "company",
      "id": "company1-uuid",
      "attributes": {
        "name": "TechCorp Solutions",
        "description": "Leading technology company",
        "domain_name_primary_link_url": "techcorp.com",
        "locale": "en",
        "created_at": "2023-06-01T08:00:00Z",
        "updated_at": "2023-06-01T08:00:00Z"
      }
    },
    {
      "type": "workspace",
      "id": "workspace1-uuid",
      "attributes": {
        "name": "Sales Team",
        "description": "Sales team workspace",
        "avatar_color": "#FF5733",
        "auto_extract_enabled": true,
        "created_at": "2023-06-01T08:00:00Z",
        "updated_at": "2023-06-01T08:00:00Z"
      }
    }
  ]
}

POST

emails

Create email

curl --request POST \
  --url https://api.wellapp.ai/v1/emails \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": {
    "value": "[email protected]",
    "is_primary": true,
    "label": "work"
  },
  "relationships": {
    "persons": {
      "data": [
        {
          "type": "people",
          "id": "people1"
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "company",
          "id": "company_tenant"
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "workspace",
          "external_workspace_id": "fygr_123"
        },
        {
          "type": "workspace",
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ]
    }
  }
}
'

{
  "data": {
    "type": "email",
    "id": "email1-uuid",
    "attributes": {
      "value": "[email protected]",
      "is_primary": true,
      "is_verified": true,
      "label": "work",
      "created_at": "2023-06-15T10:30:00Z",
      "updated_at": "2023-06-15T10:30:00Z"
    },
    "relationships": {
      "persons": {
        "data": [
          {
            "type": "people",
            "id": "person1-uuid"
          }
        ]
      },
      "companies": {
        "data": [
          {
            "type": "company",
            "id": "company1-uuid"
          }
        ]
      },
      "workspaces": {
        "data": [
          {
            "type": "workspace",
            "id": "workspace1-uuid"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "people",
      "id": "person1-uuid",
      "attributes": {
        "first_name": "Sarah",
        "last_name": "Wilson",
        "full_name": "Sarah Wilson",
        "created_at": "2023-06-15T09:00:00Z",
        "updated_at": "2023-06-15T09:00:00Z"
      }
    },
    {
      "type": "company",
      "id": "company1-uuid",
      "attributes": {
        "name": "TechCorp Solutions",
        "description": "Leading technology company",
        "domain_name_primary_link_url": "techcorp.com",
        "locale": "en",
        "created_at": "2023-06-01T08:00:00Z",
        "updated_at": "2023-06-01T08:00:00Z"
      }
    },
    {
      "type": "workspace",
      "id": "workspace1-uuid",
      "attributes": {
        "name": "Sales Team",
        "description": "Sales team workspace",
        "avatar_color": "#FF5733",
        "auto_extract_enabled": true,
        "created_at": "2023-06-01T08:00:00Z",
        "updated_at": "2023-06-01T08:00:00Z"
      }
    }
  ]
}

Headers

Authorization

string

required

Bearer token for authentication

Body

application/json

attributes

object

required

Show child attributes

attributes.value

string<email>

Email address value

Example:

"[email protected]"

attributes.is_primary

boolean

default:true

Whether this is the primary email address. Defaults to 'false', unless no other email is marked as primary (in which case it becomes 'true'). Only one email can be marked as primary per person/company.

Example:

true

attributes.label

enum<string>

default:work

Email label type. See all available labels for complete list.

Available options:

work,

personal,

other,

...

Example:

"work"

attributes.created_at

string<date-time>

Timestamp when the email was created

Example:

"2023-06-15T10:30:00Z"

attributes.updated_at

string<date-time>

Timestamp when the email was last updated

Example:

"2023-06-15T10:30:00Z"

relationships

object

required

Show child attributes

relationships.persons

object

Show child attributes

relationships.persons.data

object[]

Show child attributes

relationships.persons.data.type

enum<string>

required

Available options:

people

relationships.persons.data.id

string

required

UUID of an existing people or temp-id that references an people defined in the included array

relationships.companies

object

Show child attributes

relationships.companies.data

object[]

Show child attributes

relationships.companies.data.type

enum<string>

required

Available options:

company

relationships.companies.data.id

string

required

UUID of an existing companies or temp-id that references an companies defined in the included array

relationships.workspaces

object

Show child attributes

relationships.workspaces.data

object[]

Option 1
Option 2

Show child attributes

relationships.workspaces.data.type

enum<string>

required

Available options:

workspace

relationships.workspaces.data.external_workspace_id

string

required

External workspace identifier

Response

Email created successfully

data

object[]

Show child attributes

data.type

string

Allowed value: "email"

data.id

string<uuid>

data.attributes

object

Show child attributes

data.attributes.value

string<email>

Email address value

Example:

"[email protected]"

data.attributes.is_primary

boolean

default:true

Example:

true

data.attributes.label

enum<string>

default:work

Email label type. See all available labels for complete list.

Available options:

work,

personal,

other,

...

Example:

"work"

data.attributes.created_at

string<date-time>

Timestamp when the email was created

Example:

"2023-06-15T10:30:00Z"

data.attributes.updated_at

string<date-time>

Timestamp when the email was last updated

Example:

"2023-06-15T10:30:00Z"

data.relationships

object

Show child attributes

data.relationships.persons

object

Show child attributes

data.relationships.persons.data

object[]

Show child attributes

data.relationships.persons.data.type

enum<string>

Available options:

people

data.relationships.persons.data.id

string<uuid>

UUID of the people

data.relationships.companies

object

Show child attributes

data.relationships.companies.data

object[]

Show child attributes

data.relationships.companies.data.type

enum<string>

Available options:

company

data.relationships.companies.data.id

string<uuid>

UUID of the company

data.relationships.workspaces

object

Show child attributes

data.relationships.workspaces.data

object[]

Option 1
Option 2

Show child attributes

data.relationships.workspaces.data.type

enum<string>

Available options:

workspace

data.relationships.workspaces.data.external_workspace_id

string

External workspace identifier

data.included

object

Show child attributes

data.included.persons

object

Show child attributes

data.included.persons.data

object[]

Show child attributes

data.included.persons.data.type

string

Allowed value: "people"

data.included.persons.data.id

string<uuid>

data.included.persons.data.attributes

object

Person attribute data

Show child attributes

data.included.persons.data.attributes.first_name

string

required

Person's first name

Required string length: 1 - 100

Example:

"Marie"

data.included.persons.data.attributes.last_name

string

required

Person's last name

Required string length: 1 - 100

Example:

"Dubois"

data.included.persons.data.attributes.created_at

string<date-time>

required

Person creation timestamp (UTC)

Example:

"2024-01-15T10:30:00Z"

data.included.persons.data.attributes.full_name

string

Auto-computed full name (first + last)

Example:

"Marie Dubois"

data.included.persons.data.attributes.updated_at

string<date-time> | null

Last modification timestamp (UTC)

Example:

"2024-01-16T14:20:00Z"

data.included.companies

object

Show child attributes

data.included.companies.data

object[]

Show child attributes

data.included.companies.data.type

string

Allowed value: "company"

data.included.companies.data.id

string<uuid>

data.included.companies.data.attributes

object

Show child attributes

data.included.companies.data.attributes.description

string

data.included.companies.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.included.companies.data.attributes.tax_id

object

Show child attributes

data.included.companies.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.companies.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.included.companies.data.attributes.registration

object

Show child attributes

data.included.companies.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.included.companies.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.companies.data.attributes.registration_number

object

Show child attributes

data.included.companies.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.companies.data.attributes.registration_number.value

string

Official company registration number.

data.included.companies.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.companies.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.included.companies.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.companies.data.attributes.created_at

string<date-time>

data.included.companies.data.attributes.updated_at

string<date-time>

data.included.workspaces

object

Show child attributes

data.included.workspaces.data

object[]

Show child attributes

data.included.workspaces.data.type

string

Allowed value: "workspace"

data.included.workspaces.data.id

string<uuid>

data.included.workspaces.data.attributes

object

Show child attributes

data.included.workspaces.data.attributes.name

string

Workspace name

data.included.workspaces.data.attributes.desription

string

Workspace description

data.included.workspaces.data.attributes.external_workspace_id

string<uuid>

external workspace id

data.included.workspaces.data.attributes.avatar_color

string<colors>

Color of the avatar

data.included.workspaces.data.attributes.created_at

string<date-time>

Timestamp when the workspace was created

data.included.workspaces.data.attributes.updated_at

string<date-time>

Timestamp when the workspace was last updated

Delete Transaction Get Emails

⌘I

Main Resources

Atomic Resources

System

Headers

Body

Response