{"openapi":"3.1.0","info":{"title":"hellomateo API","description":"Development documentation","version":"2026-07-01"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AnyJsonObject":{"type":"object","additionalProperties":{}},"File":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"filename":{"anyOf":[{"type":"string"},{"type":"null"}]},"purpose":{"type":"string","enum":["media_library","message_attachment","contact_file","template_header_media","gallery_template_header_media","partner_gallery_template_header_media","template_extra_file","gallery_template_extra_file","partner_gallery_template_extra_file","campaign_template_header_media","gallery_campaign_template_header_media","journey_node_header_media","gallery_journey_node_header_media","sendout_template_header_media","kb_document","gallery_kb_document","kb_document_extract","gallery_kb_document_extract","import_payload","import_failed_records","export_file","form_submission_media","voice_call_transcription","voice_call_recording","voice_preview","video_thumbnail","profile_image","organisation_logo","organisation_favicon","organisation_commercial_register_extract","organisation_identity_card","partner_logo","contact_widget_image","contact_widget_asset","review_channel_logo","booking_page_logo"]},"path":{"type":"string","minLength":1},"size":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/AnyJsonObject"},"user_metadata":{"$ref":"#/components/schemas/AnyJsonObject"}},"required":["id","created_at","updated_at","filename","purpose","path","size","type","metadata","user_metadata"]},"TextNode":{"type":"object","properties":{"type":{"type":"string","const":"text"},"content":{"type":"string"},"bold":{"type":"boolean"},"underline":{"type":"boolean"},"strikethrough":{"type":"boolean"},"italic":{"type":"boolean"}},"required":["type","content"]},"MentionNode":{"type":"object","properties":{"type":{"type":"string","const":"mention"},"content":{"type":"string"},"mentionName":{"type":"string"},"bold":{"type":"boolean"},"underline":{"type":"boolean"},"strikethrough":{"type":"boolean"},"italic":{"type":"boolean"}},"required":["type","content","mentionName"]},"HandlebarNode":{"type":"object","properties":{"type":{"type":"string","const":"handlebar"},"key":{"type":"string"},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time"}]},{"type":"null"}]},"bold":{"type":"boolean"},"underline":{"type":"boolean"},"strikethrough":{"type":"boolean"},"italic":{"type":"boolean"}},"required":["type","key"]},"NewLineNode":{"type":"object","properties":{"type":{"type":"string","const":"newline"}},"required":["type"]},"LinkNode":{"type":"object","properties":{"type":{"type":"string","const":"link"},"url":{"type":"string"},"children":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/MentionNode"},{"$ref":"#/components/schemas/TextNode"},{"$ref":"#/components/schemas/HandlebarNode"},{"$ref":"#/components/schemas/NewLineNode"}]}},"bold":{"type":"boolean"},"underline":{"type":"boolean"},"strikethrough":{"type":"boolean"},"italic":{"type":"boolean"}},"required":["type","url","children"]},"ListItem":{"type":"object","properties":{"type":{"type":"string","const":"listItem"},"children":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/MentionNode"},{"$ref":"#/components/schemas/TextNode"},{"$ref":"#/components/schemas/HandlebarNode"},{"$ref":"#/components/schemas/NewLineNode"},{"$ref":"#/components/schemas/LinkNode"}]}}},"required":["type","children"]},"ListNode":{"type":"object","properties":{"type":{"type":"string","const":"list"},"listType":{"type":"string","enum":["bullet","number"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}}},"required":["type","listType","items"]},"ContentNode":{"anyOf":[{"$ref":"#/components/schemas/TextNode"},{"$ref":"#/components/schemas/MentionNode"},{"$ref":"#/components/schemas/HandlebarNode"},{"$ref":"#/components/schemas/LinkNode"},{"$ref":"#/components/schemas/NewLineNode"},{"$ref":"#/components/schemas/ListNode"},{"$ref":"#/components/schemas/ListItem"},{"$ref":"#/components/schemas/ParagraphNode"}]},"RootNode":{"type":"object","properties":{"type":{"type":"string","const":"root"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ContentNode"}},"style":{"type":"object","properties":{"color":{"type":"string"},"fontSize":{"type":"number"},"fontFamily":{"type":"string"},"alignment":{"type":"string","enum":["left","center","right","justify"]}}}},"required":["type","children"]},"ParagraphNode":{"type":"object","properties":{"type":{"type":"string","const":"paragraph"},"children":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/TextNode"},{"$ref":"#/components/schemas/MentionNode"},{"$ref":"#/components/schemas/HandlebarNode"},{"$ref":"#/components/schemas/NewLineNode"},{"$ref":"#/components/schemas/ListNode"},{"$ref":"#/components/schemas/LinkNode"},{"$ref":"#/components/schemas/ParagraphNode"}]}},"bold":{"type":"boolean"},"underline":{"type":"boolean"},"strikethrough":{"type":"boolean"},"italic":{"type":"boolean"}},"required":["type","children"]},"FileInput":{"type":"object","properties":{"file_id":{"type":"string","format":"uuid"}},"required":["file_id"]},"AppointmentStatus":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"appointment_type_id":{"type":"string","format":"uuid"},"idx":{"type":"integer","minimum":0,"maximum":9007199254740991},"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["cancelled","confirmed","pending"]},"key":{"type":"string","minLength":1},"is_gallery":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","appointment_type_id","idx","name","type","key","is_gallery","created_at","updated_at"]},"AppointmentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string","minLength":1},"description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"key":{"type":"string","minLength":1},"emoji":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"scheduling_enabled":{"type":"boolean"},"is_gallery":{"type":"boolean"},"gallery_key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentStatus"}}},"required":["id","organisation_id","name","description","external_id","key","emoji","scheduling_enabled","is_gallery","gallery_key","deleted_at","created_at","updated_at"]},"Contact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"salutation":{"anyOf":[{"type":"string"},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_blocked":{"type":"boolean"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","display_name","full_name","salutation","birthday","description","external_id","secondary_external_id","address_line1","address_line2","city","zipcode","country","is_blocked","organisation_id","created_at","updated_at"]},"Employee":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"type":"string"},"username":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"},"full_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"email":{"anyOf":[{"type":"string","pattern":"^(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)*[a-zA-Z]{2,}))$"},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"is_admin":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"signature":{"anyOf":[{"type":"string"},{"type":"null"}]},"organisation_id":{"type":"string","format":"uuid"},"locale":{"type":"string"},"enable_shortcuts":{"type":"boolean"},"is_web_push_enabled":{"type":"boolean"},"is_mobile_push_enabled":{"type":"boolean"},"is_active":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","display_name","username","full_name","email","user_id","is_admin","signature","organisation_id","locale","enable_shortcuts","is_web_push_enabled","is_mobile_push_enabled","is_active","created_at","updated_at"]},"Calendar":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"provider_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"calendar_resource_id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["provider","virtual"]},"is_default":{"type":"boolean"},"scheduling_enabled":{"type":"boolean"},"yes_status_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"no_status_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"maybe_status_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"noreply_status_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","external_id","provider_id","calendar_resource_id","type","is_default","scheduling_enabled","yes_status_id","no_status_id","maybe_status_id","noreply_status_id","created_at","updated_at"]},"AppointmentScheduler":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"appointment_type_id":{"type":"string","format":"uuid"},"location_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"form_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"provider_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"appointment_scheduler_type":{"type":"string","enum":["nylas"]},"event_booking_config":{},"scheduler_settings":{},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","appointment_type_id","location_id","form_id","provider_id","appointment_scheduler_type","event_booking_config","scheduler_settings","created_at","updated_at"]},"CustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string","minLength":1},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["boolean","date","datetime","number","string","string_list"]},"key":{"type":"string","minLength":1},"options":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","minLength":1}},{"type":"null"}]},"hidden":{"type":"boolean"},"show_in_sidebar":{"type":"boolean"},"entity":{"type":"string","enum":["appointment","contact","deal"]},"is_select":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"is_gallery":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","description","type","key","options","hidden","show_in_sidebar","entity","is_select","deleted_at","is_gallery","created_at","updated_at"]},"CalendarBlockedTime":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"calendar_id":{"type":"string","format":"uuid"},"source":{"type":"string","enum":["manual","external"]},"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_all_day":{"type":"boolean"},"start_at":{"type":"string","format":"date-time"},"end_at":{"type":"string","format":"date-time"},"recurrence_rule":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"series_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"replaces_occurrence_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","calendar_id","source","name","is_all_day","start_at","end_at","recurrence_rule","series_id","replaces_occurrence_at","event_id","created_at","updated_at"]},"OpeningHours":{"type":"object","properties":{"days_of_the_week":{"minItems":1,"type":"array","items":{"type":"integer","minimum":1,"maximum":7}},"open_time":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$"},"close_time":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$"}},"required":["days_of_the_week","open_time","close_time"]},"CalendarResource":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"is_default":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","is_default","created_at","updated_at"]},"Provider":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"type":"string","enum":["twilio-regulatory-bundle","meta-account","google-account","nylas","360dialog-whatsapp-business-account","meta-business","meta-waba","emailbrief","twilio"]},"status":{"type":"string","enum":["draft","in-review","rejected","active","inactive"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"config":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonObject"},{"type":"null"}]},"authorised_channel_types":{"anyOf":[{"type":"array","items":{"type":"string","enum":["email","sms","whatsapp","instagram","facebook","google_business_messaging","postal"]}},{"type":"null"}]},"authorised_review_channel_types":{"anyOf":[{"type":"array","items":{"type":"string","enum":["google-my-business"]}},{"type":"null"}]},"rejection_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_api_token_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"created_by_employee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"created_by_rule_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_api_token_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"updated_by_employee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"updated_by_rule_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]}},"required":["id","organisation_id","name","type","status","external_id","config","authorised_channel_types","authorised_review_channel_types","rejection_reason","created_at","updated_at","deleted_at","created_by","created_by_api_token_id","created_by_employee_id","created_by_rule_id","updated_by","updated_by_api_token_id","updated_by_employee_id","updated_by_rule_id"]},"Channel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"handle":{"anyOf":[{"type":"string"},{"type":"null"}]},"alias":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]},"status":{"type":"string","enum":["active","draft","in-review","inactive","rejected"]},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"provider_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"provider_type":{"type":"string","enum":["360dialog-whatsapp-business-account","emailbrief","google-account","meta-account","meta-business","meta-waba","nylas","twilio","twilio-regulatory-bundle"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"link":{"anyOf":[{"type":"string"},{"type":"null"}]},"daily_message_limit":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"sms_available":{"type":"boolean"},"voice_available":{"type":"boolean"},"voice_enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"required":["id","organisation_id","inbox_id","name","handle","alias","type","status","active","provider_id","provider_type","external_id","link","daily_message_limit","sms_available","voice_available","voice_enabled","created_at","updated_at","deleted_at"]},"Position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"]},"ExtraContentElement":{"type":"object","properties":{"page":{"type":"number"},"maxWidth":{"type":"number"},"position":{"$ref":"#/components/schemas/Position"},"content":{"$ref":"#/components/schemas/RootNode"}},"required":["page","maxWidth","position","content"]},"CallToActionTemplateButton":{"type":"object","properties":{"type":{"type":"string","const":"call_to_action"},"subtype":{"anyOf":[{"type":"string","enum":["phone_number","url"]},{"type":"null"}]},"text":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","text"],"additionalProperties":{}},"ListTemplateButton":{"type":"object","properties":{"type":{"type":"string","const":"list"},"text":{"type":"string"},"data":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","text"],"additionalProperties":{}},"QuickReplyTemplateButton":{"type":"object","properties":{"type":{"type":"string","const":"quick_reply"},"text":{"type":"string"},"data":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","text"],"additionalProperties":{}},"TemplateButton":{"oneOf":[{"$ref":"#/components/schemas/CallToActionTemplateButton"},{"$ref":"#/components/schemas/ListTemplateButton"},{"$ref":"#/components/schemas/QuickReplyTemplateButton"}]},"TemplateButtons":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/TemplateButton"}},{"type":"null"}]},"Template":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"key":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["auto_responder","double_opt_in_confirmation","marketing","opt_in_request","opt_out_confirmation","review_request","transactional"]},"channel_type":{"anyOf":[{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"type":"string"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"footer":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"anyOf":[{"$ref":"#/components/schemas/RootNode"},{"type":"null"}]},"extra_content":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ExtraContentElement"}},{"type":"null"}]},"buttons":{"$ref":"#/components/schemas/TemplateButtons"},"text":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlebars":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"is_gallery_template":{"type":"boolean"},"goal":{"anyOf":[{"type":"string"},{"type":"null"}]},"industries":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"archived":{"type":"boolean"},"duplex":{"type":"boolean"},"not_user_selectable":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"request_approvals":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"partner_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","key","name","description","type","channel_type","category","language","subject","footer","content","extra_content","buttons","text","handlebars","is_gallery_template","goal","industries","archived","duplex","not_user_selectable","request_approvals","partner_id","created_at","updated_at"]},"ContactList":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string","minLength":1},"counts":{"anyOf":[{},{"type":"null"}]},"key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_gallery":{"type":"boolean"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","counts","key","external_id","is_gallery","deleted_at","created_at","updated_at"]},"Inbox":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"emoji":{"type":"string"},"key":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_gallery":{"type":"boolean"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"conversation_count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"required":["id","organisation_id","name","description","emoji","key","is_gallery","is_default","conversation_count","created_at","updated_at","deleted_at"]},"MessageContact":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"type":{"type":"string"},"zip":{"type":"string"}}}},"birthday":{"type":"string"},"emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"type":{"type":"string"}}}},"name":{"type":"object","properties":{"formatted_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"suffix":{"type":"string"},"prefix":{"type":"string"}},"required":["formatted_name"]},"org":{"type":"object","properties":{"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"}}},"phones":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string"},"type":{"type":"string"},"wa_id":{"type":"string"}}}},"urls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}}}},"required":["emails","org","phones","urls"]},"MessageLocationMetadata":{"type":"object","properties":{"address":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"MessageAction":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"conversation_id":{"type":"string","format":"uuid"},"message_id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["call_to_action","list","quick_reply"]},"subtype":{"anyOf":[{"type":"string","enum":["phone_number","url"]},{"type":"null"}]},"text":{"type":"string"},"data":{"anyOf":[{"type":"string"},{"type":"null"}]},"index":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"clicked":{"type":"boolean"},"sqid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"accept_marketing_channel_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"decline_marketing_channel_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"trigger_marketing_channel_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"form_element_option_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","conversation_id","message_id","type","subtype","text","data","index","clicked","sqid","accept_marketing_channel_id","decline_marketing_channel_id","trigger_marketing_channel_id","form_element_option_id","created_at","updated_at"]},"MessageReaction":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"conversation_id":{"type":"string","format":"uuid"},"message_id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"emoji":{"type":"string"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","conversation_id","message_id","recipient_id","emoji","external_id","created_at","updated_at"]},"Recipient":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"conversation_id":{"type":"string","format":"uuid"},"message_id":{"type":"string","format":"uuid"},"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"handle":{"type":"string"},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"anyOf":[{"type":"string","enum":["bcc","cc","from","reply_to","to"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["answered","bounce_error","draft","interacted","read","scheduled","sending","sending_error","sent","submission_error","submitted"]},{"type":"null"}]},"is_organisation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","conversation_id","message_id","contact_id","handle","full_name","role","status","is_organisation","created_at","updated_at"]},"MessageExternalAttachment":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string","enum":["audio","video","image","pdf","file","story_mention","share","unsupported_type"]}},"required":["url","type"]},"Comment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"conversation_id":{"type":"string","format":"uuid"},"message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"author_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"anyOf":[{"$ref":"#/components/schemas/RootNode"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","conversation_id","message_id","author_id","content","created_at","updated_at"],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"}}},"Conversation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"channel_id":{"type":"string","format":"uuid"},"channel_type":{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]},"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"assignee_cs_agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["archived","closed","open"]},"is_spam":{"type":"boolean"},"unread":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"latest_activity_created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"latest_message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"latest_message_created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"latest_message_forwarded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"latest_message_attachment_count":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"latest_inbound_message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"latest_inbound_message_created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"latest_inbound_voice_call_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"latest_inbound_voice_call_created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"opened_by_message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"opened_by_voice_call_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"session_ends_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"required":["id","organisation_id","inbox_id","channel_id","channel_type","contact_id","assignee_id","assignee_cs_agent_id","external_id","subject","snippet","status","is_spam","unread","latest_activity_created_at","latest_message_id","latest_message_created_at","latest_message_forwarded","latest_message_attachment_count","latest_inbound_message_id","latest_inbound_message_created_at","latest_inbound_voice_call_id","latest_inbound_voice_call_created_at","opened_by_message_id","opened_by_voice_call_id","session_ends_at","created_at","updated_at","deleted_at"]},"MessageFile":{"type":"object","properties":{"name":{"type":"string"},"metadata":{"$ref":"#/components/schemas/AnyJsonObject"}},"required":["name"],"additionalProperties":{}},"Message":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"conversation_id":{"type":"string","format":"uuid"},"channel_id":{"type":"string","format":"uuid"},"channel_type":{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]},"author_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"author_type":{"anyOf":[{"type":"string","enum":["bot","employee","external"]},{"type":"null"}]},"is_inbound":{"type":"boolean"},"forwarded":{"type":"boolean"},"content":{"anyOf":[{"$ref":"#/components/schemas/RootNode"},{"type":"null"}]},"raw_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"footer":{"anyOf":[{"type":"string"},{"type":"null"}]},"contacts":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/MessageContact"}},{"type":"null"}]},"external_files":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/MessageExternalAttachment"}},{"type":"null"}]},"files":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/MessageFile"}},{"type":"null"}]},"header_media_filename":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},{"type":"null"}]},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["answered","bounce_error","draft","interacted","read","scheduled","sending","sending_error","sent","submission_error","submitted"]},{"type":"null"}]},"send_after":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"date":{"type":"string","format":"date-time"},"template_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"sendout_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"campaign_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"review_channel_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"reply_to_message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"attachment_count":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"placeholder_values":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"location_metadata":{"anyOf":[{"$ref":"#/components/schemas/MessageLocationMetadata"},{"type":"null"}]},"quoted_message_content":{"anyOf":[{"$ref":"#/components/schemas/RootNode"},{"type":"null"}]},"quoted_message_text":{"anyOf":[{"type":"string"},{"type":"null"}]},"forwarded_message_content":{"anyOf":[{"$ref":"#/components/schemas/RootNode"},{"type":"null"}]},"forwarded_message_text":{"anyOf":[{"type":"string"},{"type":"null"}]},"cleared_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_api_token_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"created_by_rule_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"cs_agent_session_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"form_element_submission_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"journey_node_execution_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"omni_channel_message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"marketing_channel_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"triggered_message_action_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","conversation_id","channel_id","channel_type","author_id","author_type","is_inbound","forwarded","content","raw_content","snippet","subject","footer","contacts","external_files","files","header_media_filename","error","error_code","status","send_after","sent_at","timestamp","date","template_id","sendout_id","campaign_id","review_channel_id","reply_to_message_id","attachment_count","placeholder_values","location","location_metadata","quoted_message_content","quoted_message_text","forwarded_message_content","forwarded_message_text","cleared_at","external_id","created_by_api_token_id","created_by_rule_id","cs_agent_session_id","form_element_submission_id","journey_node_execution_id","omni_channel_message_id","marketing_channel_id","triggered_message_action_id","created_at","updated_at"],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"}}},"EmployeeInvite":{"type":"object","properties":{"employee_id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"status":{"type":"string"},"invited_at":{"type":"string","format":"date-time"},"accepted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"declined_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["employee_id","organisation_id","status","invited_at","accepted_at","declined_at","created_at","updated_at"]},"Team":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"is_default":{"type":"boolean"},"is_gallery":{"type":"boolean"},"name":{"type":"string","minLength":1},"emoji":{"default":"🏡","type":"string"},"key":{"default":null,"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","is_default","is_gallery","name","created_at","updated_at"]},"InboxAccess":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"team_id":{"type":"string","format":"uuid"},"level":{"type":"string","enum":["full","inbox_only"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","team_id","level","created_at","updated_at"]},"MessageTranslation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"message_id":{"type":"string","format":"uuid"},"locale":{"type":"string"},"translation":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","message_id","locale","translation","created_at"]},"MessageTranscription":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"message_id":{"type":"string","format":"uuid"},"transcription":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","inbox_id","message_id","transcription","created_at"]},"Organisation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}]},"landline":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string","pattern":"^(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)*[a-zA-Z]{2,}))$"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"industry":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}]},"iso_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"vat":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_sp":{"type":"boolean"},"sp_full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"sp_region":{"anyOf":[{"type":"string"},{"type":"null"}]},"sp_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"sp_street":{"anyOf":[{"type":"string"},{"type":"null"}]},"sp_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"data_privacy_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"opt_out_template_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"marketing_enabled":{"type":"boolean"},"timezone":{"type":"string"},"locale":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","display_name","mobile","landline","email","street","postal_code","city","address_line","industry","region","iso_country","vat","is_sp","sp_full_name","sp_region","sp_postal_code","sp_street","sp_city","data_privacy_url","description","website_url","opt_out_template_id","marketing_enabled","timezone","locale","created_at","updated_at"]},"Country":{"type":"object","properties":{"code":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","name"]},"OptInGroup":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string","minLength":1},"trigger_keyword":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"accept_keyword":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"decline_keyword":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"request_double_opt_in_template_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"subscription_successful_template_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"key":{"type":"string"},"counts":{"anyOf":[{},{"type":"null"}]},"latest_subscription_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"request_double_opt_in_placeholder_values":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1}},{"type":"null"}]},"subscription_successful_placeholder_values":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1}},{"type":"null"}]},"status":{"type":"string","enum":["draft","active","inactive"]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"is_gallery":{"type":"boolean"}},"required":["id","created_at","updated_at","organisation_id","name","trigger_keyword","accept_keyword","decline_keyword","request_double_opt_in_template_id","subscription_successful_template_id","key","counts","latest_subscription_at","request_double_opt_in_placeholder_values","subscription_successful_placeholder_values","status","deleted_at","is_gallery"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"opt_in_group_id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"key":{"type":"string"},"status":{"type":"string","enum":["requested","accepted","declined"]},"channel_type":{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]}},"required":["id","contact_id","opt_in_group_id","organisation_id","created_at","updated_at","key","status","channel_type"]},"ContactIdentity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"channel_type":{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1},"scope_type":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"scope_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"health":{"type":"string","enum":["healthy","unhealthy","unknown"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","contact_id","channel_type","type","value","scope_type","scope_id","health","created_at","updated_at"]},"ContactChannel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"channel_type":{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},"health":{"type":"string","enum":["healthy","unhealthy","unknown"]},"transactional_opt_in":{"anyOf":[{"type":"string","enum":["consent_granted","contract_fulfillment","legitimate_interest"]},{"type":"null"}]},"marketing_subscription_status":{"anyOf":[{"type":"string","enum":["requested","accepted","declined"]},{"type":"null"}]},"marketing_messages_this_month":{"type":"integer","minimum":0,"maximum":9007199254740991},"messages_this_month":{"type":"integer","minimum":0,"maximum":9007199254740991},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","contact_id","channel_type","health","transactional_opt_in","marketing_subscription_status","marketing_messages_this_month","messages_this_month","created_at","updated_at"]},"ContactAnalytics":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"campaign_messages_this_month":{"type":"integer","minimum":0,"maximum":9007199254740991},"review_request_message_count":{"type":"integer","minimum":0,"maximum":9007199254740991},"number_of_marketing_opt_in_requests":{"type":"integer","minimum":0,"maximum":9007199254740991},"last_review_rating":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}]},"last_interaction_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"last_outbound_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","contact_id","campaign_messages_this_month","review_request_message_count","number_of_marketing_opt_in_requests","last_review_rating","last_interaction_at","last_outbound_at","created_at","updated_at"]},"DealStatus":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"deal_type_id":{"type":"string","format":"uuid"},"idx":{"type":"integer","minimum":0,"maximum":9007199254740991},"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["in_progress","lost","open","won"]},"key":{"type":"string","minLength":1},"is_gallery":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","deal_type_id","idx","name","type","key","is_gallery","created_at","updated_at"]},"DealType":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string","minLength":1},"key":{"type":"string","minLength":1},"emoji":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_gallery":{"type":"boolean"},"gallery_key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","key","emoji","is_gallery","gallery_key","deleted_at","created_at","updated_at"]},"Sendout":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"campaign_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"template_id":{"type":"string","format":"uuid"},"mode":{"anyOf":[{"type":"string","enum":["broadcast","once","recurring"]},{"type":"null"}]},"require_marketing_opt_in":{"type":"boolean"},"send_after":{"type":"string","format":"date-time"},"placeholder_values":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"contacts":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/SendoutContact"}},{"type":"null"}]},"filter":{"anyOf":[{},{"type":"null"}]},"marketing_channel_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"review_channel_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"completed":{"type":"boolean"},"use_omni_channel_message":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","campaign_id","template_id","mode","require_marketing_opt_in","send_after","placeholder_values","contacts","filter","marketing_channel_id","review_channel_id","completed","use_omni_channel_message","created_at","updated_at"]},"SendoutContact":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"sms":{"anyOf":[{"type":"string"},{"type":"null"}]},"whatsapp":{"anyOf":[{"type":"string"},{"type":"null"}]},"instagram":{"anyOf":[{"type":"string"},{"type":"null"}]},"facebook":{"anyOf":[{"type":"string"},{"type":"null"}]},"google_business_messaging":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal":{"anyOf":[{"type":"string"},{"type":"null"}]},"placeholder_values":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}}},"Tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"color":{"type":"string"},"conversation_count":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","description","color","conversation_count","created_at","updated_at"]},"JourneyExecution":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"journey_id":{"type":"string","format":"uuid"},"journey_version_id":{"type":"string","format":"uuid"},"trigger_journey_node_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"started_at":{"type":"string","format":"date-time"},"backdated_started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"status":{"type":"string","enum":["aborted","active","completed","failed","rate_limited","stopped"]},"total_timetravel_seconds":{"anyOf":[{"type":"number"},{"type":"null"}]},"extra_context":{"anyOf":[{},{"type":"null"}]},"error":{"anyOf":[{},{"type":"null"}]},"failure_reason":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["id","organisation_id","journey_id","journey_version_id","trigger_journey_node_id","contact_id","started_at","backdated_started_at","completed_at","status","total_timetravel_seconds","extra_context","error","failure_reason"]},"ApiToken":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":255},"is_deprecated":{"type":"boolean"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","is_deprecated","organisation_id","created_at","updated_at"]},"ImportStatus":{"type":"string","enum":["pending","processing","completed","failed","unknown"]},"ImportFailure":{"type":"object","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1}},"required":["code","message"]},"CreateAppointmentBatchImport":{"type":"object","properties":{"file_id":{"type":"string","format":"uuid"},"payload":{"minItems":1,"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"allow_appointment_reassignment":{"default":false,"type":"boolean"}},"additionalProperties":false},"CreateContactBatchImport":{"type":"object","properties":{"file_id":{"type":"string","format":"uuid"},"payload":{"minItems":1,"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"contact_list_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_list_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"additionalProperties":false},"ContactListContact":{"type":"object","properties":{"contact_list_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"added_at":{"type":"string","format":"date-time"}},"required":["contact_list_id","contact_id","organisation_id","added_at"]},"ConversationEvent":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["conversation.assigned","conversation.unassigned","conversation.closed","conversation.reopened","conversation.inbox_changed","conversation.tag_added","conversation.tag_removed","message.received","message.submitted","message.sent","message.sending_failed","message.delivery_failed","message.submission_failed","message.read","comment.created","message_action.clicked"]},"created_at":{"type":"string","format":"date-time"},"conversation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["api_token","channel","comment","cs_agent","cs_agent_session","employee","form_submission","inbox","message","message_action","recipient","rule","service_role","tag","voice_call"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]}},"required":["type","id"]},{"type":"null"}]},"resource":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["api_token","channel","comment","cs_agent","cs_agent_session","employee","form_submission","inbox","message","message_action","recipient","rule","service_role","tag","voice_call"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]}},"required":["type","id"]},{"type":"null"}]},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["id","type","created_at","conversation_id","inbox_id","actor","resource","details"]},"ConversationTag":{"type":"object","properties":{"conversation_id":{"type":"string","format":"uuid"},"tag_id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["conversation_id","tag_id","organisation_id","inbox_id","created_at","updated_at"]},"CustomEntity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"custom_entity_definition_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"data":{},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","custom_entity_definition_id","contact_id","external_id","data","deleted_at","created_at","updated_at"]},"CustomEntityDefinitionJsonSchema":{"type":"object","additionalProperties":{}},"CustomEntityDefinition":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"key":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"schema":{"$ref":"#/components/schemas/CustomEntityDefinitionJsonSchema"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","key","name","schema","deleted_at","created_at","updated_at"]},"Deal":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string","enum":["CHF","EUR","USD"]},"won_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"lost_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","external_id","status_id","status_key","type_key","assignee_id","contact_id","value","currency","won_at","won_at_date","won_at_time","lost_at","lost_at_date","lost_at_time","deleted_at","created_at","updated_at"],"additionalProperties":{}},"CreateDealBatchImport":{"type":"object","properties":{"file_id":{"type":"string","format":"uuid"},"payload":{"minItems":1,"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"allow_deal_reassignment":{"default":false,"type":"boolean"}},"additionalProperties":false},"Location":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}]},"iso_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_default":{"type":"boolean"},"key":{"type":"string","minLength":1}},"required":["id","created_at","updated_at","organisation_id","name","street","postal_code","city","region","iso_country","address_line","deleted_at","external_id","is_default","key"]},"Webhook":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string","minLength":1},"active":{"type":"boolean"},"method":{"type":"string","enum":["GET","PATCH","POST","PUT"]},"target_url":{"type":"string"},"headers":{"$ref":"#/components/schemas/AnyJsonObject"},"event":{"type":"string","enum":["contact_details.updated","contact.created","contact.deleted","contact.updated","conversation.assign","conversation.close","conversation.inbound","conversation.outbound","conversation.reopen","conversation.sending_error","conversation.submission_error","conversation.tag","conversation.unassign","conversation.untag","form_submission.aborted","form_submission.completed"]},"fields":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1}},{"type":"null"}]},"source":{"type":"string","enum":["authenticated","make","n8n","zapier"]}},"required":["id","organisation_id","created_at","updated_at","name","active","method","target_url","headers","event","fields","source"]},"Appointment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"raw_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"start_time":{"type":"string","format":"date-time"},"start_time_date":{"type":"string","format":"date-time"},"start_time_time":{"type":"string","minLength":1},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"calendar_id":{"type":"string","format":"uuid","description":"Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used."},"scheduler_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","name","raw_description","external_id","status_id","status_key","type_key","assignee_id","contact_id","start_time","start_time_date","start_time_time","end_time","end_time_date","end_time_time","confirmed_at","confirmed_at_date","confirmed_at_time","cancelled_at","cancelled_at_date","cancelled_at_time","calendar_id","scheduler_id","event_id","deleted_at","created_at","updated_at"],"additionalProperties":{}},"ImportJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["appointment_details","contact_details","deal_details"]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"contact_list_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_list_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"allow_deal_reassignment":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"allow_appointment_reassignment":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/ImportStatus"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"total_count":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"success_count":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"failed_count":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"failure":{"anyOf":[{"$ref":"#/components/schemas/ImportFailure"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organisation_id","type","external_id","contact_list_id","contact_list_external_id","allow_deal_reassignment","allow_appointment_reassignment","status","started_at","completed_at","total_count","success_count","failed_count","failure","created_at","updated_at"]}}},"security":[{"bearerAuth":[]}],"paths":{"/v1/api-tokens":{"get":{"operationId":"api-token.list","summary":"List API Tokens","tags":["api-token"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiToken"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"is_deprecated","schema":{"type":"boolean"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/api-tokens/{id}":{"get":{"operationId":"api-token.get","summary":"Get API Token","tags":["api-token"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiToken"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/appointments":{"get":{"operationId":"appointment.list","summary":"List Appointments","tags":["appointment"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"raw_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"start_time":{"type":"string","format":"date-time"},"start_time_date":{"type":"string","format":"date-time"},"start_time_time":{"type":"string","minLength":1},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"calendar_id":{"type":"string","format":"uuid","description":"Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used."},"scheduler_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"status":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/AppointmentStatus"},{"type":"object","properties":{"appointment_type":{"anyOf":[{"$ref":"#/components/schemas/AppointmentType"},{"type":"null"}]}}}]},{"type":"null"}]},"assignee":{"anyOf":[{"$ref":"#/components/schemas/Employee"},{"type":"null"}]},"calendar":{"anyOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"null"}]},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Calendar"}},"scheduler":{"anyOf":[{"$ref":"#/components/schemas/AppointmentScheduler"},{"type":"null"}]}},"required":["id","organisation_id","name","raw_description","external_id","status_id","status_key","type_key","assignee_id","contact_id","start_time","start_time_date","start_time_time","end_time","end_time_date","end_time_time","confirmed_at","confirmed_at_date","confirmed_at_time","cancelled_at","cancelled_at_date","cancelled_at_time","calendar_id","scheduler_id","event_id","deleted_at","created_at","updated_at"],"additionalProperties":{}}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"contact[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"status_key","schema":{"type":"string"}},{"in":"query","name":"status_key[in]","schema":{"type":"string"}},{"in":"query","name":"type_key","schema":{"type":"string"}},{"in":"query","name":"type_key[in]","schema":{"type":"string"}},{"in":"query","name":"assignee","schema":{"type":"string"}},{"in":"query","name":"assignee[in]","schema":{"type":"string"}},{"in":"query","name":"assignee[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"assignee[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"start_time","schema":{"type":"string"}},{"in":"query","name":"start_time[neq]","schema":{"type":"string"}},{"in":"query","name":"start_time[gt]","schema":{"type":"string"}},{"in":"query","name":"start_time[gte]","schema":{"type":"string"}},{"in":"query","name":"start_time[lt]","schema":{"type":"string"}},{"in":"query","name":"start_time[lte]","schema":{"type":"string"}},{"in":"query","name":"end_time","schema":{"type":"string"}},{"in":"query","name":"end_time[neq]","schema":{"type":"string"}},{"in":"query","name":"end_time[gt]","schema":{"type":"string"}},{"in":"query","name":"end_time[gte]","schema":{"type":"string"}},{"in":"query","name":"end_time[lt]","schema":{"type":"string"}},{"in":"query","name":"end_time[lte]","schema":{"type":"string"}},{"in":"query","name":"end_time[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"end_time[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"confirmed_at","schema":{"type":"string"}},{"in":"query","name":"confirmed_at[neq]","schema":{"type":"string"}},{"in":"query","name":"confirmed_at[gt]","schema":{"type":"string"}},{"in":"query","name":"confirmed_at[gte]","schema":{"type":"string"}},{"in":"query","name":"confirmed_at[lt]","schema":{"type":"string"}},{"in":"query","name":"confirmed_at[lte]","schema":{"type":"string"}},{"in":"query","name":"confirmed_at[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"confirmed_at[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"cancelled_at","schema":{"type":"string"}},{"in":"query","name":"cancelled_at[neq]","schema":{"type":"string"}},{"in":"query","name":"cancelled_at[gt]","schema":{"type":"string"}},{"in":"query","name":"cancelled_at[gte]","schema":{"type":"string"}},{"in":"query","name":"cancelled_at[lt]","schema":{"type":"string"}},{"in":"query","name":"cancelled_at[lte]","schema":{"type":"string"}},{"in":"query","name":"cancelled_at[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"cancelled_at[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","status","status.appointment_type","assignee","calendar","participants","scheduler"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}]},"post":{"operationId":"appointment.create","summary":"Create Appointment","tags":["appointment"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}}},"parameters":[{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"raw_description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"start_time":{"type":"string","format":"date-time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"calendar_id":{"type":"string","format":"uuid","description":"Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used."},"scheduler_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"calendars":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name","contact_id","start_time"],"additionalProperties":{}}}}}}},"/v1/appointments/imports/batch":{"post":{"operationId":"appointment.import.createBatch","summary":"Create Appointment Batch Import","tags":["import"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}},"413":{"description":"Payload Too Large"},"415":{"description":"Unsupported Media Type"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAppointmentBatchImport"}}}}}},"/v1/appointments/imports":{"get":{"operationId":"appointment.import.list","summary":"List Appointment Imports","tags":["import"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ImportJob"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"external_id[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"external_id[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/appointments/imports/{id}":{"get":{"operationId":"appointment.import.get","summary":"Get Appointment Import","tags":["import"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/appointments/by":{"get":{"operationId":"appointment.get-by-locator","summary":"Get Appointment By Locator","tags":["appointment"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"raw_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"start_time":{"type":"string","format":"date-time"},"start_time_date":{"type":"string","format":"date-time"},"start_time_time":{"type":"string","minLength":1},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"calendar_id":{"type":"string","format":"uuid","description":"Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used."},"scheduler_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"status":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/AppointmentStatus"},{"type":"object","properties":{"appointment_type":{"anyOf":[{"$ref":"#/components/schemas/AppointmentType"},{"type":"null"}]}}}]},{"type":"null"}]},"assignee":{"anyOf":[{"$ref":"#/components/schemas/Employee"},{"type":"null"}]},"calendar":{"anyOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"null"}]},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Calendar"}},"scheduler":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/AppointmentScheduler"},{"type":"object","properties":{"appointment_type":{"anyOf":[{"$ref":"#/components/schemas/AppointmentType"},{"type":"null"}]}}}]},{"type":"null"}]}},"required":["id","organisation_id","name","raw_description","external_id","status_id","status_key","type_key","assignee_id","contact_id","start_time","start_time_date","start_time_time","end_time","end_time_date","end_time_time","confirmed_at","confirmed_at_date","confirmed_at_time","cancelled_at","cancelled_at_date","cancelled_at_time","calendar_id","scheduler_id","event_id","deleted_at","created_at","updated_at"],"additionalProperties":{}}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","status","status.appointment_type","assignee","calendar","participants","scheduler","scheduler.appointment_type"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"patch":{"operationId":"appointment.update-by-locator","summary":"Update Appointment By Locator","tags":["appointment"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"raw_description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"start_time":{"type":"string","format":"date-time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"calendar_id":{"type":"string","format":"uuid","description":"Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used."},"scheduler_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"calendars":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":{}}}}}},"delete":{"operationId":"appointment.delete-by-locator","summary":"Delete Appointment By Locator","tags":["appointment"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}]}},"/v1/appointments/{id}":{"get":{"operationId":"appointment.get","summary":"Get Appointment","tags":["appointment"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"raw_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"start_time":{"type":"string","format":"date-time"},"start_time_date":{"type":"string","format":"date-time"},"start_time_time":{"type":"string","minLength":1},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"end_time_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"calendar_id":{"type":"string","format":"uuid","description":"Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used."},"scheduler_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"status":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/AppointmentStatus"},{"type":"object","properties":{"appointment_type":{"anyOf":[{"$ref":"#/components/schemas/AppointmentType"},{"type":"null"}]}}}]},{"type":"null"}]},"assignee":{"anyOf":[{"$ref":"#/components/schemas/Employee"},{"type":"null"}]},"calendar":{"anyOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"null"}]},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Calendar"}},"scheduler":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/AppointmentScheduler"},{"type":"object","properties":{"appointment_type":{"anyOf":[{"$ref":"#/components/schemas/AppointmentType"},{"type":"null"}]}}}]},{"type":"null"}]}},"required":["id","organisation_id","name","raw_description","external_id","status_id","status_key","type_key","assignee_id","contact_id","start_time","start_time_date","start_time_time","end_time","end_time_date","end_time_time","confirmed_at","confirmed_at_date","confirmed_at_time","cancelled_at","cancelled_at_date","cancelled_at_time","calendar_id","scheduler_id","event_id","deleted_at","created_at","updated_at"],"additionalProperties":{}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","status","status.appointment_type","assignee","calendar","participants","scheduler","scheduler.appointment_type"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}]},"patch":{"operationId":"appointment.update","summary":"Update Appointment","tags":["appointment"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"raw_description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"start_time":{"type":"string","format":"date-time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"calendar_id":{"type":"string","format":"uuid","description":"Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used."},"scheduler_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"calendars":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":{}}}}}},"delete":{"operationId":"appointment.delete","summary":"Delete Appointment","tags":["appointment"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/appointment-types":{"get":{"operationId":"appointment-type.list","summary":"List Appointment Types","tags":["appointment-type"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentType"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"scheduling_enabled","schema":{"type":"boolean"}},{"in":"query","name":"status_type","schema":{"type":"string"}},{"in":"query","name":"status_type[in]","schema":{"type":"string"}},{"in":"query","name":"status_key","schema":{"type":"string"}},{"in":"query","name":"status_key[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses","availability_config","time_slots","calendar_resources"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"post":{"operationId":"appointment-type.create","summary":"Create Appointment Type","tags":["appointment-type"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}}}},"parameters":[{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"key":{"type":"string","minLength":1},"emoji":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_gallery":{"type":"boolean"},"gallery_key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"statuses":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["cancelled","confirmed","pending"]},"key":{"type":"string","minLength":1},"idx":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","type"]}}},"required":["name"]}}}}}},"/v1/appointment-types/{id}":{"get":{"operationId":"appointment-type.get","summary":"Get Appointment Type","tags":["appointment-type"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses","availability_config","time_slots","calendar_resources"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"patch":{"operationId":"appointment-type.update","summary":"Update Appointment Type","tags":["appointment-type"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"emoji":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"statuses":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["cancelled","confirmed","pending"]},"key":{"type":"string","minLength":1},"idx":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","type"]}}}}}}}},"delete":{"operationId":"appointment-type.delete","summary":"Delete Appointment Type","tags":["appointment-type"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/appointment-types/{id}/duplicate":{"post":{"operationId":"appointment-type.duplicate","summary":"Duplicate Appointment Type","tags":["appointment-type"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1}}}}}}}},"/v1/calendars":{"get":{"operationId":"calendar.list","summary":"List Calendars","tags":["scheduling","calendar"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"object","properties":{"calendar_resource":{"anyOf":[{"$ref":"#/components/schemas/CalendarResource"},{"type":"null"}]},"provider":{"anyOf":[{"$ref":"#/components/schemas/Provider"},{"type":"null"}]}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"calendarResource","schema":{"type":"string"}},{"in":"query","name":"calendarResource[in]","schema":{"type":"string"}},{"in":"query","name":"provider","schema":{"type":"string"}},{"in":"query","name":"provider[in]","schema":{"type":"string"}},{"in":"query","name":"is_default","schema":{"type":"boolean"}},{"in":"query","name":"scheduling_enabled","schema":{"type":"boolean"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["calendar_resource","provider"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"post":{"operationId":"calendar.create","summary":"Create Calendar","tags":["scheduling","calendar"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calendar"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["provider","virtual"]},"scheduling_enabled":{"type":"boolean"},"calendar_resource_id":{"type":"string","format":"uuid"},"provider_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["name","type","calendar_resource_id"]}}}}}},"/v1/calendars/{calendar_id}/blocked-times":{"get":{"operationId":"calendar-blocked-time.list","summary":"List Calendar Blocked Times","tags":["scheduling","calendar-blocked-time"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/CalendarBlockedTime"},{"type":"object","properties":{"calendar":{"anyOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"null"}]}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"path","name":"calendar_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"start_at","schema":{"type":"string"}},{"in":"query","name":"start_at[neq]","schema":{"type":"string"}},{"in":"query","name":"start_at[gt]","schema":{"type":"string"}},{"in":"query","name":"start_at[gte]","schema":{"type":"string"}},{"in":"query","name":"start_at[lt]","schema":{"type":"string"}},{"in":"query","name":"start_at[lte]","schema":{"type":"string"}},{"in":"query","name":"end_at","schema":{"type":"string"}},{"in":"query","name":"end_at[neq]","schema":{"type":"string"}},{"in":"query","name":"end_at[gt]","schema":{"type":"string"}},{"in":"query","name":"end_at[gte]","schema":{"type":"string"}},{"in":"query","name":"end_at[lt]","schema":{"type":"string"}},{"in":"query","name":"end_at[lte]","schema":{"type":"string"}},{"in":"query","name":"window_start","schema":{"type":"string"}},{"in":"query","name":"window_end","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["calendar"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"post":{"operationId":"calendar-blocked-time.create","summary":"Create Calendar Blocked Time","tags":["scheduling","calendar-blocked-time"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockedTime"}}}}},"parameters":[{"in":"path","name":"calendar_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_all_day":{"type":"boolean"},"start_at":{"type":"string","format":"date-time"},"end_at":{"type":"string","format":"date-time"},"recurrence_rule":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"series_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"replaces_occurrence_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["start_at","end_at"]}}}}}},"/v1/calendars/{calendar_id}/blocked-times/{id}":{"patch":{"operationId":"calendar-blocked-time.update","summary":"Update Calendar Blocked Time","tags":["scheduling","calendar-blocked-time"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockedTime"}}}}},"parameters":[{"in":"path","name":"calendar_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_all_day":{"type":"boolean"},"start_at":{"type":"string","format":"date-time"},"end_at":{"type":"string","format":"date-time"},"recurrence_rule":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"series_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"replaces_occurrence_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}}}}},"delete":{"operationId":"calendar-blocked-time.delete","summary":"Delete Calendar Blocked Time","tags":["scheduling","calendar-blocked-time"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"calendar_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/calendars/{id}":{"get":{"operationId":"calendar.get","summary":"Get Calendar","tags":["scheduling","calendar"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"object","properties":{"calendar_resource":{"anyOf":[{"$ref":"#/components/schemas/CalendarResource"},{"type":"null"}]},"provider":{"anyOf":[{"$ref":"#/components/schemas/Provider"},{"type":"null"}]}}}]}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["calendar_resource","provider"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"patch":{"operationId":"calendar.update","summary":"Update Calendar","tags":["scheduling","calendar"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calendar"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"scheduling_enabled":{"type":"boolean"},"calendar_resource_id":{"type":"string","format":"uuid"}}}}}}},"delete":{"operationId":"calendar.delete","summary":"Delete Calendar","tags":["scheduling","calendar"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/channels":{"get":{"operationId":"public.messaging.channel.list","summary":"List Channels","tags":["messaging","channel"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"type[in]","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/channels/{id}":{"get":{"operationId":"public.messaging.channel.getById","summary":"Get Channel by ID","tags":["messaging","channel"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/contacts":{"get":{"operationId":"contact.list","summary":"List Contacts","tags":["contact"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"salutation":{"anyOf":[{"type":"string"},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_blocked":{"type":"boolean"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ContactIdentity"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/ContactChannel"}},"analytics":{"$ref":"#/components/schemas/ContactAnalytics"}},"required":["id","display_name","full_name","salutation","birthday","description","external_id","secondary_external_id","address_line1","address_line2","city","zipcode","country","is_blocked","organisation_id","created_at","updated_at"],"additionalProperties":{}}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"full_name","schema":{"type":"string"}},{"in":"query","name":"full_name[neq]","schema":{"type":"string"}},{"in":"query","name":"full_name[in]","schema":{"type":"string"}},{"in":"query","name":"full_name[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"full_name[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"external_id[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"external_id[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"updated_at","schema":{"type":"string"}},{"in":"query","name":"updated_at[gte]","schema":{"type":"string"}},{"in":"query","name":"updated_at[lte]","schema":{"type":"string"}},{"in":"query","name":"updated_at[gt]","schema":{"type":"string"}},{"in":"query","name":"updated_at[lt]","schema":{"type":"string"}},{"in":"query","name":"and_entity_filter","schema":{"type":"string"}},{"in":"query","name":"include_filter","schema":{"type":"string"}},{"in":"query","name":"exclude_filter","schema":{"type":"string"}},{"in":"query","name":"segment[in]","schema":{"type":"string"}},{"in":"query","name":"segment[not_in]","schema":{"type":"string"}},{"in":"query","name":"contact_list[in]","schema":{"type":"string"}},{"in":"query","name":"contact_list[not_in]","schema":{"type":"string"}},{"in":"query","name":"include_contacts","schema":{"type":"string"}},{"in":"query","name":"exclude_contacts","schema":{"type":"string"}},{"in":"query","name":"channel_types[in]","schema":{"type":"string"}},{"in":"query","name":"include_blocked","schema":{"type":"boolean"}},{"in":"query","name":"require_marketing_opt_in","schema":{"type":"boolean"}},{"in":"query","name":"require_transactional_opt_in","schema":{"type":"boolean"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["identities","channels","analytics"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}]},"post":{"operationId":"contact.create","summary":"Create Contact","tags":["contact"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}},"parameters":[{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"city":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"country":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"additionalProperties":{}}}}}}},"/v1/contacts/imports/batch":{"post":{"operationId":"contact.import.createBatch","summary":"Create Contact Batch Import","tags":["import"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}},"413":{"description":"Payload Too Large"},"415":{"description":"Unsupported Media Type"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactBatchImport"}}}}}},"/v1/contacts/imports":{"get":{"operationId":"contact.import.list","summary":"List Contact Imports","tags":["import"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ImportJob"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"external_id[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"external_id[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/contacts/imports/{id}":{"get":{"operationId":"contact.import.get","summary":"Get Contact Import","tags":["import"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/contacts/by":{"patch":{"operationId":"contact.updateByLocator","summary":"Update Contact by Locator","tags":["contact"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}},"parameters":[{"in":"query","name":"external_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"secondary_external_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"channel_type","schema":{"anyOf":[{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},{"type":"null"}]}},{"in":"query","name":"type","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"value","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"scope_type","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"scope_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"salutation":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"city":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"country":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"additionalProperties":{}}}}}},"get":{"operationId":"contact.get-by-locator","summary":"Get Contact by Locator","tags":["contact"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"salutation":{"anyOf":[{"type":"string"},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_blocked":{"type":"boolean"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ContactIdentity"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/ContactChannel"}},"analytics":{"$ref":"#/components/schemas/ContactAnalytics"}},"required":["id","display_name","full_name","salutation","birthday","description","external_id","secondary_external_id","address_line1","address_line2","city","zipcode","country","is_blocked","organisation_id","created_at","updated_at"],"additionalProperties":{}}}}}},"parameters":[{"in":"query","name":"external_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"secondary_external_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"channel_type","schema":{"anyOf":[{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},{"type":"null"}]}},{"in":"query","name":"type","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"value","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"scope_type","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"scope_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["identities","channels","analytics"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"delete":{"operationId":"contact.deleteByLocator","summary":"Delete Contact by Locator","tags":["contact"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"query","name":"external_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"secondary_external_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"channel_type","schema":{"anyOf":[{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},{"type":"null"}]}},{"in":"query","name":"type","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"value","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"scope_type","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"scope_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}]}},"/v1/contacts/{id}/identities":{"post":{"operationId":"contact.identity.upsert","summary":"Upsert Contact Identity","tags":["contact"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactIdentity"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel_type":{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1},"scope_type":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"scope_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["channel_type","type","value"]}}}}}},"/v1/contacts/{id}/channels/{channel_type}":{"patch":{"operationId":"contact.channel.updateState","summary":"Update Contact Channel State","tags":["contact"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactChannel"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"channel_type","schema":{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"health":{"type":"string","enum":["healthy","unhealthy","unknown"]},"transactional_opt_in":{"anyOf":[{"type":"string","enum":["consent_granted","contract_fulfillment","legitimate_interest"]},{"type":"null"}]},"marketing_subscription_status":{"anyOf":[{"type":"string","enum":["accepted"]},{"type":"null"}]},"marketing_messages_this_month":{"type":"integer","minimum":0,"maximum":32767},"messages_this_month":{"type":"integer","minimum":0,"maximum":32767}}}}}}}},"/v1/contacts/{id}/identities/by":{"delete":{"operationId":"contact.identity.deleteByLocator","summary":"Delete Contact Identity by Locator","tags":["contact"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"channel_type","schema":{"type":"string","enum":["email","facebook","instagram","postal","sms","whatsapp"]},"required":true},{"in":"query","name":"type","schema":{"type":"string","minLength":1},"required":true},{"in":"query","name":"value","schema":{"type":"string","minLength":1},"required":true},{"in":"query","name":"scope_type","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"in":"query","name":"scope_id","schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}]}},"/v1/contacts/{contact_id}/subscriptions/{opt_in_group_id}/{channel_type}/subscribe":{"post":{"operationId":"contact.subscription.subscribe","summary":"Subscribe Contact","tags":["subscription"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}}},"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"opt_in_group_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"channel_type","schema":{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]},"required":true}]}},"/v1/contacts/{contact_id}/subscriptions/{opt_in_group_id}/{channel_type}/unsubscribe":{"post":{"operationId":"contact.subscription.unsubscribe","summary":"Unsubscribe Contact Subscription","tags":["subscription"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}}},"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"opt_in_group_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"channel_type","schema":{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]},"required":true}]}},"/v1/contacts/{contact_id}/subscriptions/unsubscribe":{"post":{"operationId":"contact.subscription.unsubscribe-matching","summary":"Unsubscribe Matching Contact Subscriptions","tags":["subscription"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}}}},"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opt_in_group_id":{"type":"string","format":"uuid"},"channel_type":{"type":"string","enum":["email","facebook","google_business_messaging","instagram","postal","sms","whatsapp"]}}}}}}}},"/v1/contacts/{id}":{"get":{"operationId":"contact.get","summary":"Get Contact","tags":["contact"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"salutation":{"anyOf":[{"type":"string"},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_blocked":{"type":"boolean"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ContactIdentity"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/ContactChannel"}},"analytics":{"$ref":"#/components/schemas/ContactAnalytics"}},"required":["id","display_name","full_name","salutation","birthday","description","external_id","secondary_external_id","address_line1","address_line2","city","zipcode","country","is_blocked","organisation_id","created_at","updated_at"],"additionalProperties":{}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["identities","channels","analytics"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}]},"patch":{"operationId":"contact.update","summary":"Update Contact","tags":["contact"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"salutation":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"city":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"country":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"additionalProperties":{}}}}}},"delete":{"operationId":"contact.delete","summary":"Delete Contact","tags":["contact"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/contacts/{id}/merge":{"post":{"operationId":"contact.merge","summary":"Merge Contacts","tags":["contact"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from_id":{"type":"string","format":"uuid"}},"required":["from_id"]}}}}}},"/v1/contacts/{id}/contact-lists":{"put":{"operationId":"contact.contact-lists.sync","summary":"Sync Contact List Memberships","tags":["contact"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contact_lists":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["contact_lists"]}}}}}},"/v1/contact-lists":{"get":{"operationId":"contact-list.list","summary":"List Contact Lists","tags":["contact-list"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactList"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"id[not_in]","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name[neq]","schema":{"type":"string"}},{"in":"query","name":"name[in]","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[neq]","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"external_id[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"external_id[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"updated_at","schema":{"type":"string"}},{"in":"query","name":"updated_at[gte]","schema":{"type":"string"}},{"in":"query","name":"updated_at[lte]","schema":{"type":"string"}},{"in":"query","name":"updated_at[gt]","schema":{"type":"string"}},{"in":"query","name":"updated_at[lt]","schema":{"type":"string"}},{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"contact[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]},"post":{"operationId":"contact-list.create","summary":"Create Contact List","tags":["contact-list"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["name"]}}}}}},"/v1/contact-lists/by":{"get":{"operationId":"contact-list.get-by-locator","summary":"Get Contact List by Locator","tags":["contact-list"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}]},"patch":{"operationId":"contact-list.update-by-locator","summary":"Update Contact List by Locator","tags":["contact-list"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}}}}},"delete":{"operationId":"contact-list.delete-by-locator","summary":"Delete Contact List by Locator","tags":["contact-list"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}]}},"/v1/contact-lists/by/contacts/clear":{"post":{"operationId":"contact-list.contacts.clear-by-locator","summary":"Clear Contact List Contacts by Locator","tags":["contact-list"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}]}},"/v1/contact-lists/{id}":{"get":{"operationId":"contact-list.get","summary":"Get Contact List","tags":["contact-list"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]},"patch":{"operationId":"contact-list.update","summary":"Update Contact List","tags":["contact-list"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}}}}},"delete":{"operationId":"contact-list.delete","summary":"Delete Contact List","tags":["contact-list"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/contact-lists/{id}/contacts":{"get":{"operationId":"contact-list.contacts","summary":"List Contact List Contacts","tags":["contact-list"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"salutation":{"anyOf":[{"type":"string"},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_blocked":{"type":"boolean"},"organisation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"added_at":{"type":"string","format":"date-time"},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ContactIdentity"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/ContactChannel"}},"analytics":{"$ref":"#/components/schemas/ContactAnalytics"}},"required":["id","display_name","full_name","salutation","birthday","description","external_id","secondary_external_id","address_line1","address_line2","city","zipcode","country","is_blocked","organisation_id","created_at","updated_at","added_at"],"additionalProperties":{}}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"is_blocked","schema":{"type":"boolean"}},{"in":"query","name":"include_blocked","schema":{"type":"boolean"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["identities","channels","analytics"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/contact-lists/{id}/contacts/clear":{"post":{"operationId":"contact-list.contacts.clear","summary":"Clear Contact List Contacts","tags":["contact-list"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/contact-lists/{id}/contacts/batch":{"post":{"operationId":"contact-list.contacts.add-batch","summary":"Add Contacts to List","tags":["contact-list"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contact_ids":{"minItems":1,"type":"array","items":{"type":"string","format":"uuid"}}},"required":["contact_ids"]}}}}}},"/v1/contact-lists/{id}/contacts/{contact_id}":{"post":{"operationId":"contact-list.contacts.add","summary":"Add Contact to List","tags":["contact-list"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactListContact"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"contact_id","schema":{"type":"string","format":"uuid"},"required":true}]},"delete":{"operationId":"contact-list.contacts.remove","summary":"Remove Contact from List","tags":["contact-list"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"contact_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/conversation-events":{"get":{"operationId":"public.messaging.conversationEvent.list","summary":"List Conversation Events","tags":["messaging","conversation-event"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationEvent"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"conversation","schema":{"type":"string"}},{"in":"query","name":"inbox","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"type[in]","schema":{"type":"string"}},{"in":"query","name":"created_at[gt]","schema":{"type":"string"}},{"in":"query","name":"created_at[gte]","schema":{"type":"string"}},{"in":"query","name":"created_at[lt]","schema":{"type":"string"}},{"in":"query","name":"created_at[lte]","schema":{"type":"string"}},{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"actor_type","schema":{"type":"string"}},{"in":"query","name":"actor","schema":{"type":"string"}},{"in":"query","name":"resource_type","schema":{"type":"string"}},{"in":"query","name":"resource","schema":{"type":"string"}},{"in":"query","name":"resource[neq]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/conversation-events/{event_id}":{"get":{"operationId":"public.messaging.conversationEvent.get","summary":"Get Conversation Event","tags":["messaging","conversation-event"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationEvent"}}}}},"parameters":[{"in":"path","name":"event_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/conversations":{"get":{"operationId":"public.messaging.conversation.list","summary":"List Conversations","tags":["messaging","conversation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Conversation"},{"type":"object","properties":{"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"inbox":{"anyOf":[{"$ref":"#/components/schemas/Inbox"},{"type":"null"}]},"channel":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/Channel"},{"type":"object","properties":{"provider":{"anyOf":[{"$ref":"#/components/schemas/Provider"},{"type":"null"}]}}}]},{"type":"null"}]},"latest_inbound_message":{"anyOf":[{"$ref":"#/components/schemas/Message"},{"type":"null"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"}}}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"inbox","schema":{"type":"string"}},{"in":"query","name":"inbox[in]","schema":{"type":"string"}},{"in":"query","name":"channel","schema":{"type":"string"}},{"in":"query","name":"channel[in]","schema":{"type":"string"}},{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"contact_external_id","schema":{"type":"string"}},{"in":"query","name":"tag","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"channel_type","schema":{"type":"string"}},{"in":"query","name":"channel_type[in]","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"is_spam","schema":{"type":"boolean"}},{"in":"query","name":"unread","schema":{"type":"boolean"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","inbox","channel","channel.provider","latest_inbound_message","tags"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/conversations/{conversation_id}":{"get":{"operationId":"public.messaging.conversation.get","summary":"Get Conversation","tags":["messaging","conversation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Conversation"},{"type":"object","properties":{"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"latest_inbound_message":{"anyOf":[{"$ref":"#/components/schemas/Message"},{"type":"null"}]},"channel":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/Channel"},{"type":"object","properties":{"provider":{"anyOf":[{"$ref":"#/components/schemas/Provider"},{"type":"null"}]}}}]},{"type":"null"}]}}}],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"}}}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","latest_inbound_message","channel","channel.provider"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/conversations/{conversation_id}/events":{"get":{"operationId":"public.messaging.conversation.events.list","summary":"List Conversation Events","tags":["messaging","conversation-event"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationEvent"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"inbox","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"type[in]","schema":{"type":"string"}},{"in":"query","name":"created_at[gt]","schema":{"type":"string"}},{"in":"query","name":"created_at[gte]","schema":{"type":"string"}},{"in":"query","name":"created_at[lt]","schema":{"type":"string"}},{"in":"query","name":"created_at[lte]","schema":{"type":"string"}},{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"actor_type","schema":{"type":"string"}},{"in":"query","name":"actor","schema":{"type":"string"}},{"in":"query","name":"resource_type","schema":{"type":"string"}},{"in":"query","name":"resource","schema":{"type":"string"}},{"in":"query","name":"resource[neq]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/conversations/{conversation_id}/assign":{"post":{"operationId":"public.messaging.conversation.assign","summary":"Assign Conversation","tags":["messaging","conversation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["employee","cs_agent"]},"assignee_id":{"type":"string","format":"uuid"}},"required":["type","assignee_id"]}}}}}},"/v1/conversations/{conversation_id}/unassign":{"post":{"operationId":"public.messaging.conversation.unassign","summary":"Unassign Conversation","tags":["messaging","conversation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/conversations/{conversation_id}/move":{"post":{"operationId":"public.messaging.conversation.move","summary":"Move Conversation","tags":["messaging","conversation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inbox_id":{"type":"string","format":"uuid"}},"required":["inbox_id"]}}}}}},"/v1/conversations/{conversation_id}/open":{"post":{"operationId":"public.messaging.conversation.open","summary":"Open Conversation","tags":["messaging","conversation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/conversations/{conversation_id}/close":{"post":{"operationId":"public.messaging.conversation.close","summary":"Close Conversation","tags":["messaging","conversation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/conversations/{conversation_id}/tags/{tag_id}":{"put":{"operationId":"public.messaging.conversation.tag","summary":"Tag Conversation","tags":["messaging","conversation"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationTag"}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"tag_id","schema":{"type":"string","format":"uuid"},"required":true}]},"delete":{"operationId":"public.messaging.conversation.untag","summary":"Untag Conversation","tags":["messaging","conversation"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"tag_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/conversations/{conversation_id}/comments":{"get":{"operationId":"public.messaging.conversation.comment.list","summary":"List Conversation Comments","tags":["messaging","comment"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"}}}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]},"post":{"operationId":"public.messaging.conversation.comment.create","summary":"Create Comment","tags":["messaging","comment"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"}}}}},"parameters":[{"in":"path","name":"conversation_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"author_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"text":{"type":"string","minLength":1}},"required":["text"]}}}}}},"/v1/custom-entities":{"get":{"operationId":"custom-entity.list","summary":"List Custom Entities","tags":["custom-entities","custom-entity"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomEntity"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"custom_entity_definition","schema":{"type":"string"}},{"in":"query","name":"custom_entity_definition[in]","schema":{"type":"string"}},{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"contact[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"external_id[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"external_id[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"custom_entity_definition_key","schema":{"type":"string"}},{"in":"query","name":"custom_entity_definition_key[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]},"post":{"operationId":"custom-entity.create","summary":"Create Custom Entity","tags":["custom-entities","custom-entity"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntity"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_entity_definition_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"data":{},"custom_entity_definition_key":{"type":"string","minLength":1}},"required":["contact_id"]}}}}}},"/v1/custom-entities/by":{"get":{"operationId":"custom-entity.get-by-locator","summary":"Get Custom Entity By Locator","tags":["custom-entities","custom-entity"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntity"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"custom_entity_definition","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"custom_entity_definition_key","schema":{"type":"string","minLength":1}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}]},"patch":{"operationId":"custom-entity.update-by-locator","summary":"Update Custom Entity By Locator","tags":["custom-entities","custom-entity"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntity"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"custom_entity_definition","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"custom_entity_definition_key","schema":{"type":"string","minLength":1}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_entity_definition_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"data":{},"custom_entity_definition_key":{"type":"string","minLength":1}}}}}}},"delete":{"operationId":"custom-entity.delete-by-locator","summary":"Delete Custom Entity By Locator","tags":["custom-entities","custom-entity"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"custom_entity_definition","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"custom_entity_definition_key","schema":{"type":"string","minLength":1}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}]}},"/v1/custom-entities/{id}":{"get":{"operationId":"custom-entity.get","summary":"Get Custom Entity","tags":["custom-entities","custom-entity"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntity"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]},"patch":{"operationId":"custom-entity.update","summary":"Update Custom Entity","tags":["custom-entities","custom-entity"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntity"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_entity_definition_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"data":{},"custom_entity_definition_key":{"type":"string","minLength":1}}}}}}},"delete":{"operationId":"custom-entity.delete","summary":"Delete Custom Entity","tags":["custom-entities","custom-entity"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/custom-entity-definitions":{"get":{"operationId":"custom-entity-definition.list","summary":"List Custom Entity Definitions","tags":["custom-entities","custom-entity-definition"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomEntityDefinition"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]},"post":{"operationId":"custom-entity-definition.create","summary":"Create Custom Entity Definition","tags":["custom-entities","custom-entity-definition"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntityDefinition"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"schema":{"$ref":"#/components/schemas/CustomEntityDefinitionJsonSchema"}},"required":["key","name","schema"]}}}}}},"/v1/custom-entity-definitions/by":{"get":{"operationId":"custom-entity-definition.get-by-locator","summary":"Get Custom Entity Definition By Locator","tags":["custom-entities","custom-entity-definition"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntityDefinition"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"key","schema":{"type":"string","minLength":1}}]},"patch":{"operationId":"custom-entity-definition.update-by-locator","summary":"Update Custom Entity Definition By Locator","tags":["custom-entities","custom-entity-definition"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntityDefinition"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"key","schema":{"type":"string","minLength":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"schema":{"$ref":"#/components/schemas/CustomEntityDefinitionJsonSchema"}}}}}}},"delete":{"operationId":"custom-entity-definition.delete-by-locator","summary":"Delete Custom Entity Definition By Locator","tags":["custom-entities","custom-entity-definition"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"key","schema":{"type":"string","minLength":1}}]}},"/v1/custom-entity-definitions/{id}":{"get":{"operationId":"custom-entity-definition.get","summary":"Get Custom Entity Definition","tags":["custom-entities","custom-entity-definition"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntityDefinition"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]},"patch":{"operationId":"custom-entity-definition.update","summary":"Update Custom Entity Definition","tags":["custom-entities","custom-entity-definition"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomEntityDefinition"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"schema":{"$ref":"#/components/schemas/CustomEntityDefinitionJsonSchema"}}}}}}},"delete":{"operationId":"custom-entity-definition.delete","summary":"Delete Custom Entity Definition","tags":["custom-entities","custom-entity-definition"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/custom-fields":{"get":{"operationId":"custom-field.list","summary":"List Custom Fields","tags":["custom-field"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"entity","schema":{"type":"string"}},{"in":"query","name":"entity[in]","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"type[in]","schema":{"type":"string"}},{"in":"query","name":"show_in_sidebar","schema":{"type":"boolean"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]},"post":{"operationId":"custom-field.create","summary":"Create Custom Field","tags":["custom-field"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["boolean","date","datetime","number","string","string_list"]},"key":{"type":"string","minLength":1},"options":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","minLength":1}},{"type":"null"}]},"hidden":{"type":"boolean"},"show_in_sidebar":{"type":"boolean"},"entity":{"type":"string","enum":["appointment","contact","deal"]},"is_select":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["name","type","key"]}}}}}},"/v1/custom-fields/{id}":{"get":{"operationId":"custom-field.get","summary":"Get Custom Field","tags":["custom-field"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]},"patch":{"operationId":"custom-field.update","summary":"Update Custom Field","tags":["custom-field"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["boolean","date","datetime","number","string","string_list"]},"key":{"type":"string","minLength":1},"options":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","minLength":1}},{"type":"null"}]},"hidden":{"type":"boolean"},"show_in_sidebar":{"type":"boolean"},"entity":{"type":"string","enum":["appointment","contact","deal"]},"is_select":{"anyOf":[{"type":"boolean"},{"type":"null"}]}}}}}}},"delete":{"operationId":"custom-field.delete","summary":"Delete Custom Field","tags":["custom-field"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/deals":{"get":{"operationId":"deal.list","summary":"List Deals","tags":["deal"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string","enum":["CHF","EUR","USD"]},"won_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"lost_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"status":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/DealStatus"},{"type":"object","properties":{"deal_type":{"anyOf":[{"$ref":"#/components/schemas/DealType"},{"type":"null"}]}}}]},{"type":"null"}]},"assignee":{"anyOf":[{"$ref":"#/components/schemas/Employee"},{"type":"null"}]}},"required":["id","organisation_id","name","external_id","status_id","status_key","type_key","assignee_id","contact_id","value","currency","won_at","won_at_date","won_at_time","lost_at","lost_at_date","lost_at_time","deleted_at","created_at","updated_at"],"additionalProperties":{}}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"contact[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"status_key","schema":{"type":"string"}},{"in":"query","name":"status_key[in]","schema":{"type":"string"}},{"in":"query","name":"type_key","schema":{"type":"string"}},{"in":"query","name":"type_key[in]","schema":{"type":"string"}},{"in":"query","name":"assignee","schema":{"type":"string"}},{"in":"query","name":"assignee[in]","schema":{"type":"string"}},{"in":"query","name":"assignee[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"assignee[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"value","schema":{"type":"string"}},{"in":"query","name":"value[gt]","schema":{"type":"string"}},{"in":"query","name":"value[gte]","schema":{"type":"string"}},{"in":"query","name":"value[lt]","schema":{"type":"string"}},{"in":"query","name":"value[lte]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","status","status.deal_type","assignee"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}]},"post":{"operationId":"deal.create","summary":"Create Deal","tags":["deal"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}}},"parameters":[{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"currency":{"type":"string","enum":["CHF","EUR","USD"]},"won_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"required":["name","contact_id"],"additionalProperties":{}}}}}}},"/v1/deals/imports/batch":{"post":{"operationId":"deal.import.createBatch","summary":"Create Deal Batch Import","tags":["import"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}},"413":{"description":"Payload Too Large"},"415":{"description":"Unsupported Media Type"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDealBatchImport"}}}}}},"/v1/deals/imports":{"get":{"operationId":"deal.import.list","summary":"List Deal Imports","tags":["import"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ImportJob"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"external_id","schema":{"type":"string"}},{"in":"query","name":"external_id[in]","schema":{"type":"string"}},{"in":"query","name":"external_id[is_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"external_id[not_null]","schema":{"type":"boolean","const":true}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/deals/imports/{id}":{"get":{"operationId":"deal.import.get","summary":"Get Deal Import","tags":["import"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/deals/by":{"get":{"operationId":"deal.get-by-locator","summary":"Get Deal By Locator","tags":["deal"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string","enum":["CHF","EUR","USD"]},"won_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"lost_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"status":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/DealStatus"},{"type":"object","properties":{"deal_type":{"anyOf":[{"$ref":"#/components/schemas/DealType"},{"type":"null"}]}}}]},{"type":"null"}]},"assignee":{"anyOf":[{"$ref":"#/components/schemas/Employee"},{"type":"null"}]}},"required":["id","organisation_id","name","external_id","status_id","status_key","type_key","assignee_id","contact_id","value","currency","won_at","won_at_date","won_at_time","lost_at","lost_at_date","lost_at_time","deleted_at","created_at","updated_at"],"additionalProperties":{}}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","status","status.deal_type","assignee"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"patch":{"operationId":"deal.update-by-locator","summary":"Update Deal By Locator","tags":["deal"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"currency":{"type":"string","enum":["CHF","EUR","USD"]},"won_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"additionalProperties":{}}}}}},"delete":{"operationId":"deal.delete-by-locator","summary":"Delete Deal By Locator","tags":["deal"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"external_id","schema":{"type":"string","minLength":1}}]}},"/v1/deals/{id}":{"get":{"operationId":"deal.get","summary":"Get Deal","tags":["deal"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string","enum":["CHF","EUR","USD"]},"won_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"won_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"lost_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at_time":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"status":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/DealStatus"},{"type":"object","properties":{"deal_type":{"anyOf":[{"$ref":"#/components/schemas/DealType"},{"type":"null"}]}}}]},{"type":"null"}]},"assignee":{"anyOf":[{"$ref":"#/components/schemas/Employee"},{"type":"null"}]}},"required":["id","organisation_id","name","external_id","status_id","status_key","type_key","assignee_id","contact_id","value","currency","won_at","won_at_date","won_at_time","lost_at","lost_at_date","lost_at_time","deleted_at","created_at","updated_at"],"additionalProperties":{}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","status","status.deal_type","assignee"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}]},"patch":{"operationId":"deal.update","summary":"Update Deal","tags":["deal"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include_details","schema":{"type":"array","items":{"type":"string"}},"description":"Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status_id":{"type":"string","format":"uuid"},"status_key":{"type":"string","minLength":1},"type_key":{"type":"string","minLength":1},"assignee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"contact_id":{"type":"string","format":"uuid"},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"currency":{"type":"string","enum":["CHF","EUR","USD"]},"won_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lost_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"additionalProperties":{}}}}}},"delete":{"operationId":"deal.delete","summary":"Delete Deal","tags":["deal"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/deal-types":{"get":{"operationId":"deal-type.list","summary":"List Deal Types","tags":["deal-type"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DealType"},{"type":"object","properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/DealStatus"}}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"status_type","schema":{"type":"string"}},{"in":"query","name":"status_type[in]","schema":{"type":"string"}},{"in":"query","name":"status_key","schema":{"type":"string"}},{"in":"query","name":"status_key[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"post":{"operationId":"deal-type.create","summary":"Create Deal Type","tags":["deal-type"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DealType"},{"type":"object","properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/DealStatus"}}}}]}}}}},"parameters":[{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"key":{"type":"string","minLength":1},"emoji":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_gallery":{"type":"boolean"},"gallery_key":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"statuses":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["in_progress","lost","open","won"]},"key":{"type":"string","minLength":1},"idx":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","type"]}}},"required":["name"]}}}}}},"/v1/deal-types/{id}":{"get":{"operationId":"deal-type.get","summary":"Get Deal Type","tags":["deal-type"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DealType"},{"type":"object","properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/DealStatus"}}}}]}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"patch":{"operationId":"deal-type.update","summary":"Update Deal Type","tags":["deal-type"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DealType"},{"type":"object","properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/DealStatus"}}}}]}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"emoji":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"statuses":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["in_progress","lost","open","won"]},"key":{"type":"string","minLength":1},"idx":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","type"]}}}}}}}},"delete":{"operationId":"deal-type.delete","summary":"Delete Deal Type","tags":["deal-type"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/deal-types/{id}/duplicate":{"post":{"operationId":"deal-type.duplicate","summary":"Duplicate Deal Type","tags":["deal-type"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DealType"},{"type":"object","properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/DealStatus"}}}}]}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["statuses"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1}}}}}}}},"/v1/employees/{id}":{"get":{"operationId":"employee.get","summary":"Get Employee","tags":["employee"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"type":"string"},"username":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"},"full_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"email":{"anyOf":[{"type":"string","pattern":"^(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)*[a-zA-Z]{2,}))$"},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"is_admin":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"signature":{"anyOf":[{"type":"string"},{"type":"null"}]},"organisation_id":{"type":"string","format":"uuid"},"locale":{"type":"string"},"enable_shortcuts":{"type":"boolean"},"is_web_push_enabled":{"type":"boolean"},"is_mobile_push_enabled":{"type":"boolean"},"is_active":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"has_web_device":{"type":"boolean"},"has_mobile_device":{"type":"boolean"}},"required":["id","display_name","username","full_name","email","user_id","is_admin","signature","organisation_id","locale","enable_shortcuts","is_web_push_enabled","is_mobile_push_enabled","is_active","created_at","updated_at","has_web_device","has_mobile_device"]},{"type":"object","properties":{"profile_image":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/File"},{"type":"null"}]},{"type":"null"}]},"organisation":{"anyOf":[{"$ref":"#/components/schemas/Organisation"},{"type":"null"}]},"invite":{"anyOf":[{"$ref":"#/components/schemas/EmployeeInvite"},{"type":"null"}]},"teams":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}],"$defs":{"File":{"$ref":"#/components/schemas/File"}}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["profile_image","organisation","invite","teams"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/employees":{"get":{"operationId":"employee.list","summary":"List Employees","tags":["employee"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"type":"string"},"username":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"},"full_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"email":{"anyOf":[{"type":"string","pattern":"^(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)*[a-zA-Z]{2,}))$"},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"is_admin":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"signature":{"anyOf":[{"type":"string"},{"type":"null"}]},"organisation_id":{"type":"string","format":"uuid"},"locale":{"type":"string"},"enable_shortcuts":{"type":"boolean"},"is_web_push_enabled":{"type":"boolean"},"is_mobile_push_enabled":{"type":"boolean"},"is_active":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"has_web_device":{"type":"boolean"},"has_mobile_device":{"type":"boolean"}},"required":["id","display_name","username","full_name","email","user_id","is_admin","signature","organisation_id","locale","enable_shortcuts","is_web_push_enabled","is_mobile_push_enabled","is_active","created_at","updated_at","has_web_device","has_mobile_device"]},{"type":"object","properties":{"employee_invite":{"anyOf":[{"$ref":"#/components/schemas/EmployeeInvite"},{"type":"null"}]},"teams":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"team","schema":{"type":"string"}},{"in":"query","name":"full_name","schema":{"type":"string"}},{"in":"query","name":"is_active","schema":{"type":"boolean"}},{"in":"query","name":"is_admin","schema":{"type":"boolean"}},{"in":"query","name":"employee_invite_status","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["employee_invite","teams"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/files/upload_url":{"post":{"operationId":"file.create_upload_url","summary":"Create File Upload URL","tags":["file"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","format":"uuid"},"url":{"type":"string","format":"uri"},"expires_at":{"type":"string","format":"date-time"}},"required":["file_id","url","expires_at"]}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":1024}},"required":["filename"],"additionalProperties":false}}}}}},"/v1/files":{"get":{"operationId":"file.list","summary":"List Files","tags":["file"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"],"$defs":{"File":{"$ref":"#/components/schemas/File"}}}}}}},"parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/files/{id}":{"get":{"operationId":"file.get","summary":"Get File","tags":["file"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/files/{id}/download_url":{"post":{"operationId":"file.create_download_url","summary":"Create File Download URL","tags":["file"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"required":["url","expires_at"]}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expires_in":{"default":3600,"type":"integer","minimum":1,"maximum":86400},"transform":{"type":"object","properties":{"width":{"type":"integer","minimum":1,"maximum":9007199254740991},"height":{"type":"integer","minimum":1,"maximum":9007199254740991},"resize":{"type":"string","enum":["cover","contain","fill"]},"format":{"type":"string","const":"origin"},"quality":{"type":"integer","minimum":1,"maximum":100}}}}}}}}}},"/v1/format/phone-number":{"post":{"operationId":"format.phone-number","summary":"Format Phone Number","tags":["format","educational"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"},"country_code":{"type":"string","minLength":2,"maxLength":2},"formatted_phone_number":{"type":"string"},"format":{"type":"string","const":"e164"}},"required":["phone_number","formatted_phone_number","format"]}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"},"country_codes":{"minItems":1,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"format":{"default":"e164","type":"string","enum":["e164"]}},"required":["phone_number"]}}}}}},"/v1/inboxes":{"get":{"operationId":"public.messaging.inbox.list","summary":"List Inboxes","tags":["messaging","inbox"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Inbox"},{"type":"object","properties":{"inbox_access":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InboxAccess"},{"type":"object","properties":{"team":{"anyOf":[{"$ref":"#/components/schemas/Team"},{"type":"null"}]}}}]}},"channel":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"team","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["inbox_access","inbox_access.team","channel"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/journey-executions/start":{"post":{"operationId":"journeyExecution.start","summary":"Start Journey Execution","tags":["journey_execution"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyExecution"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"journey_id":{"type":"string","format":"uuid"},"context":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"contact":{"type":"object","properties":{"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaign_messages_this_month":{"type":"number"},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_api_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_employee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_import_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_rule_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"email_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"email_marketing_messages_this_month":{"type":"number"},"email_marketing_opt_in":{"type":"boolean"},"email_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"facebook":{"anyOf":[{"type":"string"},{"type":"null"}]},"facebook_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"facebook_marketing_messages_this_month":{"type":"number"},"facebook_marketing_opt_in":{"type":"boolean"},"facebook_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"fts":{},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"google_business_messaging":{"anyOf":[{"type":"string"},{"type":"null"}]},"google_business_messaging_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"google_business_messaging_marketing_messages_this_month":{"type":"number"},"google_business_messaging_marketing_opt_in":{"type":"boolean"},"google_business_messaging_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"id":{"type":"string"},"influenced_revenue":{"type":"number"},"instagram":{"anyOf":[{"type":"string"},{"type":"null"}]},"instagram_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"instagram_marketing_messages_this_month":{"type":"number"},"instagram_marketing_opt_in":{"type":"boolean"},"instagram_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"is_blocked":{"type":"boolean"},"last_external_review_rating":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_interaction_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_internal_review_rating":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_outbound_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_review_rating":{"anyOf":[{"type":"number"},{"type":"null"}]},"latest_marketing_opt_in_request_sent_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"latest_review_request_message_sent_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"marketing_opt_in":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"number_of_marketing_opt_in_requests":{"type":"number"},"organisation_id":{"type":"string"},"postal":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"postal_marketing_messages_this_month":{"anyOf":[{"type":"number"},{"type":"null"}]},"postal_marketing_opt_in":{"type":"boolean"},"postal_messages_this_month":{"anyOf":[{"type":"number"},{"type":"null"}]},"postal_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"review_request_message_count":{"type":"number"},"salutation":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"sms":{"anyOf":[{"type":"string"},{"type":"null"}]},"sms_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"sms_marketing_messages_this_month":{"type":"number"},"sms_marketing_opt_in":{"type":"boolean"},"sms_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"updated_at":{"type":"string"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_api_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_employee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_import_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_rule_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"whatsapp":{"anyOf":[{"type":"string"},{"type":"null"}]},"whatsapp_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"whatsapp_marketing_messages_this_month":{"type":"number"},"whatsapp_marketing_opt_in":{"type":"boolean"},"whatsapp_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"required":["journey_id","contact"]}}}}}},"/v1/journey-executions/start/batch":{"post":{"operationId":"journeyExecution.startBatch","summary":"Start Journey Executions Batch","tags":["journey_execution"],"responses":{"204":{"description":"OK"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"journey_id":{"type":"string","format":"uuid"},"items":{"maxItems":500,"type":"array","items":{"type":"object","properties":{"deduplication_id":{"type":"string","minLength":1},"contact":{"type":"object","properties":{"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"birthday":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaign_messages_this_month":{"type":"number"},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_api_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_employee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_import_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_by_rule_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"email_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"email_marketing_messages_this_month":{"type":"number"},"email_marketing_opt_in":{"type":"boolean"},"email_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"facebook":{"anyOf":[{"type":"string"},{"type":"null"}]},"facebook_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"facebook_marketing_messages_this_month":{"type":"number"},"facebook_marketing_opt_in":{"type":"boolean"},"facebook_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"fts":{},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"google_business_messaging":{"anyOf":[{"type":"string"},{"type":"null"}]},"google_business_messaging_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"google_business_messaging_marketing_messages_this_month":{"type":"number"},"google_business_messaging_marketing_opt_in":{"type":"boolean"},"google_business_messaging_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"id":{"type":"string"},"influenced_revenue":{"type":"number"},"instagram":{"anyOf":[{"type":"string"},{"type":"null"}]},"instagram_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"instagram_marketing_messages_this_month":{"type":"number"},"instagram_marketing_opt_in":{"type":"boolean"},"instagram_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"is_blocked":{"type":"boolean"},"last_external_review_rating":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_interaction_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_internal_review_rating":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_outbound_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_review_rating":{"anyOf":[{"type":"number"},{"type":"null"}]},"latest_marketing_opt_in_request_sent_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"latest_review_request_message_sent_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"marketing_opt_in":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"number_of_marketing_opt_in_requests":{"type":"number"},"organisation_id":{"type":"string"},"postal":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"postal_marketing_messages_this_month":{"anyOf":[{"type":"number"},{"type":"null"}]},"postal_marketing_opt_in":{"type":"boolean"},"postal_messages_this_month":{"anyOf":[{"type":"number"},{"type":"null"}]},"postal_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"review_request_message_count":{"type":"number"},"salutation":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"sms":{"anyOf":[{"type":"string"},{"type":"null"}]},"sms_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"sms_marketing_messages_this_month":{"type":"number"},"sms_marketing_opt_in":{"type":"boolean"},"sms_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"updated_at":{"type":"string"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_api_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_employee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_import_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_by_rule_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"whatsapp":{"anyOf":[{"type":"string"},{"type":"null"}]},"whatsapp_health":{"anyOf":[{"type":"string","enum":["healthy","unhealthy","unknown"]},{"type":"null"}]},"whatsapp_marketing_messages_this_month":{"type":"number"},"whatsapp_marketing_opt_in":{"type":"boolean"},"whatsapp_transactional_opt_in":{"anyOf":[{"type":"string","enum":["legitimate_interest","contract_fulfillment","consent_granted"]},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"context":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]}},"required":["deduplication_id","contact"]}}},"required":["journey_id","items"]}}}}}},"/v1/locations":{"get":{"operationId":"public.scheduling.location.list","summary":"List Locations","tags":["scheduling","location"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"is_default","schema":{"type":"boolean"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]},"post":{"operationId":"public.scheduling.location.create","summary":"Create Location","tags":["scheduling","location"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"street":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"city":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"region":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"iso_country":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"is_default":{"type":"boolean"},"key":{"type":"string","minLength":1}},"required":["name","key"]}}}}}},"/v1/locations/{id}":{"get":{"operationId":"public.scheduling.location.get","summary":"Get Location","tags":["scheduling","location"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Location"},{"type":"object","properties":{"opening_hours":{"type":"array","items":{"$ref":"#/components/schemas/OpeningHours"}}}}]}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["opening_hours"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]},"patch":{"operationId":"public.scheduling.location.update","summary":"Update Location","tags":["scheduling","location"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"street":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"city":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"region":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"iso_country":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"opening_hours":{"type":"array","items":{"$ref":"#/components/schemas/OpeningHours"}}}}}}}},"delete":{"operationId":"public.scheduling.location.delete","summary":"Delete Location","tags":["scheduling","location"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/messages":{"get":{"operationId":"public.messaging.message.list","summary":"List Messages","tags":["messaging","message"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Message"},{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"external_attachments":{"anyOf":[{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/MessageExternalAttachment"}},{"type":"null"}]},{"type":"null"}]},"conversation":{"anyOf":[{"$ref":"#/components/schemas/Conversation"},{"type":"null"}]},"from":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"to":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/MessageAction"}},"reactions":{"type":"array","items":{"$ref":"#/components/schemas/MessageReaction"}},"translations":{"type":"array","items":{"$ref":"#/components/schemas/MessageTranslation"}},"transcriptions":{"type":"array","items":{"$ref":"#/components/schemas/MessageTranscription"}}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"},"File":{"$ref":"#/components/schemas/File"}}}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"conversation","schema":{"type":"string"}},{"in":"query","name":"conversation[in]","schema":{"type":"string"}},{"in":"query","name":"channel","schema":{"type":"string"}},{"in":"query","name":"channel[in]","schema":{"type":"string"}},{"in":"query","name":"channel_type","schema":{"type":"string"}},{"in":"query","name":"channel_type[in]","schema":{"type":"string"}},{"in":"query","name":"template","schema":{"type":"string"}},{"in":"query","name":"template[in]","schema":{"type":"string"}},{"in":"query","name":"sendout","schema":{"type":"string"}},{"in":"query","name":"cs_agent_session","schema":{"type":"string"}},{"in":"query","name":"omni_channel_message","schema":{"type":"string"}},{"in":"query","name":"campaign","schema":{"type":"string"}},{"in":"query","name":"timestamp","schema":{"type":"string"}},{"in":"query","name":"timestamp[gte]","schema":{"type":"string"}},{"in":"query","name":"timestamp[lte]","schema":{"type":"string"}},{"in":"query","name":"timestamp[gt]","schema":{"type":"string"}},{"in":"query","name":"timestamp[lt]","schema":{"type":"string"}},{"in":"query","name":"is_inbound","schema":{"type":"boolean"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["attachments","external_attachments","conversation","from","to","cc","bcc","actions","reactions","translations","transcriptions"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/messages/{id}":{"get":{"operationId":"public.messaging.message.get","summary":"Get Message","tags":["messaging","message"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Message"},{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"external_attachments":{"anyOf":[{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/MessageExternalAttachment"}},{"type":"null"}]},{"type":"null"}]},"from":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"to":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/MessageAction"}},"reactions":{"type":"array","items":{"$ref":"#/components/schemas/MessageReaction"}},"translations":{"type":"array","items":{"$ref":"#/components/schemas/MessageTranslation"}},"transcriptions":{"type":"array","items":{"$ref":"#/components/schemas/MessageTranscription"}},"channel":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/Channel"},{"type":"object","properties":{"provider":{"anyOf":[{"$ref":"#/components/schemas/Provider"},{"type":"null"}]}}}]},{"type":"null"}]},"conversation":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/Conversation"},{"type":"object","properties":{"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]}}}]},{"type":"null"}]}}}],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"},"File":{"$ref":"#/components/schemas/File"}}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["attachments","external_attachments","from","to","cc","bcc","actions","reactions","translations","transcriptions","channel","channel.provider","conversation","conversation.contact"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/messages/send":{"post":{"operationId":"public.messaging.message.send","summary":"Send Message","tags":["messaging","message"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Message"},{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"external_attachments":{"anyOf":[{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/MessageExternalAttachment"}},{"type":"null"}]},{"type":"null"}]},"to":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/MessageAction"}},"reactions":{"type":"array","items":{"$ref":"#/components/schemas/MessageReaction"}},"translations":{"type":"array","items":{"$ref":"#/components/schemas/MessageTranslation"}},"transcriptions":{"type":"array","items":{"$ref":"#/components/schemas/MessageTranscription"}},"reply_to_message":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/Message"},{"type":"null"}]},{"type":"null"}]}}}],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"},"File":{"$ref":"#/components/schemas/File"}}}}}}},"parameters":[{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["attachments","external_attachments","to","cc","bcc","actions","reactions","translations","transcriptions","reply_to_message"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel_id":{"type":"string","format":"uuid"},"id":{"type":"string","format":"uuid"},"conversation_id":{"type":"string","format":"uuid"},"conversation_status":{"type":"string","enum":["archived","closed","open"]},"to":{"type":"array","items":{"type":"object","properties":{"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"handle":{"type":"string"},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_contact_id":{"type":"string"},"secondary_external_contact_id":{"type":"string"}}}},"cc":{"type":"array","items":{"type":"object","properties":{"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"handle":{"type":"string"},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_contact_id":{"type":"string"},"secondary_external_contact_id":{"type":"string"}}}},"bcc":{"type":"array","items":{"type":"object","properties":{"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"handle":{"type":"string"},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"external_contact_id":{"type":"string"},"secondary_external_contact_id":{"type":"string"}}}},"subject":{"type":"string"},"footer":{"type":"string"},"header_media_filename":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"anyOf":[{"$ref":"#/components/schemas/RootNode"},{"type":"null"}]},"text":{"type":"string","minLength":1},"html":{"type":"string","minLength":1},"send_after":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"placeholder_values":{"type":"array","items":{"type":"string"}},"reply_to_message_id":{"type":"string","format":"uuid"},"template_id":{"type":"string","format":"uuid"},"sendout_id":{"type":"string","format":"uuid"},"campaign_id":{"type":"string","format":"uuid"},"review_channel_id":{"type":"string","format":"uuid"},"form_element_submission_id":{"type":"string","format":"uuid"},"journey_node_execution_id":{"type":"string","format":"uuid"},"omni_channel_message_id":{"type":"string","format":"uuid"},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["call_to_action","list","quick_reply"]},"subtype":{"anyOf":[{"type":"string","enum":["phone_number","url"]},{"type":"null"}]},"text":{"type":"string"},"data":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","text"]}},"marketing_channel_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["answered","bounce_error","draft","interacted","read","scheduled","sending","sending_error","sent","submission_error","submitted"]},"cs_agent_session_id":{"type":"string","format":"uuid"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/FileInput"}}},"required":["channel_id"],"examples":[{"channel_id":"00000000-0000-0000-0000-000000000000","to":[{"handle":"recipient@example.com"}],"text":"Hello"}],"$defs":{"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"},"FileInput":{"$ref":"#/components/schemas/FileInput"}}}}}}}},"/v1/messages/{message_id}":{"delete":{"operationId":"public.messaging.message.delete","summary":"Delete Message","tags":["messaging","message"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"message_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/messages/{message_id}/reschedule":{"post":{"operationId":"public.messaging.message.reschedule","summary":"Reschedule Message","tags":["messaging","message"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}}},"parameters":[{"in":"path","name":"message_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"send_after":{"type":"string","format":"date-time"}}}}}}}},"/v1/messages/{message_id}/cancel":{"post":{"operationId":"public.messaging.message.cancel","summary":"Cancel Message","tags":["messaging","message"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}}},"parameters":[{"in":"path","name":"message_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/messages/{message_id}/anonymize":{"post":{"operationId":"public.messaging.message.anonymize","summary":"Anonymize Message","tags":["messaging","message"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}}},"parameters":[{"in":"path","name":"message_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/messages/{message_id}/reactions":{"post":{"operationId":"public.messaging.messageReaction.create","summary":"Create Message Reaction","tags":["messaging","message-reaction"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageReaction"}}}}},"parameters":[{"in":"path","name":"message_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"emoji":{"type":"string","minLength":1,"maxLength":3},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["recipient_id","emoji"]}}}}}},"/v1/messages/{message_id}/reactions/{reaction_id}":{"delete":{"operationId":"public.messaging.messageReaction.delete","summary":"Delete Message Reaction","tags":["messaging","message-reaction"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"message_id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"path","name":"reaction_id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/organisations/{id}":{"get":{"operationId":"organisation.get","summary":"Get Organisation","tags":["organisation"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organisation"},{"type":"object","properties":{"logo":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/File"},{"type":"null"}]},{"type":"null"}]},"favicon":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/File"},{"type":"null"}]},{"type":"null"}]},"commercial_register_extract":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/File"},{"type":"null"}]},{"type":"null"}]},"identity_card":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/File"},{"type":"null"}]},{"type":"null"}]},"opt_out_template":{"anyOf":[{"$ref":"#/components/schemas/Template"},{"type":"null"}]},"country":{"anyOf":[{"$ref":"#/components/schemas/Country"},{"type":"null"}]}}}],"$defs":{"File":{"$ref":"#/components/schemas/File"},"ParagraphNode":{"$ref":"#/components/schemas/ParagraphNode"}}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["logo","favicon","commercial_register_extract","identity_card","opt_out_template","country"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/opt-in-groups":{"get":{"operationId":"public.opt-in-group.list","summary":"List Opt-in Groups","tags":["opt-in-group"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OptInGroup"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key[in]","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"request_double_opt_in_template","schema":{"type":"string"}},{"in":"query","name":"trigger_keyword[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/opt-in-groups/{id}":{"get":{"operationId":"public.opt-in-group.get","summary":"Get Opt-in Group","tags":["opt-in-group"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptInGroup"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/sendouts":{"post":{"operationId":"public.sendout.create","summary":"Create Sendout","tags":["sendout"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Sendout"},{"type":"object","properties":{"header_media":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/File"},{"type":"null"}]},{"type":"null"}]}}}],"$defs":{"SendoutContact":{"$ref":"#/components/schemas/SendoutContact"},"File":{"$ref":"#/components/schemas/File"}}}}}}},"parameters":[{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["header_media"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"mode":{"type":"string","const":"broadcast"},"from":{"type":"string","format":"uuid"},"template_id":{"type":"string","format":"uuid"},"require_marketing_opt_in":{"default":true,"type":"boolean"},"to_recipients":{"default":[],"type":"array","items":{"type":"object","properties":{"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"handle":{"type":"string"},"placeholder_values":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"contact_external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"contact_secondary_external_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["handle"]}},"to_segments":{"default":[],"type":"array","items":{"type":"string","format":"uuid"}},"send_after":{"type":"string","format":"date-time"},"placeholder_values":{"type":"array","items":{"type":"string"}},"review_channel_id":{"type":"string","format":"uuid"},"header_media":{"$ref":"#/components/schemas/FileInput"}},"required":["mode","from","template_id"],"$defs":{"FileInput":{"$ref":"#/components/schemas/FileInput"}}}}}}}},"/v1/subscriptions":{"get":{"operationId":"public.subscription.list","summary":"List Subscriptions","tags":["subscription"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Subscription"},{"type":"object","properties":{"contact":{"anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"opt_in_group":{"anyOf":[{"$ref":"#/components/schemas/OptInGroup"},{"type":"null"}]}}}]}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"opt_in_group","schema":{"type":"string"}},{"in":"query","name":"opt_in_group[in]","schema":{"type":"string"}},{"in":"query","name":"contact","schema":{"type":"string"}},{"in":"query","name":"contact[in]","schema":{"type":"string"}},{"in":"query","name":"contact_external_id","schema":{"type":"string"}},{"in":"query","name":"channel_type","schema":{"type":"string"}},{"in":"query","name":"channel_type[in]","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"status[neq]","schema":{"type":"string"}},{"in":"query","name":"status[in]","schema":{"type":"string"}},{"in":"query","name":"updated_at","schema":{"type":"string"}},{"in":"query","name":"updated_at[gte]","schema":{"type":"string"}},{"in":"query","name":"updated_at[lte]","schema":{"type":"string"}},{"in":"query","name":"updated_at[gt]","schema":{"type":"string"}},{"in":"query","name":"updated_at[lt]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}},{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","enum":["contact","opt_in_group"]}},"description":"Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar"}]}},"/v1/subscriptions/{id}":{"get":{"operationId":"public.subscription.get","summary":"Get Subscription","tags":["subscription"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/tags":{"get":{"operationId":"public.messaging.tag.list","summary":"List Tags","tags":["messaging","tag"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id[in]","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]}},"/v1/webhooks":{"get":{"operationId":"webhook.list","summary":"List Webhooks","tags":["webhooks","webhook"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"next_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_page_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","next_page_url","previous_page_url"]}}}}},"parameters":[{"in":"query","name":"active","schema":{"type":"boolean"}},{"in":"query","name":"method","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":10,"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"page_token","schema":{"type":"string","minLength":1}}]},"post":{"operationId":"webhook.create","summary":"Create Webhook","tags":["webhooks","webhook"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"active":{"default":true,"type":"boolean"},"method":{"default":"POST","type":"string","enum":["POST","PUT","PATCH"]},"target_url":{"type":"string","format":"uri"},"headers":{"default":{},"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"value":{"type":"string"}},"required":["key","value"]}}]},"event":{"type":"string","enum":["contact_details.updated","contact.created","contact.deleted","contact.updated","conversation.assign","conversation.close","conversation.inbound","conversation.outbound","conversation.reopen","conversation.sending_error","conversation.submission_error","conversation.tag","conversation.unassign","conversation.untag","form_submission.aborted","form_submission.completed"]},"fields":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["name","target_url","event"]}}}}}},"/v1/webhooks/{id}":{"patch":{"operationId":"webhook.update","summary":"Update Webhook","tags":["webhooks","webhook"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","PUT","PATCH"]},"target_url":{"type":"string","format":"uri"},"headers":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"value":{"type":"string"}},"required":["key","value"]}}]},"event":{"type":"string","enum":["contact_details.updated","contact.created","contact.deleted","contact.updated","conversation.assign","conversation.close","conversation.inbound","conversation.outbound","conversation.reopen","conversation.sending_error","conversation.submission_error","conversation.tag","conversation.unassign","conversation.untag","form_submission.aborted","form_submission.completed"]},"fields":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}}}}}}},"delete":{"operationId":"webhook.delete","summary":"Delete Webhook","tags":["webhooks","webhook"],"responses":{"204":{"description":"OK"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}]}},"/v1/me":{"get":{"operationId":"public.me.get","summary":"Get Current Identity","tags":["identity"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"employee"},"user_id":{"type":"string","format":"uuid"},"employee_id":{"type":"string","format":"uuid"},"organisation_id":{"type":"string","format":"uuid"},"display_name":{"type":"string"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"is_admin":{"type":"boolean"},"is_sp":{"type":"boolean"},"locale":{"type":"string"},"timezone":{"type":"string"}},"required":["type","user_id","employee_id","organisation_id","display_name","email","is_admin","is_sp","locale","timezone"]},{"type":"object","properties":{"type":{"type":"string","const":"user"},"user_id":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["type","user_id","email"]},{"type":"object","properties":{"type":{"type":"string","const":"api_token"},"organisation_id":{"type":"string","format":"uuid"},"token_id":{"type":"string","format":"uuid"},"token_name":{"type":"string"}},"required":["type","organisation_id","token_id","token_name"]},{"type":"object","properties":{"type":{"type":"string","const":"service_role"},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]}},"required":["type","organisation_id"]}]}}}}}}}},"servers":[{"url":"https://api.getmateo.com"},{"url":"https://api.dev.getmateo.com"}]}