post https://api.apptoto.com/v1/contacts
Create contacts in Apptoto.
The POST request body should look like the following:
{
"contacts": [
CONTACTS TO CREATE
]
}
Each Contact should have the following properties
| Field | Type | Description |
|---|---|---|
| address_book | String (Required unless address_book_id specified) | The name of the address book to add the contact to. If the address book doesn't exist then a new one will be provisioned. |
| address_book_id | Integer (Required unless address_book specified) | The id of the address book. |
| name | String (Required) | The full name of the contact. E.g. Fred Smith NOTE: you can provide either "name" or you can provide "first_name" and "last_name". "name" will take precedence. |
| first_name | String (Required) | The first name of the contact. E.g. Fred |
| last_name | String (Required) | The last name of the contact. E.g. Fred |
| phone | String | A phone number for the contact . E.g. 650-555-1212. If the contact has multiple phone numbers then pass the phone_numbers array instead. |
| String | An email address for the contact. E.g. [email protected] . If the contact has multiple email addresses then pass the email_address array instead. | |
| phone_numbers | Array | An array of phone numbers to add to the contact. See below for phone number fields |
| email_addresses | Array | An array of email addresses to add to the contact. See below for the email address fields. |
| external_id | String | An optional unique identifier (should be unique across all calendars in user's account). Can be used to fetch updates and update events. |
Each Phone number object should include the following properties
| Field | Type | Description |
|---|---|---|
| number | String | The number of the contact. E.g. 650-555-1212 |
| is_mobile | Boolean | Sets the phone type as "mobile" for the address book specified. |
| type | String | The type of the phone number to be added. Each address book type has a different set of phone types. List of phone types can be fetched from the /v1/address_books endpoint. |
| is_primary | Boolean | True if this should be the primary phone number to use when sending email to this contact. |
Each email address object should include the following properties
| Field | Type | Description |
|---|---|---|
| address | String | The email address of the contact. E.g. [email protected] |
| type | String | The type of email address. Each address book type has a different set of phone types. List of email address types can be fetched from the /v1/address_books endpoint. |
| is_primary | Boolean | True if this should be the primary email address to use when sending email to this contact. |
Example Result:
{
contacts: [ CONTACTS CREATED ]
}