{"_id":"60e88624ee1a040165025faa","metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Apptoto API Intro","type":"basic","slug":"introduction","excerpt":"","body":"[block:html]\n{\n  \"html\": \"<h3>Welcome to Apptoto's API V1.</h3>\\n\\n<p>V1 of our API allows you to</p>\\n<ol>\\n  <li>Create/manage events on calendars in Apptoto.</li>\\n  <li>Create/manage contacts in address books in Apptoto.</li>\\n  <li>Manage \\\"opt-in\\\" and \\\"opt-out\\\" lists for messaging in Apptoto.</li>\\n  <li>Routinely upload CSV, XML, or ICS Imports to Apptoto.</li>\\n</ol>\\n\\n<p>Currently only \\\"Basic Authentication\\\" is supported, and a user's account already needs to be created and configured through the Apptoto web portal.</p>\\n\\n<p>All endpoints are HTTPS / JSON based.</p>\"\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-07-09T17:23:48.516Z","user":"55d648e9e60a2f0d00b88eb1","category":"562ec3158dee740d008a4326","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":0,"parentDoc":null,"childrenPages":[]}

{"_id":"562ec352265abb0d00342dc1","updates":[],"githubsync":"","project":"55d6491e114e3e0d00462a8b","slug":"basic-authentication","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","auth":"required","params":[],"url":""},"category":"562ec3158dee740d008a4326","createdAt":"2015-10-27T00:20:34.824Z","order":1,"sync_unique":"","type":"basic","user":"55d648e9e60a2f0d00b88eb1","version":"55d6491e114e3e0d00462a8e","body":"Apptoto's APIs currently only support HTTP Basic Authentication.\n\nEach request to our API should include an \"Authorization\" header that contains the word Basic followed by a space and a base64-encoded string username:password .\n\nFor example:\n\nAuthorization: Basic EGVtbzpwQDU2dzByZB==\n\nThe password provided can be either the user's password or the \"API Key\" listed on the \"Settings\" > \"Integrations\" > \"API\" tab in the Apptoto web portal.","excerpt":"","link_url":"","title":"Basic Authentication","__v":1,"hidden":false,"link_external":false,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

{"_id":"60e8872b5f563d0054652942","metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"next":{"description":"","pages":[]},"title":"Rate Limiting","type":"basic","slug":"rate-limiting","excerpt":"","body":"Each user has two rate limits.  A \"Burst\" rate limit and a \"Daily\" rate limit.\n\nDefault Burst Rate Limit:  100 requests per minute\nDefault Daily Rate Limit:  20000 requests per day\n\nIf the number of API calls exceeds either of those rate limits, a **429 Error Code** will be returned.","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-07-09T17:28:11.346Z","user":"55d648e9e60a2f0d00b88eb1","category":"562ec3158dee740d008a4326","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":0,"parentDoc":null,"childrenPages":[]}

{"_id":"562ebd5e2e4a000d00dc6a23","category":"562ebd338dee740d008a431f","createdAt":"2015-10-26T23:55:10.019Z","user":"55d648e9e60a2f0d00b88eb1","api":{"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v1/userinfo","auth":"required"},"link_external":false,"link_url":"","project":"55d6491e114e3e0d00462a8b","version":"55d6491e114e3e0d00462a8e","__v":0,"hidden":false,"sync_unique":"","updates":[],"body":"","excerpt":"This endpoint can be used to fetch additional information about the user.","githubsync":"","order":0,"slug":"v1userinfo","title":"/v1/userinfo","type":"get","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"5f21cb1a92016a08812b0401","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/calendars","auth":"required","settings":"","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"name":"","code":"{\n  calendars: [ {\n    id: 123,\n    name: \"Apptoto Calendar\"\n  }]\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]}},"next":{"description":"","pages":[]},"title":"/v1/calendars","type":"get","slug":"v1calendars-1","excerpt":"Fetch the list of calendars for the current user.","body":"","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-07-29T19:16:42.423Z","user":"55d648e9e60a2f0d00b88eb1","category":"5f21c9e859df2806b5e71ce0","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":0,"parentDoc":null,"childrenPages":[]}

{"_id":"59b1992678361f001058e891","project":"55d6491e114e3e0d00462a8b","version":"55d6491e114e3e0d00462a8e","category":"570f18c03160d10e0041e054","user":"55d648e9e60a2f0d00b88eb1","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-07T19:08:22.578Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  id: 123,\n  calendar_id: 456,\n  start_time: \"2016-04-15T12:00:00-07:00\",\n  end_time: \"2016-04-15T13:00:00-07:00\",\n  title: \"Appointment with Fred\",\n  location: \"\",\n  content: \"\",\n  is_deleted: false,\n  participants: [ {\n    id: 789,\n    name: \"Fred Smith\",\n    phone: \"650-555-1212\",\n    normalized_phone: \"+16505551212\",\n    email: \"[email protected]\",\n    state: \"initial\", \n  }],\n  custom_data: {\n    field_1: \"custom value\"\n  }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"method":"get","examples":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"570fefff79b89419005475cc","ref":"","in":"query","required":true,"desc":"The Apptoto id for the event","default":"","type":"int","name":"id"},{"_id":"570ffc2c8245a40e008052b9","ref":"","in":"query","required":false,"desc":"Your unique external id for the event.  REQUIRED if you do not specify an id","default":"","type":"string","name":"external_id"}],"url":"/v1/event"},"isReference":false,"order":0,"body":"Events contain many participants.  Each participant can have different states. \n\nThe \"state\" property can be\n\n* **initial** \n* **accepted** (participant accepted booking message)\n* **declined**   (participant declined booking message)\n* **reminded**  (reminders have been sent)\n* **confirmed**  (participant confirmed)\n* **not_coming**  (participant cancelled)\n* **not_coming_needs_reschedule**\n* **not_coming_no_reschedule**","excerpt":"Fetch one event using an id.\n\nEither id or external_id param","slug":"v1event","type":"get","title":"/v1/event","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"570fefff79b89419005475cb","sync_unique":"","createdAt":"2016-04-14T19:31:11.961Z","excerpt":"Fetch a range of \"events\".\n\nPlease note that you can also use this API to fetch one event by id or external_id (for legacy reasons).  The new proper way to fetch one event is to use the /v1/event (singular) API.","githubsync":"","link_external":false,"title":"/v1/events","user":"55d648e9e60a2f0d00b88eb1","project":"55d6491e114e3e0d00462a8b","version":"55d6491e114e3e0d00462a8e","__v":7,"category":"570f18c03160d10e0041e054","editedParams":true,"hidden":false,"link_url":"","next":{"pages":[],"description":""},"order":1,"slug":"v1events","api":{"settings":"","url":"/v1/events","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"begin","type":"datetime","default":"","desc":"Only events starting at or after this date/time will be included.  (ISO8601)","required":false,"in":"query","ref":"","_id":"570fefff79b89419005475cc"},{"name":"end","type":"datetime","default":"","desc":"Only events starting at or before this Date/Time will be included. (ISO8601)","required":false,"in":"query","ref":"","_id":"570ffc2c8245a40e008052b9"},{"name":"phone_number","type":"string","default":"","desc":"Only events who have a participant with the given phone number will be included. The phone number will be normalized based on the Apptoto user's default country setting.  If the phone number you are filtering on is in a different country then include the fully normalized phone number (e.g. +66234234234).","required":false,"in":"query","ref":"","_id":"59b19c2c2666a90026c0f717"},{"name":"email_address","type":"string","default":"","desc":"Only events who have a participant with the specified email address will be incluced","required":false,"in":"query","ref":"","_id":"59b19c2c2666a90026c0f716"},{"name":"page_size","type":"int","default":"30","desc":"The number of events to return","required":false,"in":"query","ref":"","_id":"59b19c2c2666a90026c0f715"},{"name":"page","type":"int","default":"1","desc":"The page to fetch (1 based)","required":false,"in":"query","ref":"","_id":"59b19cc42666a90026c0f81d"},{"name":"include_deleted","type":"boolean","default":"false","desc":"Include deleted events","required":false,"in":"query","ref":"","_id":"6143714f25c32801cccea441"},{"name":"include_conversations","type":"boolean","default":"false","desc":"If true, then Apptoto will include any conversations sent about the event.  The conversations will be an array on each participant with the key \"conversations\".","required":false,"in":"query","ref":"","_id":"61539e2874e8d200624b44ea"}],"results":{"codes":[{"name":"","code":"{\n  events: [ {\n    id: 123,\n    calendar_id: 456,\n    start_time: \"2016-04-15T12:00:00-07:00\",\n    end_time: \"2016-04-15T13:00:00-07:00\",\n    title: \"Appointment with Fred\",\n    location: \"\",\n    content: \"\",\n    is_deleted: false,\n    participants: [ {\n      id: 789,\n      name: \"Fred Smith\",\n      phone: \"650-555-1212\",\n      normalized_phone: \"+16505551212\",\n      email: \"[email protected]\",\n      state: \"initial\", \n    }],\n    custom_data: {\n      field_1: \"custom value\"\n    }\n  }]\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]}},"body":"If you do not specify a phone_number or email_address... then events will not be duplicated, an each event will contain all of it's participants.\n\nHowever, if you specify a phone_number or email_address... then events may be listed more than once, and each event entry returned will only have the matching participant in the participants array included.","editedParams2":true,"isReference":false,"type":"get","updates":[],"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"570ff31351449a0e0013286b","excerpt":"Create events in Apptoto.  Apptoto's auto messages will be sent for the events created if Auto Messages are turned on.  Otherwise, be sure to include #auto in the event information in order to tell Apptoto to send the Auto Messages configured for the account.","hidden":false,"isReference":false,"next":{"description":"","pages":[]},"slug":"v1events-1","user":"55d648e9e60a2f0d00b88eb1","body":"Event objects should have the following properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"calendar\",\n    \"0-2\": \"The name of the calendar to add the event to.  \\n\\nIf the calendar doesn't exist then a new one will be provisioned.\",\n    \"0-1\": \"String \\n(Required unless calendar_id specified)\",\n    \"1-0\": \"calendar_id\",\n    \"1-1\": \"Integer\\n(Required unless calendar specified)\",\n    \"1-2\": \"The id of the calendar\",\n    \"2-0\": \"title\",\n    \"2-1\": \"String\\n(Required)\",\n    \"2-2\": \"The title of the event\",\n    \"3-0\": \"start_time\",\n    \"3-1\": \"String \\n(Required)\",\n    \"3-2\": \"The start time of the event in ISO 8601 combined date and time format including timezone offset.  e.g. 2016-06-21T14:00:00-08:00\",\n    \"4-0\": \"end_time\",\n    \"4-1\": \"String\\n(Required)\",\n    \"4-2\": \"The end time of the event in ISO 8601 combined date and time format. e.g. 2016-06-21T15:00:00-08:00\",\n    \"6-0\": \"location\",\n    \"6-1\": \"String\",\n    \"6-2\": \"The location of the event\",\n    \"7-0\": \"content\",\n    \"7-1\": \"String\",\n    \"7-2\": \"The content / body of the vent\",\n    \"8-0\": \"all_day\",\n    \"8-1\": \"Boolean\\nDefault: false\",\n    \"8-2\": \"Specifies that event should be treated as an all day event\",\n    \"9-0\": \"show_as\",\n    \"9-1\": \"Integer\\nDefault: null\",\n    \"9-2\": \"null: \\\"Busy\\\"\\n0: \\\"Free\\\"\\n1: \\\"Tentative\\\"\\n2: \\\"Busy\\\"\\n3: \\\"Out of Office\\\"\\n4: \\\"Working Elsewhere\\\"\",\n    \"10-0\": \"external_id\",\n    \"10-1\": \"String\",\n    \"10-2\": \"An optional unique identifier (should be unique across all calendars in user's account).  Can be used to fetch updates and update events.\",\n    \"11-0\": \"custom_data\",\n    \"11-1\": \"JSON Hash\",\n    \"11-2\": \"A hash of custom data to be attached to the event.  Custom data can be used in Apptoto conditions and message templates.\",\n    \"12-0\": \"participants\",\n    \"12-1\": \"Array\",\n    \"12-2\": \"Array of participants to be added.\\n\\nThis is optional.  Apptoto can extract participants from the title/location/content for you.  But if you want to explicitly include participants you can include them in this Array.\",\n    \"5-0\": \"time_zone\",\n    \"5-1\": \"String\",\n    \"5-2\": \"The time zone the event is in.  This will influence what time will be used in messages sent as long as the \\\"Use time zone specified for event\\\" option is enabled for the account (which it is by default).\\n\\n[See this page for timezones supported.](https://apptoto.readme.io/docs/time-zones-supported)\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]\nEach Participant object should include the following properties\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The name of the participant\",\n    \"1-0\": \"email\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The SMTP email address of the participant\",\n    \"2-0\": \"phone\",\n    \"2-1\": \"String\",\n    \"2-2\": \"The phone of the participant.  This phone number will be normalized based on the user's country setting.  Alternatively you can include the full normalized phone number (e.g. +441212121212) and Apptoto will then skip normalization.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","createdAt":"2016-04-14T19:44:19.392Z","link_url":"","type":"post","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"default":"","type":"array_object","name":"events","_id":"570ff722711e960e00f24698","ref":"","in":"body","required":true,"desc":"Array of events to add"},{"default":"false","type":"boolean","name":"prevent_calendar_creation","_id":"58f699f51a620c0f0014d2e8","ref":"","in":"body","required":false,"desc":"Apptoto will create new calendars for you if you reference a calendar in the events array that does not exist.  Set this parameter to true to prevent this from happening."}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n  events: [ EVENTS CREATED ]\n}"}]},"settings":"","url":"/v1/events"},"category":"570f18c03160d10e0041e054","editedParams2":true,"link_external":false,"project":"55d6491e114e3e0d00462a8b","sync_unique":"","title":"/v1/events","__v":3,"editedParams":true,"githubsync":"","order":2,"updates":[],"version":"55d6491e114e3e0d00462a8e","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"586bdd8328ef3c39009b044a","isReference":false,"link_external":false,"next":{"pages":[],"description":""},"project":"55d6491e114e3e0d00462a8b","title":"/v1/events","type":"delete","updates":[],"__v":0,"user":"55d648e9e60a2f0d00b88eb1","api":{"params":[{"type":"int","name":"id","_id":"570fefff79b89419005475cc","ref":"","in":"query","required":true,"desc":"The Apptoto id for the event","default":""},{"desc":"Your unique external id for the event.  REQUIRED if you do not specify an id","default":"","type":"string","name":"external_id","_id":"570ffc2c8245a40e008052b9","ref":"","in":"query","required":false}],"results":{"codes":[{"name":"","code":"{\n  events: [ {\n    id: 123,\n    calendar_id: 456,\n    start_time: \"2016-04-15T12:00:00-07:00\",\n    end_time: \"2016-04-15T13:00:00-07:00\",\n    title: \"Appointment with Fred\",\n    location: \"\",\n    content: \"\",\n    is_deleted: true,\n    participants: [ {\n      id: 789,\n      name: \"Fred Smith\",\n      phone: \"650-555-1212\",\n      normalized_phone: \"+16505551212\",\n      email: \"[email protected]\",\n      state: \"initial\", \n    }],\n    custom_data: {\n      field_1: \"custom value\"\n    }\n  }]\n}","language":"json","status":200},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","url":"/v1/events","auth":"required","examples":{"codes":[]},"method":"delete"},"body":"Events contain many participants.  Each participant can have different states. \n\nThe \"state\" property can be\n\n* **initial** \n* **accepted** (participant accepted booking message)\n* **declined**   (participant declined booking message)\n* **reminded**  (reminders have been sent)\n* **confirmed**  (participant confirmed)\n* **not_coming**  (participant cancelled)\n* **not_coming_needs_reschedule**\n* **not_coming_no_reschedule**","excerpt":"Deletes one event using an id.  Either id or external_id param. \n\nThis halts any messages being sent on behalf of the event and removes it from the UI in the Apptoto system.","githubsync":"","hidden":false,"order":3,"link_url":"","slug":"v1events-2","sync_unique":"","version":"55d6491e114e3e0d00462a8e","createdAt":"2017-01-03T17:21:07.403Z","category":"570f18c03160d10e0041e054","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"588115159e24c01900508c63","api":{"settings":"","url":"/v1/events","auth":"required","examples":{"codes":[]},"method":"put","params":[{"required":true,"desc":"Array of events to add","default":"","type":"array_object","name":"events","_id":"570ff722711e960e00f24698","ref":"","in":"body"},{"ref":"","in":"body","required":false,"desc":"Apptoto will create new calendars for you if you reference a calendar in the events array that does not exist.  Set this parameter to true to prevent this from happening.","default":"false","type":"boolean","name":"prevent_calendar_creation","_id":"58f699e58610e70f0080e75d"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n  events: [ EVENTS CREATED OR UPDATED ]\n}"}]}},"excerpt":"Create or update events in Apptoto.  Apptoto's auto messages will be sent for the events created if Auto Messages are turned on.  Otherwise, be sure to include #auto in the event information in order to tell Apptoto to send the Auto Messages configured for the account.\n\nTo update existing events, be sure to provide either an external_id or id, otherwise a new event will be created.  For the event properties, this API acts like a patch... meaning that only the events fields you specify will be updated.\n\nHowever, if you provide a value for the \"participants\" or \"custom_data\" field, then provide all of the data.  Meaning, it does not act as a patch for custom_data or individual participants.\n\nPlease note that participants will not be removed from an event if messages have already started going out to that participant.  This \"feature\" can be turned off, so ask [email protected] if you need it turned off.\n\nAlso, please note that we do not support moving an appointment from one calendar to another at this time.  If you need this, please contact [email protected] .","order":4,"user":"55d648e9e60a2f0d00b88eb1","__v":1,"project":"55d6491e114e3e0d00462a8b","sync_unique":"","version":"55d6491e114e3e0d00462a8e","body":"Event objects should have the following properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"calendar\",\n    \"0-2\": \"The name of the calendar to add the event to.  \\n\\nIf the calendar doesn't exist then a new one will be provisioned.\",\n    \"0-1\": \"String \\n(Required unless calendar_id specified)\",\n    \"1-0\": \"calendar_id\",\n    \"1-1\": \"Integer\\n(Required unless calendar specified)\",\n    \"1-2\": \"The id of the calendar\",\n    \"2-0\": \"title\",\n    \"2-1\": \"String\\n(Required if new event)\",\n    \"2-2\": \"The title of the event\",\n    \"3-0\": \"start_time\",\n    \"3-1\": \"String\\n(Required if new event)\",\n    \"3-2\": \"The start time of the event in ISO 8601 combined date and time format including timezone offset.  e.g. 2016-06-21T14:00:00-08:00\",\n    \"4-0\": \"end_time\",\n    \"4-1\": \"String \\n(Required if new event)\",\n    \"4-2\": \"The end time of the event in ISO 8601 combined date and time format including timezone offset.  e.g. 2016-06-21T14:00:00-08:00\",\n    \"6-0\": \"location\",\n    \"6-1\": \"String\",\n    \"6-2\": \"The location of the event\",\n    \"7-0\": \"content\",\n    \"7-1\": \"String\",\n    \"7-2\": \"The content / body of the vent\",\n    \"8-0\": \"all_day\",\n    \"8-1\": \"Boolean\\nDefault: false\",\n    \"8-2\": \"Specifies that event should be treated as an all day event\",\n    \"9-0\": \"show_as\",\n    \"9-1\": \"Integer\\nDefault: null\",\n    \"9-2\": \"null: \\\"Busy\\\"\\n0: \\\"Free\\\"\\n1: \\\"Tentative\\\"\\n2: \\\"Busy\\\"\\n3: \\\"Out of Office\\\"\\n4: \\\"Working Elsewhere\\\"\",\n    \"10-0\": \"external_id\",\n    \"10-1\": \"String\",\n    \"10-2\": \"An optional unique identifier (should be unique across all calendars in user's account).  Can be used to fetch updates and update events.\",\n    \"12-0\": \"custom_data\",\n    \"12-1\": \"JSON Hash\",\n    \"12-2\": \"A hash of custom data to be attached to the event.  Custom data can be used in Apptoto conditions and message templates.\",\n    \"13-0\": \"participants\",\n    \"13-1\": \"Array\",\n    \"13-2\": \"Array of participants to be added.\\n\\nThis is optional.  Apptoto can extract participants from the title/location/content for you.  But if you want to explicitly include participants you can include them in this Array.\",\n    \"11-0\": \"id\",\n    \"11-1\": \"integer\",\n    \"11-2\": \"The event's Apptoto id if you are doing updates.  Either the external_id or id field needs to exist for an update to take place.\",\n    \"5-0\": \"time_zone\",\n    \"5-1\": \"String\",\n    \"5-2\": \"The time zone the event is in.  This will influence what time will be used in messages sent as long as the \\\"Use time zone specified for event\\\" option is enabled for the account (which it is by default).\\n\\n[See this page for timezones supported.](https://apptoto.readme.io/docs/time-zones-supported)\"\n  },\n  \"cols\": 3,\n  \"rows\": 14\n}\n[/block]\nEach Participant object should include the following properties\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The name of the participant\",\n    \"1-0\": \"email\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The SMTP email address of the participant\",\n    \"2-0\": \"phone\",\n    \"2-1\": \"String\",\n    \"2-2\": \"The phone of the participant.  This phone number will be normalized based on the user's country setting.  Alternatively you can include the full normalized phone number (e.g. +441212121212) and Apptoto will then skip normalization.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","category":"570f18c03160d10e0041e054","hidden":false,"link_external":false,"updates":[],"title":"/v1/events","type":"put","createdAt":"2017-01-19T19:35:49.409Z","githubsync":"","isReference":false,"link_url":"","next":{"description":"","pages":[]},"slug":"v1events-3","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"5faed98b729d8500501b30ab","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/event/mark","auth":"required","results":{"codes":[{"name":"","code":"{\n  id: 123,\n  calendar_id: 456,\n  start_time: \"2016-04-15T12:00:00-07:00\",\n  end_time: \"2016-04-15T13:00:00-07:00\",\n  title: \"Appointment with Fred\",\n  location: \"\",\n  content: \"\",\n  is_deleted: false,\n  participants: [ {\n    id: 789,\n    name: \"Fred Smith\",\n    phone: \"650-555-1212\",\n    normalized_phone: \"+16505551212\",\n    email: \"[email protected]\",\n    state: \"initial\", \n  }],\n  custom_data: {\n    field_1: \"custom value\"\n  }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"method":"post","examples":{"codes":[]},"settings":"","params":[{"name":"id","type":"string","default":"","desc":"The Apptoto id for the vent","required":true,"in":"body","ref":"","_id":"5faed98b729d8500501b30ae"},{"name":"external_id","type":"string","default":"","desc":"Your unique external id for the event.  REQUIRED if you do not specify an id","required":false,"in":"body","ref":"","_id":"5faed98b729d8500501b30ad"},{"name":"state","type":"string","default":"","desc":"The state to set the participants to","required":false,"in":"body","ref":"","_id":"5faed98b729d8500501b30ac"}]},"next":{"description":"","pages":[]},"title":"/v1/event/mark","type":"post","slug":"v1eventmark","excerpt":"Mark all the participants on one event as confirmed, cancelled, etc.","body":"The \"state\" property can be\n\nBooking States:\n* **accepted** (participant accepted booking message)\n* **declined**   (participant declined booking message)\n\nConfirmation States:\n* **confirmed**  (participant confirmed)\n* **cancelled**  (participant cancelled)\n* **not_coming**  (participant cancelled)\n* **needs_reschedule** (participant cancelled and requested a reschedule)\n\nCheck In States:\n* **noshow** (participant was a noshow)\n* **arrived** (participant arrived)\n* **ontime** (participant arrived ontime)\n* **late** (participant arrived late)","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-11-13T19:07:55.398Z","user":"55d648e9e60a2f0d00b88eb1","category":"570f18c03160d10e0041e054","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":5,"parentDoc":null,"childrenPages":[]}

{"_id":"5882b4e0a1c53d0f008c53fe","type":"basic","hidden":false,"api":{"params":[],"url":"","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required"},"order":6,"excerpt":"","project":"55d6491e114e3e0d00462a8b","updates":[],"link_url":"","sync_unique":"","slug":"time-zones-supported","title":"Time Zones Supported","__v":0,"body":"The time zone abbreviations we support include:\n\nAbbreviation\tTimezone Nickname\nPT\tPacific Time (US & Canada)\nPST\tPacific Time (US & Canada)\nPDT\tPacific Time (US & Canada)\nMT\tMountain Time (US & Canada)\nMDT\tMountain Time (US & Canada)\nMST\tMountain Time (US & Canada)\nCT\tCentral Time (US & Canada)\nCDT\tCentral Time (US & Canada)\nCST\tCentral Time (US & Canada)\nET\tEastern Time (US & Canada)\nEDT\tEastern Time (US & Canada)\nEST\tEastern Time (US & Canada)\nHT\tHawaii\nHDT\tHawaii\nHST\tHawaii\nAZ\tArizona\n\nWe also support any of the following nicknames or official names:\n\nNickname\tOfficial Name\nInternational Date Line West\tPacific/Midway\nMidway Island\tPacific/Midway\nAmerican Samoa\tPacific/Pago_Pago\nHawaii\tPacific/Honolulu\nAlaska\tAmerica/Juneau\nPacific Time (US & Canada)\tAmerica/Los_Angeles\nTijuana\tAmerica/Tijuana\nMountain Time (US & Canada)\tAmerica/Denver\nArizona\tAmerica/Phoenix\nChihuahua\tAmerica/Chihuahua\nMazatlan\tAmerica/Mazatlan\nCentral Time (US & Canada)\tAmerica/Chicago\nSaskatchewan\tAmerica/Regina\nGuadalajara\tAmerica/Mexico_City\nMexico City\tAmerica/Mexico_City\nMonterrey\tAmerica/Monterrey\nCentral America\tAmerica/Guatemala\nEastern Time (US & Canada)\tAmerica/New_York\nIndiana (East)\tAmerica/Indiana/Indianapolis\nBogota\tAmerica/Bogota\nLima\tAmerica/Lima\nQuito\tAmerica/Lima\nAtlantic Time (Canada)\tAmerica/Halifax\nCaracas\tAmerica/Caracas\nLa Paz\tAmerica/La_Paz\nSantiago\tAmerica/Santiago\nNewfoundland\tAmerica/St_Johns\nBrasilia\tAmerica/Sao_Paulo\nBuenos Aires\tAmerica/Argentina/Buenos_Aires\nMontevideo\tAmerica/Montevideo\nGeorgetown\tAmerica/Guyana\nGreenland\tAmerica/Godthab\nMid-Atlantic\tAtlantic/South_Georgia\nAzores\tAtlantic/Azores\nCape Verde Is.\tAtlantic/Cape_Verde\nDublin\tEurope/Dublin\nEdinburgh\tEurope/London\nLisbon\tEurope/Lisbon\nLondon\tEurope/London\nCasablanca\tAfrica/Casablanca\nMonrovia\tAfrica/Monrovia\nUTC\tEtc/UTC\nBelgrade\tEurope/Belgrade\nBratislava\tEurope/Bratislava\nBudapest\tEurope/Budapest\nLjubljana\tEurope/Ljubljana\nPrague\tEurope/Prague\nSarajevo\tEurope/Sarajevo\nSkopje\tEurope/Skopje\nWarsaw\tEurope/Warsaw\nZagreb\tEurope/Zagreb\nBrussels\tEurope/Brussels\nCopenhagen\tEurope/Copenhagen\nMadrid\tEurope/Madrid\nParis\tEurope/Paris\nAmsterdam\tEurope/Amsterdam\nBerlin\tEurope/Berlin\nBern\tEurope/Zurich\nZurich\tEurope/Zurich\nRome\tEurope/Rome\nStockholm\tEurope/Stockholm\nVienna\tEurope/Vienna\nWest Central Africa\tAfrica/Algiers\nBucharest\tEurope/Bucharest\nCairo\tAfrica/Cairo\nHelsinki\tEurope/Helsinki\nKyiv\tEurope/Kiev\nRiga\tEurope/Riga\nSofia\tEurope/Sofia\nTallinn\tEurope/Tallinn\nVilnius\tEurope/Vilnius\nAthens\tEurope/Athens\nIstanbul\tEurope/Istanbul\nMinsk\tEurope/Minsk\nJerusalem\tAsia/Jerusalem\nHarare\tAfrica/Harare\nPretoria\tAfrica/Johannesburg\nKaliningrad\tEurope/Kaliningrad\nMoscow\tEurope/Moscow\nSt. Petersburg\tEurope/Moscow\nVolgograd\tEurope/Volgograd\nSamara\tEurope/Samara\nKuwait\tAsia/Kuwait\nRiyadh\tAsia/Riyadh\nNairobi\tAfrica/Nairobi\nBaghdad\tAsia/Baghdad\nTehran\tAsia/Tehran\nAbu Dhabi\tAsia/Muscat\nMuscat\tAsia/Muscat\nBaku\tAsia/Baku\nTbilisi\tAsia/Tbilisi\nYerevan\tAsia/Yerevan\nKabul\tAsia/Kabul\nEkaterinburg\tAsia/Yekaterinburg\nIslamabad\tAsia/Karachi\nKarachi\tAsia/Karachi\nTashkent\tAsia/Tashkent\nChennai\tAsia/Kolkata\nKolkata\tAsia/Kolkata\nMumbai\tAsia/Kolkata\nNew Delhi\tAsia/Kolkata\nKathmandu\tAsia/Kathmandu\nAstana\tAsia/Dhaka\nDhaka\tAsia/Dhaka\nSri Jayawardenepura\tAsia/Colombo\nAlmaty\tAsia/Almaty\nNovosibirsk\tAsia/Novosibirsk\nRangoon\tAsia/Rangoon\nBangkok\tAsia/Bangkok\nHanoi\tAsia/Bangkok\nJakarta\tAsia/Jakarta\nKrasnoyarsk\tAsia/Krasnoyarsk\nBeijing\tAsia/Shanghai\nChongqing\tAsia/Chongqing\nHong Kong\tAsia/Hong_Kong\nUrumqi\tAsia/Urumqi\nKuala Lumpur\tAsia/Kuala_Lumpur\nSingapore\tAsia/Singapore\nTaipei\tAsia/Taipei\nPerth\tAustralia/Perth\nIrkutsk\tAsia/Irkutsk\nUlaanbaatar\tAsia/Ulaanbaatar\nSeoul\tAsia/Seoul\nOsaka\tAsia/Tokyo\nSapporo\tAsia/Tokyo\nTokyo\tAsia/Tokyo\nYakutsk\tAsia/Yakutsk\nDarwin\tAustralia/Darwin\nAdelaide\tAustralia/Adelaide\nCanberra\tAustralia/Melbourne\nMelbourne\tAustralia/Melbourne\nSydney\tAustralia/Sydney\nBrisbane\tAustralia/Brisbane\nHobart\tAustralia/Hobart\nVladivostok\tAsia/Vladivostok\nGuam\tPacific/Guam\nPort Moresby\tPacific/Port_Moresby\nMagadan\tAsia/Magadan\nSrednekolymsk\tAsia/Srednekolymsk\nSolomon Is.\tPacific/Guadalcanal\nNew Caledonia\tPacific/Noumea\nFiji\tPacific/Fiji\nKamchatka\tAsia/Kamchatka\nMarshall Is.\tPacific/Majuro\nAuckland\tPacific/Auckland\nWellington\tPacific/Auckland\nNuku’alofa\tPacific/Tongatapu\nTokelau Is.\tPacific/Fakaofo\nChatham Is.\tPacific/Chatham\nSamoa\tPacific/Apia","version":"55d6491e114e3e0d00462a8e","category":"570f18c03160d10e0041e054","createdAt":"2017-01-21T01:09:52.575Z","githubsync":"","user":"55d648e9e60a2f0d00b88eb1","next":{"pages":[],"description":""},"link_external":false,"isReference":false,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"604f89598694010292c4d7a2","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/address_books","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  address_books: [ {\n    id: 123,\n    name: \"Apptoto Address Book\",\n    writable: true,\n    email_address_types: [\"home\", \"work\"],\n    phone_number_types: [\"mobile\", \"home\", \"work\"]\n  }]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"/v1/address_books","type":"get","slug":"v1address_books","excerpt":"","body":"Fetch the list of address books in current user's account.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-03-15T16:20:41.737Z","user":"55d648e9e60a2f0d00b88eb1","category":"604f88e843f4e50035f5bc3d","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":0,"parentDoc":null,"childrenPages":[]}

{"_id":"604f8b5453fec00081450026","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/contact","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  id: 1,\n  external_id: \"yourid\",\n  name: \"Fred Smith\",\n  first_name: \"Fred\",\n  last_name: \"Smith\",\n  zip: \"97701\",\n  address_book_id: 123,\n  address_book_name: \"Apptoto Address Book\",\n  writable: true,\n  notes: \"Long string of notes\",\n  deleted: false,\n  phone_numbers: [\n    {\n      id: 3,\n      number: \"650-555-1212\",\n      normalized: \"+16505551212\",\n      type: \"mobile\",\n      is_primary: true\n    }\n  ],\n  email_addresses: [\n    {\n      id: 4,\n      address: \"[email protected]\",\n      type: \"work\"\n    }\n  ],\n  custom_data: {\n    field_1: \"vip\"\n  }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"id","type":"int","default":"","desc":"The Apptoto id for the contact.","required":false,"in":"query","ref":"","_id":"604f8b5453fec00081450027"},{"name":"external_id","type":"string","default":"","desc":"Fetch one contact with the \"external_id\" provided when created through the API.","required":false,"in":"query","ref":"","_id":"604f8b5453fec00081450028"},{"name":"address_book_id","type":"int","default":"","desc":"","required":false,"in":"query","ref":"","_id":"604f8b5453fec00081450029"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"/v1/contact","type":"get","slug":"v1contact","excerpt":"","body":"Fetch one contact by either \"id\"  or \"external_id\".  \n\nOne of the \"id\" or \"external_id\" parameters must be specified.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-03-15T16:29:08.884Z","user":"55d648e9e60a2f0d00b88eb1","category":"604f897e439f4d004adad64b","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":2,"parentDoc":null,"childrenPages":[]}

{"_id":"604f8b9900fc50001260dad1","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/contacts","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  contacts: [\n    {\n      id: 1,\n      external_id: \"yourid\",\n      name: \"Fred Smith\",\n      first_name: \"Fred\",\n      last_name: \"Smith\",\n      zip: \"97701\",\n      address_book_id: 123,\n      address_book_name: \"Apptoto Address Book\",\n      writable: true,\n      notes: \"Long string of notes\",\n      deleted: false,\n      phone_numbers: [\n        {\n          id: 3,\n          number: \"650-555-1212\",\n          normalized: \"+16505551212\",\n          type: \"mobile\",\n          is_primary: true\n        }\n      ],\n      email_addresses: [\n        {\n          id: 4,\n          address: \"[email protected]\",\n          type: \"work\"\n        }\n      ],\n      custom_data: {\n        field_1: \"vip\"\n      }\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"page","type":"int","default":"1","desc":"The page number to fetch (1 based)","required":false,"in":"query","ref":"","_id":"604f8ca4746be50068beba96"},{"name":"page_size","type":"int","default":"30","desc":"The size of the page to fetch.","required":false,"in":"query","ref":"","_id":"604f8ca4746be50068beba97"},{"name":"address_book_id","type":"int","default":"","desc":"(OPTIONAL)","required":false,"in":"query","ref":"","_id":"604f8ca4746be50068beba98"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"/v1/contacts","type":"get","slug":"v1contacts","excerpt":"","body":"Fetch contacts in pages.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-03-15T16:30:17.666Z","user":"55d648e9e60a2f0d00b88eb1","category":"604f897e439f4d004adad64b","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":3,"parentDoc":null,"childrenPages":[]}

{"_id":"604f8e878694010292c4d7a4","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/contacts","auth":"required","examples":{"codes":[]},"method":"post","params":[{"name":"contacts","type":"array_object","default":"","desc":"Array of events to add","required":true,"in":"body","ref":"","_id":"570ff722711e960e00f24698"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n  contacts: [ CONTACTS CREATED ]\n}"}]},"settings":""},"next":{"description":"","pages":[]},"title":"/v1/contacts","type":"post","slug":"v1eventstest","excerpt":"Create events in Apptoto.  Apptoto's auto messages will be sent for the events created if Auto Messages are turned on.  Otherwise, be sure to include #auto in the event information in order to tell Apptoto to send the Auto Messages configured for the account.","body":"Contact objects should have the following properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"address_book\",\n    \"0-2\": \"The name of the address book to add the contact to.  \\n\\nIf the address book doesn't exist then a new one will be provisioned.\",\n    \"0-1\": \"String \\n(Required unless address_book_id specified)\",\n    \"1-0\": \"address_book_id\",\n    \"1-1\": \"Integer\\n(Required unless address_book specified)\",\n    \"1-2\": \"The id of the address book.\",\n    \"2-0\": \"name\",\n    \"2-1\": \"String\\n(Required)\",\n    \"2-2\": \"The full name of the contact.  E.g. Fred Smith\\n\\nNOTE: you can provide either \\\"name\\\" or you can provide \\\"first_name\\\" and \\\"last_name\\\".  \\\"name\\\" will take precedence.\",\n    \"3-0\": \"first_name\",\n    \"3-1\": \"String \\n(Required)\",\n    \"3-2\": \"The first name of the contact.\\nE.g. Fred\",\n    \"4-0\": \"last_name\",\n    \"4-1\": \"String\\n(Required)\",\n    \"4-2\": \"The last name of the contact.\\nE.g. Fred\",\n    \"6-0\": \"email\",\n    \"6-1\": \"String\",\n    \"6-2\": \"An email address for the contact.  E.g. [email protected] .\\n\\nIf the contact has multiple email addresses then pass the email_address array instead.\",\n    \"7-0\": \"phone_numbers\",\n    \"7-1\": \"Array\",\n    \"7-2\": \"An array of phone numbers to add to the contact.  See below for phone number fields\",\n    \"8-0\": \"email_addreses\",\n    \"8-1\": \"Array\",\n    \"8-2\": \"An array of email addresses to add to the contact.  See below for the email address fields.\",\n    \"9-0\": \"external_id\",\n    \"9-1\": \"String\",\n    \"9-2\": \"An optional unique identifier (should be unique across all calendars in user's account).  Can be used to fetch updates and update events.\",\n    \"10-0\": \"external_id\",\n    \"10-1\": \"String\",\n    \"10-2\": \"An optional unique identifier (should be unique across all calendars in user's account).  Can be used to fetch updates and update events.\",\n    \"11-0\": \"participants\",\n    \"11-1\": \"Array\",\n    \"11-2\": \"Array of participants to be added.\\n\\nThis is optional.  Apptoto can extract participants from the title/location/content for you.  But if you want to explicitly include participants you can include them in this Array.\",\n    \"5-0\": \"phone\",\n    \"5-1\": \"String\",\n    \"5-2\": \"A phone number for the contact .  E.g. 650-555-1212.  \\n\\nIf the contact has multiple phone numbers then pass the phone_numbers array instead.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\nEach Phone number object should include the following properties\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"number\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The number of the contact. E.g. 650-555-1212\",\n    \"1-0\": \"is_mobile\",\n    \"1-1\": \"Boolean\",\n    \"1-2\": \"Sets the phone type as \\\"mobile\\\" for the address book specified.\",\n    \"2-0\": \"type\",\n    \"2-1\": \"String\",\n    \"2-2\": \"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.\",\n    \"3-0\": \"is_primary\",\n    \"3-1\": \"Boolean\",\n    \"3-2\": \"True if this should be the primary phone number to use when sending email to this contact.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nEach email address object should include the following properties\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"address\",\n    \"0-1\": \"String\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The email address of the contact.  E.g. [email protected]\",\n    \"1-0\": \"type\",\n    \"1-1\": \"String\",\n    \"1-2\": \"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.\",\n    \"2-0\": \"is_primary\",\n    \"2-1\": \"Boolean\",\n    \"2-2\": \"True if this should be the primary email address to use when sending email to this contact.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-03-15T16:42:47.140Z","user":"55d648e9e60a2f0d00b88eb1","category":"604f897e439f4d004adad64b","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":9,"parentDoc":null,"childrenPages":[]}

{"_id":"604f93ba8155a6001172ae0f","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/contacts","auth":"required","examples":{"codes":[]},"method":"put","params":[{"name":"contacts","type":"array_object","default":"","desc":"Array of events to add","required":true,"in":"body","ref":"","_id":"570ff722711e960e00f24698"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n  contacts: [ CONTACTS CREATED ]\n}"}]},"settings":""},"next":{"description":"","pages":[]},"title":"/v1/contacts","type":"put","slug":"v1contacts-1","excerpt":"Create events in Apptoto.  Apptoto's auto messages will be sent for the events created if Auto Messages are turned on.  Otherwise, be sure to include #auto in the event information in order to tell Apptoto to send the Auto Messages configured for the account.","body":"Create or update contacts in Apptoto. \n\nTo update existing contacts, be sure to provide either an external_id or id, otherwise a new contact will be created. For the contact properties, this API acts like a patch... meaning that only the events fields you specify will be updated.\n\nHowever, if you provide a value for the \"phone_numbers\", \"email_addresses\", or \"custom_data\" field, then provide all of the data. Meaning, it does not act as a patch for custom_data or individual endpoints.\n\nAlso, please note that we do not support moving a contact from one address book to another.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"2-0\": \"address_book_id\",\n    \"2-1\": \"Integer\",\n    \"2-2\": \"The id of the address book to scope the external_id to.\",\n    \"3-0\": \"name\",\n    \"3-1\": \"String\\n(Required)\",\n    \"3-2\": \"The full name of the contact.  E.g. Fred Smith\\n\\nNOTE: you can provide either \\\"name\\\" or you can provide \\\"first_name\\\" and \\\"last_name\\\".  \\\"name\\\" will take precedence.\",\n    \"4-0\": \"first_name\",\n    \"4-1\": \"String \\n(Required)\",\n    \"4-2\": \"The first name of the contact.\\nE.g. Fred\",\n    \"5-0\": \"last_name\",\n    \"5-1\": \"String\\n(Required)\",\n    \"5-2\": \"The last name of the contact.\\nE.g. Fred\",\n    \"7-0\": \"add_email\",\n    \"7-1\": \"String\",\n    \"7-2\": \"An email address for the contact.  E.g. [email protected] .\",\n    \"8-0\": \"phone_numbers\",\n    \"8-1\": \"Array\",\n    \"8-2\": \"An array of phone numbers to add to the contact.  See below for phone number fields\",\n    \"9-0\": \"email_addreses\",\n    \"9-1\": \"Array\",\n    \"9-2\": \"An array of email addresses to add to the contact.  See below for the email address fields.\",\n    \"10-0\": \"external_id\",\n    \"10-1\": \"String\",\n    \"10-2\": \"An optional unique identifier (should be unique across all calendars in user's account).  Can be used to fetch updates and update events.\",\n    \"11-0\": \"external_id\",\n    \"11-1\": \"String\",\n    \"11-2\": \"An optional unique identifier (should be unique across all calendars in user's account).  Can be used to fetch updates and update events.\",\n    \"12-0\": \"participants\",\n    \"12-1\": \"Array\",\n    \"12-2\": \"Array of participants to be added.\\n\\nThis is optional.  Apptoto can extract participants from the title/location/content for you.  But if you want to explicitly include participants you can include them in this Array.\",\n    \"6-0\": \"add_phone\",\n    \"6-1\": \"String\",\n    \"6-2\": \"A new phone number for the contact .  E.g. 650-555-1212.\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"The unique identifier of the contact to be updated.\",\n    \"1-0\": \"external_id\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The \\\"external_id\\\" provided by you when you created the contact through the API.  Or it could also be the \\\"external_id\\\" on the source address book.  For example the Google Address Book's id.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\nEach Phone number object should include the following properties\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"number\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The number of the contact. E.g. 650-555-1212\",\n    \"1-0\": \"is_mobile\",\n    \"1-1\": \"Boolean\",\n    \"1-2\": \"Sets the phone type as \\\"mobile\\\" for the address book specified.\",\n    \"2-0\": \"type\",\n    \"2-1\": \"String\",\n    \"2-2\": \"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.\",\n    \"3-0\": \"is_primary\",\n    \"3-1\": \"Boolean\",\n    \"3-2\": \"True if this should be the primary phone number to use when sending email to this contact.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nEach email address object should include the following properties\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"address\",\n    \"0-1\": \"String\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The email address of the contact.  E.g. [email protected]\",\n    \"1-0\": \"type\",\n    \"1-1\": \"String\",\n    \"1-2\": \"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.\",\n    \"2-0\": \"is_primary\",\n    \"2-1\": \"Boolean\",\n    \"2-2\": \"True if this should be the primary email address to use when sending email to this contact.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-03-15T17:04:58.452Z","user":"55d648e9e60a2f0d00b88eb1","category":"604f897e439f4d004adad64b","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":0,"parentDoc":null,"childrenPages":[]}

{"_id":"604f9419d2b7a7002ab1e9c5","metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/contacts","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  contacts: [\n    {\n      id: 1,\n      external_id: \"yourid\",\n      name: \"Fred Smith\",\n      first_name: \"Fred\",\n      last_name: \"Smith\",\n      zip: \"97701\",\n      address_book_id: 123,\n      address_book_name: \"Apptoto Address Book\",\n      writable: true,\n      notes: \"Long string of notes\",\n      deleted: true,\n      phone_numbers: [\n        {\n          id: 3,\n          phone: \"650-555-1212\",\n          normalized_phone: \"+16505551212\",\n          type: \"mobile\",\n          is_primary: true\n        }\n      ],\n      email_addresses: [\n        {\n          id: 4,\n          address: \"[email protected]\",\n          type: \"work\"\n        }\n      ],\n      custom_data: {\n        field_1: \"vip\"\n      }\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"id","type":"int","default":"","desc":"The id of the contact to remove.","required":false,"in":"query","ref":"","_id":"604f8ca4746be50068beba96"}],"examples":{"codes":[]},"method":"delete"},"next":{"description":"","pages":[]},"title":"/v1/contacts","type":"delete","slug":"v1contacts-2","excerpt":"Delete one contact from apptoto.","body":"Delete one contact from Apptoto.","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2021-03-15T17:06:33.613Z","user":"55d648e9e60a2f0d00b88eb1","category":"604f897e439f4d004adad64b","version":"55d6491e114e3e0d00462a8e","project":"55d6491e114e3e0d00462a8b","__v":3,"parentDoc":null,"childrenPages":[]}

{"_id":"562eaab10870380d00796cbc","__v":9,"body":"POST /v1/import kicks off an Import based on the data you pass in.  You can use GET /v1/import to fetch the Import information using the id provided to find out the result of the import.","category":"562ebb031d18c50d0058346f","editedParams2":true,"excerpt":"Imports can be kicked off by uploading a CSV file to https://api.apptoto.com/v1/import","user":"55d648e9e60a2f0d00b88eb1","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"import\": {\n    \"id\": NUMERIC IDENTIFIER,\n    \"state\": launching | running | invalid | finished | aborted\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v1/import","auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"562eab2afcb8340d0005fd86","ref":"","in":"body","required":true,"desc":"The CSV or Tab-delimited file that Apptoto should import.  This parameter can either a string, or a file (using multipart/form-data)","default":"","type":"file","name":"data"},{"_id":"562eab2afcb8340d0005fd84","ref":"","in":"body","required":false,"desc":"Instead of providing a \"spec\" parameter, you can use Apptoto's Import UI to map columns to fields.  Once you've done that you can specify the import id of the existing import for the based_on_import_id parameter and Apptoto will use the settings from that previous import when running the new uploaded import.","default":"","type":"int","name":"based_on_import_id"},{"_id":"562eab2afcb8340d0005fd85","ref":"","in":"body","required":false,"desc":"The spec JSON tells Apptoto how to interpret the uploaded file.  If you specify a based_on_import_id value, then this field is not required as Apptoto will use the \"spec\" used in that import.","default":"","type":"object","name":"spec"},{"_id":"562eb709fcb8340d0005fd9d","ref":"","in":"body","required":false,"desc":"Can be either \"events\" or \"contacts\".  Defaults to \"events\".","default":"events","type":"string","name":"target"},{"_id":"56be5d740d53850d00cb395d","ref":"","in":"body","required":false,"desc":"Required when using the \"support_delete\" option.  This tells Apptoto the beginning of the time range of appointments that you are uploading.  Any appointments that are inside the time range but not included in the new upload will be removed if support_delete is turned on.","default":"","type":"datetime","name":"start_time"},{"_id":"56be5d740d53850d00cb395c","ref":"","in":"body","required":false,"desc":"Required when using the \"support_delete\" option.  See start_time parameter above for more information.","default":"","type":"datetime","name":"end_time"},{"_id":"56d9e9752716531d00b1a5ba","ref":"","in":"body","required":false,"desc":"Supports removing any appointments on the server that are not listed in the upload between the start_time and end_time provided.  This is often set in the upload spec already, but you can override it here.","default":"","type":"boolean","name":"support_delete"},{"_id":"56d9e9877222d50b00701638","ref":"","in":"body","required":false,"desc":"Supports updating any appointments on the server that are not listed in the upload between the start_time and end_time provided.  This is often set in the upload spec already, but you can override it here.","default":"","type":"boolean","name":"support_update"}]},"createdAt":"2015-10-26T22:35:29.233Z","link_url":"","version":"55d6491e114e3e0d00462a8e","hidden":false,"link_external":false,"project":"55d6491e114e3e0d00462a8b","sync_unique":"","type":"post","editedParams":true,"githubsync":"","order":0,"slug":"import-upload","title":"/v1/import","updates":["611e66baeef17a0074b8a09b","611e66daf2855b004601e179"],"parentDoc":null,"isReference":false,"next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"562eb79e3b2af20d006ad05e","__v":0,"link_external":false,"sync_unique":"","type":"get","editedParams":true,"githubsync":"","user":"55d648e9e60a2f0d00b88eb1","version":"55d6491e114e3e0d00462a8e","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"required":true,"type":"int","in":"query","_id":"562eb79e3b2af20d006ad05f","default":"","desc":"The id of the import to fetch","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"import\": {\n    \"id\": NUMERIC IDENTIFIER,\n    \"state\": launching | running | invalid | finished | aborted\n  }\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/v1/import"},"body":"","category":"562ebb031d18c50d0058346f","title":"/v1/import","updates":[],"excerpt":"","link_url":"","order":1,"project":"55d6491e114e3e0d00462a8b","createdAt":"2015-10-26T23:30:38.743Z","editedParams2":true,"hidden":false,"slug":"v1import","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"56d200dc5787df1500688266","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","editedParams2":true,"excerpt":"The endpoint allows you to fetch the list of phone numbers or email addresses that have been previously opted-out or opted-in to receiving messages from Apptoto.","editedParams":true,"link_external":false,"link_url":"","project":"55d6491e114e3e0d00462a8b","type":"get","slug":"v1lists","sync_unique":"","updates":[],"__v":0,"api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"desc":"Should be \"out\" or \"in\".  The type of list to fetch.  \"out\" will fetch all of the phone numbers or email addresses that been opted out.  \"in\" will fetch all of the phone numbers or email addresses that have opted-in.","name":"type","required":true,"type":"string","in":"query","_id":"56d200dc5787df1500688268","default":""},{"required":true,"type":"string","in":"query","_id":"56d200dc5787df1500688267","default":"","desc":"Should be \"call\", \"sms\", or \"email\".","name":"comm_type"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v1/lists"},"category":"56d200585ad7ad0b00b7e81d","hidden":false,"order":0,"version":"55d6491e114e3e0d00462a8e","createdAt":"2016-02-27T20:02:36.009Z","githubsync":"","title":"/v1/lists","user":"55d648e9e60a2f0d00b88eb1","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"56d20169c577550b00a7a9cd","githubsync":"","hidden":false,"link_external":false,"order":1,"__v":0,"body":"","createdAt":"2016-02-27T20:04:57.546Z","editedParams":true,"slug":"v1lists-1","sync_unique":"","title":"/v1/lists","version":"55d6491e114e3e0d00462a8e","api":{"settings":"","url":"/v1/lists","auth":"required","examples":{"codes":[]},"method":"post","params":[{"default":"","type":"string","name":"type","in":"body","_id":"56d20169c577550b00a7a9d0","required":true,"desc":"\"out\" or \"in\".  The type of list to add to."},{"in":"body","_id":"56d20169c577550b00a7a9cf","required":true,"desc":"\"call\", \"sms\", or \"email\".","default":"","type":"string","name":"comm_type"},{"default":"","type":"string","name":"entry","in":"body","_id":"56d20169c577550b00a7a9ce","required":true,"desc":"The phone number or email address to add.  Phone numbers will be normalized using the user's country setting, unless a country code is provided (e.g. +16505551212)"}],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]}},"editedParams2":true,"updates":[],"user":"55d648e9e60a2f0d00b88eb1","excerpt":"This endpoint allows you to add an entry to an opt-out or opt-in list.","link_url":"","project":"55d6491e114e3e0d00462a8b","category":"56d200585ad7ad0b00b7e81d","type":"post","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

{"_id":"56d31efc1660770b000810e4","body":"","createdAt":"2016-02-28T16:23:24.021Z","excerpt":"This endpoint allows you to update an entire opt-out or opt-in list of phone numbers or email addresses for each type of message (call, sms, or email).","hidden":false,"slug":"v1lists-3","sync_unique":"","api":{"url":"/v1/lists","auth":"required","examples":{"codes":[]},"method":"put","params":[{"_id":"56d20169c577550b00a7a9d0","required":true,"desc":"\"out\" or \"in\".  The type of list to add to.","default":"","type":"string","name":"type","in":"body"},{"_id":"56d20169c577550b00a7a9cf","required":true,"desc":"\"call\", \"sms\", or \"email\".","default":"","type":"string","name":"comm_type","in":"body"},{"in":"body","_id":"56d20169c577550b00a7a9ce","default":"","desc":"The list of phone numbers and email addresses for the list.  Any number or email address not included will be removed the user's list.  Phone numbers will be normalized using the user's country setting, unless a country code is provided (e.g. +16505551212).","name":"list","required":true,"type":"array_string"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"title":"/v1/lists","__v":1,"editedParams":true,"editedParams2":true,"link_external":false,"type":"put","user":"55d648e9e60a2f0d00b88eb1","version":"55d6491e114e3e0d00462a8e","category":"56d200585ad7ad0b00b7e81d","githubsync":"","link_url":"","order":2,"project":"55d6491e114e3e0d00462a8b","updates":["62a75c282a74bd00863a2bea"],"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

{"_id":"56d201a55ad7ad0b00b7e820","editedParams2":true,"order":3,"slug":"v1lists-2","body":"","api":{"examples":{"codes":[]},"method":"delete","params":[{"type":"string","name":"type","in":"body","_id":"56d20169c577550b00a7a9d0","required":true,"desc":"\"out\" or \"in\".  The type of list to add to.","default":""},{"_id":"56d20169c577550b00a7a9cf","required":true,"desc":"\"call\", \"sms\", or \"email\".","default":"","type":"string","name":"comm_type","in":"body"},{"required":true,"desc":"The phone number or email address to remove.  Phone numbers will be normalized using the user's country setting, unless a country code is provided (e.g. +16505551212)","default":"","type":"string","name":"entry","in":"body","_id":"56d20169c577550b00a7a9ce"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/v1/lists","auth":"required"},"editedParams":true,"sync_unique":"","type":"delete","updates":[],"version":"55d6491e114e3e0d00462a8e","__v":0,"createdAt":"2016-02-27T20:05:57.819Z","excerpt":"This endpoint allows you to remove an entry from an opt-out or opt-in list.","githubsync":"","hidden":false,"link_external":false,"title":"/v1/lists","user":"55d648e9e60a2f0d00b88eb1","category":"56d200585ad7ad0b00b7e81d","project":"55d6491e114e3e0d00462a8b","link_url":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}