Contacts

Create contact

Create a new contact. You can provide either vCard content directly or individual contact fields that will be converted to vCard format. If a contact with the same ID already exists, a conflict error will be returned.

post/v1/contacts

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/contacts
  • Auth: HTTP basic

Request body

contentstring

vCard content (if not provided, will be generated from other fields)

full_namestring

Contact's full name

contact_idstring

Custom contact ID (if not provided, will be auto-generated)

uidstring

Contact UID (if not provided, will be auto-generated)

is_groupboolean

Whether contact is a group

Response

Contact created successfully

idstring required

Contact ID (contact_id from CardDAV)

uidstring required

Contact UID

full_namestring required

Contact's full name

contentstring required

vCard content

etagstring required

ETag for versioning

is_groupboolean required

Whether contact is a group

created_atstring date-time required
updated_atstring date-time required
object'contact' required

Example response

{
  "id": "contact123",
  "uid": "uid123",
  "full_name": "John Doe",
  "content": "BEGIN:VCARD\\nVERSION:3.0\\nUID:uid123\\nFN:John Doe\\nEMAIL;TYPE=INTERNET:john@example.com\\nEND:VCARD",
  "etag": "etag123",
  "is_group": false,
  "emails": [
    {
      "value": "john@example.com",
      "type": "INTERNET"
    }
  ],
  "phone_numbers": [
    {
      "value": "+1234567890",
      "type": "CELL"
    }
  ],
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "object": "contact"
}

Changes

No recorded changes to this operation across all 1 revision of this API.