API Reference
  1. Contacts

Create a contact

post
https://api.emaktalk.com/api/v1/contacts

Creates a contact in your account's contact book. The owner, account and source are taken from your API key and cannot be set from the body. The write is not atomic: the contact is stored first and its phones, emails and addresses afterwards, so a failed child write answers 400 with the contact (and any children that did succeed) already created. Note that success is 200, not 201.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Company name; sanitized and truncated to its maximum length.

string | null

Given name; sanitized and truncated to its maximum length.

string | null

Family name; sanitized and truncated to its maximum length.

string | null

Name shown in the interface, stored as the contact's nickname; sanitized and truncated.

string | null

Free-text note; sanitized and truncated to its maximum length.

string

private makes the contact visible only to its owner; any other value, including omitting it, makes it visible to the whole account.

boolean

Marks the contact as a favorite; only a literal true turns it on, and it defaults to false.

boolean

Publishes the contact to desk phone directories; defaults to true, and only a literal false turns it off.

string

Array of {phone_number, type, is_primary}; entries with no phone_number are skipped, type (work, home, mobile, main, fax, other) sets the voice/fax/video/SMS capabilities and anything unrecognized counts as voice, and numbers are normalized to E.164 where possible.

string

Array of {email_address, type, is_primary}; entries with no email_address are skipped.

string

Array of {type, street, address_extended, city, region, postal_code, country}; every field is sanitized and truncated, and an entry with no street, city, region, postal code or country is skipped.

Responses

401

Missing or invalid API key.

Updated about 6 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

Did this page help you?