{"openapi":"3.0.0","info":{"version":"firstquadrant.ai-2026-02-02-1a9bd5b","title":"FirstQuadrant API"},"servers":[{"url":"https://api.us.firstquadrant.ai"}],"tags":[{"name":"Analytics","description":"Analytics endpoints for deals and campaigns"},{"name":"Authentication","description":"Authentication and authorization"},{"name":"API Keys","description":"Manage API keys for programmatic access"},{"name":"Sessions","description":"Manage user sessions"},{"name":"Users","description":"User account management"},{"name":"User Memberships","description":"Manage user organization memberships"},{"name":"Billing","description":"Billing and subscription management"},{"name":"Campaigns","description":"Email campaign management"},{"name":"Campaign Connections","description":"Manage campaign email connections"},{"name":"Campaign Memberships","description":"Manage campaign team members"},{"name":"Campaign Sequences","description":"Manage campaign sequences"},{"name":"Campaign Teams","description":"Manage campaign teams"},{"name":"Campaign Variants","description":"Manage campaign variants for A/B testing"},{"name":"Campaign Steps","description":"Manage campaign workflow steps"},{"name":"Actions","description":"Manage and execute actions"},{"name":"Calendar Events","description":"Calendar event management"},{"name":"Draft Emails","description":"Manage draft emails"},{"name":"Email Addresses","description":"Email address management"},{"name":"Emails","description":"Email management and history"},{"name":"Notes","description":"Notes and annotations"},{"name":"Tasks","description":"Task management"},{"name":"Connections","description":"External service connections"},{"name":"Tracking Domains","description":"Email tracking domain configuration"},{"name":"Activities","description":"Activity tracking and history"},{"name":"Companies","description":"Company management"},{"name":"Contacts","description":"Contact management"},{"name":"Employments","description":"Contact employment information"},{"name":"Deleted Contacts","description":"Manage deleted contacts"},{"name":"Domains","description":"Domain management"},{"name":"Properties","description":"Custom properties and fields"},{"name":"Suppression Lists","description":"Email suppression list management"},{"name":"Suppressions","description":"Individual suppression entries"},{"name":"Values","description":"Property values management"},{"name":"Views","description":"Saved views and filters"},{"name":"Deals","description":"Deal and opportunity management"},{"name":"Pipelines","description":"Sales pipeline configuration"},{"name":"Pipeline Stages","description":"Pipeline stage management"},{"name":"Points of Contact","description":"Deal points of contact"},{"name":"Fine-tunings","description":"AI model fine-tuning"},{"name":"Imports","description":"Data import management"},{"name":"Import Files","description":"Import file operations"},{"name":"Qualifying Questions","description":"Import qualifying questions"},{"name":"Import Rows","description":"Individual import row management"},{"name":"Meta","description":"API metadata and health checks"},{"name":"Organizations","description":"Organization management"},{"name":"Events","description":"Event tracking and audit log"},{"name":"Memberships","description":"Organization membership management"},{"name":"Teams","description":"Team management"},{"name":"Usage","description":"Usage tracking and limits"},{"name":"Tracking","description":"Email and link tracking"},{"name":"Webhooks","description":"Webhook endpoints for external services"},{"name":"Integrations","description":"Third-party integrations"},{"name":"Queue","description":"Background job queue management"}],"components":{"schemas":{"HealthCheckResponse":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"description":"Health check status."},"challenge":{"type":"string","minLength":1,"maxLength":10000,"description":"Optional challenge string echoed back."}},"required":["ok"]},"RedirectResponse":{"type":"object","properties":{"redirect":{"type":"string","format":"uri","description":"URL to redirect to."}},"required":["redirect"]},"MissingScopesError":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_access_token","invalid_api_key","invalid_refresh_token","invalid_webhook_signature","missing_authorization","requires_access_token"],"description":"Code identifying the error."},"status":{"type":"number","enum":[401],"description":"HTTP status code for Unauthorized."},"message":{"type":"string","description":"Human-readable error message."},"description":{"type":"string","description":"Description about what went wrong."}},"required":["code","status","message","description"]},"ForbiddenError":{"type":"object","properties":{"code":{"type":"string","enum":["missing_scopes"],"description":"Code identifying the error."},"status":{"type":"number","enum":[403],"description":"HTTP status code for Forbidden."},"message":{"type":"string","description":"Human-readable error message."},"description":{"type":"string","description":"Description about what went wrong."}},"required":["code","status","message","description"]},"ResourceNotFoundError":{"type":"object","properties":{"code":{"type":"string","enum":["resource_not_found"],"description":"Code identifying the error."},"status":{"type":"number","enum":[404],"description":"HTTP status code for Not Found."},"message":{"type":"string","description":"Human-readable error message."},"description":{"type":"string","description":"Description about what went wrong."}},"required":["code","status","message","description"]},"Generation":{"type":"object","properties":{"id":{"type":"number"},"unique_id":{"type":"string"},"prompt_id":{"type":"string"},"model":{"type":"string"},"timestamp":{"type":"string"},"completion_message":{"type":"object","properties":{"content":{"type":"string"}},"required":["content"]},"total_request_tokens":{"type":"number"},"cost":{"type":"number"},"prompt_messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string"}},"required":["role","content"]}},"completion_messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string"}},"required":["role","content"]}}},"required":["id","unique_id","prompt_id","model","timestamp","completion_message","total_request_tokens","cost","prompt_messages","completion_messages"]},"TrackingResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the tracking operation was successful."},"description":{"type":"string","description":"Description of the tracking result."}},"required":["success","description"]},"ApiKey":{"type":"object","properties":{"object":{"type":"string","enum":["apiKey"]},"id":{"type":"string","minLength":4,"description":"ID of the API key."},"sort":{"type":"number","description":"Sorting order of this API key."},"createdAt":{"type":"string","description":"Date when this API key was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this API key was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this API key is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this API key is not deleted, this value is null."},"hash":{"type":"string","minLength":1,"maxLength":10000,"description":"Cryptographically generated hash of the secret key."},"scopes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000,"pattern":":read|write$"},"description":"Scopes available to the API key."},"app":{"type":"string","nullable":true,"enum":["ZAPMAIL"]},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the API key"},"expiresAt":{"type":"string","nullable":true,"description":"Date when the API key will be expired. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If the API key has no expiry, the value is null."},"ipRanges":{"type":"array","items":{"type":"string","pattern":"^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\/[0-9]{1,2}$"},"description":"List of IP addresses allowed to make requests using the API key. Each value in the array of strings is an IP address range in CIDR notation, for example 192.168.1.0/24."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the API key is associated with."},"events":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string"}},"required":["createdAt"]},"description":"Events associated with the API key."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","hash","scopes","app","name","expiresAt","ipRanges","organizationId","events"]},"ApiKeyCreate":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000,"pattern":":read|write$"},"description":"Scopes available to the API key."},"app":{"type":"string","nullable":true,"enum":["ZAPMAIL"]},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the API key"},"expiresAt":{"type":"string","nullable":true,"description":"Date when the API key will be expired. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If the API key has no expiry, the value is null."},"ipRanges":{"type":"array","items":{"type":"string","pattern":"^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\/[0-9]{1,2}$"},"description":"List of IP addresses allowed to make requests using the API key. Each value in the array of strings is an IP address range in CIDR notation, for example 192.168.1.0/24."}},"required":["scopes","app","name","expiresAt","ipRanges"]},"ApiKeyUpdate":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000,"pattern":":read|write$"},"description":"Scopes available to the API key."},"app":{"type":"string","nullable":true,"enum":["ZAPMAIL"]},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the API key"},"expiresAt":{"type":"string","nullable":true,"description":"Date when the API key will be expired. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If the API key has no expiry, the value is null."},"ipRanges":{"type":"array","items":{"type":"string","pattern":"^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\/[0-9]{1,2}$"},"description":"List of IP addresses allowed to make requests using the API key. Each value in the array of strings is an IP address range in CIDR notation, for example 192.168.1.0/24."}}},"AccessTokenPayload":{"type":"object","properties":{"userId":{"type":"string","minLength":4},"userName":{"type":"string"},"userEmail":{"type":"string"},"sessionId":{"type":"string","minLength":4},"scopes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000,"pattern":":read|write$"}}},"required":["userId","userName","userEmail","sessionId","scopes"]},"LoginCodeToken":{"type":"object","properties":{"codeToken":{"type":"string","pattern":"^[A-Za-z0-9-_~+/]+=*.[A-Za-z0-9-_~+/]+=*.[A-Za-z0-9-_~+/]+$","description":"Token provided during login."}},"required":["codeToken"]},"LoginToken":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9-_~+/]+=*.[A-Za-z0-9-_~+/]+=*.[A-Za-z0-9-_~+/]+$","description":"Token provided in the login email."}},"required":["token"]},"AuthTokens":{"type":"object","properties":{"userId":{"type":"string","minLength":4,"description":"ID of the user."},"sessionId":{"type":"string","minLength":4,"description":"ID of the session."},"accessToken":{"type":"string","minLength":1,"maxLength":10000,"description":"Access token."},"refreshToken":{"type":"string","minLength":1,"maxLength":10000,"description":"Refresh token."}},"required":["userId","sessionId","accessToken","refreshToken"]},"LoginCode":{"type":"object","properties":{"codeToken":{"type":"string","pattern":"^[A-Za-z0-9-_~+/]+=*.[A-Za-z0-9-_~+/]+=*.[A-Za-z0-9-_~+/]+$","description":"Token provided during login."},"code":{"type":"string","minLength":6,"maxLength":6,"description":"Code provided in the login email."}},"required":["codeToken","code"]},"LoginEmail":{"type":"object","properties":{"email":{"type":"string","minLength":3,"format":"email","description":"Email address of the user."},"password":{"type":"string","nullable":true,"maxLength":10000,"description":"Password of the user."}},"required":["email"]},"Session":{"type":"object","properties":{"object":{"type":"string","enum":["session"]},"id":{"type":"string","minLength":4,"description":"ID of the session."},"sort":{"type":"number","description":"Sorting order of this session."},"createdAt":{"type":"string","description":"Date when this session was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this session was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this session is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this session is not deleted, this value is null."},"token":{"type":"string","minLength":1,"maxLength":10000,"description":"Cryptographically generated hash of the refresh token."},"userAgentString":{"type":"string","nullable":true,"maxLength":10000,"description":"User agent the session is associated with. This value is only available if the session was created as a side effect of an HTTP request."},"userAgentBrowserName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the web browser extracted from the user agent."},"userAgentBrowserVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the web browser extracted from the user agent."},"userAgentDeviceModel":{"type":"string","nullable":true,"maxLength":10000,"description":"Model of the device extracted from the user agent."},"userAgentDeviceVendor":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the device vendor extracted from the user agent."},"userAgentEngineName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the browser engine extracted from the user agent."},"userAgentEngineVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the browser engine extracted from the user agent."},"userAgentOsName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the operating system extracted from the user agent."},"userAgentOsVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the operating system extracted from the user agent."},"ipAddressHash":{"type":"string","minLength":1,"maxLength":10000,"description":"Hash of the IP address the session is associated with."},"userId":{"type":"string","minLength":4,"description":"ID of the user the session is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","token","userAgentString","userAgentBrowserName","userAgentBrowserVersion","userAgentDeviceModel","userAgentDeviceVendor","userAgentEngineName","userAgentEngineVersion","userAgentOsName","userAgentOsVersion","ipAddressHash","userId"]},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"description":"Indicates the operation was successful."}},"required":["success"]},"Register":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":10000,"description":"Name of the user."},"company":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the company."},"website":{"type":"string","format":"uri","description":"Website of the company."},"email":{"type":"string","minLength":3,"format":"email","description":"Email address of the user."},"rowId":{"type":"string","nullable":true,"maxLength":10000,"description":"ID of the row."}},"required":["name","company","website","email"]},"Price":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","enum":["price"]},"active":{"type":"boolean"},"billing_scheme":{"type":"string","enum":["per_unit","tiered"]},"created":{"type":"number"},"currency":{"type":"string"},"custom_unit_amount":{"type":"object","nullable":true,"properties":{"maximum":{"type":"number","nullable":true},"minimum":{"type":"number","nullable":true},"preset":{"type":"number","nullable":true}},"required":["maximum","minimum","preset"]},"livemode":{"type":"boolean"},"lookup_key":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}},"nickname":{"type":"string","nullable":true},"product":{"anyOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","enum":["product"]},"active":{"type":"boolean"},"created":{"type":"number"},"default_price":{"anyOf":[{"type":"string"},{"nullable":true},{"nullable":true}]},"description":{"type":"string","nullable":true},"images":{"type":"array","items":{"type":"string"}},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"package_dimensions":{"nullable":true},"shippable":{"type":"boolean","nullable":true},"statement_descriptor":{"type":"string","nullable":true},"tax_code":{"anyOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","enum":["tax_code"]},"description":{"type":"string"},"name":{"type":"string"}},"required":["id","object","description","name"]},{"nullable":true}]},"unit_label":{"type":"string","nullable":true},"updated":{"type":"number"},"url":{"type":"string","nullable":true}},"required":["id","object","active","created","description","images","livemode","metadata","name","shippable","tax_code","updated","url"]},{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","enum":["product"]},"deleted":{"type":"boolean","enum":[true]}},"required":["id","object","deleted"]}]},"recurring":{"type":"object","nullable":true,"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"},"meter":{"type":"string","nullable":true},"trial_period_days":{"type":"number","nullable":true},"usage_type":{"type":"string","enum":["metered","licensed"]}},"required":["interval","interval_count","meter","trial_period_days","usage_type"]},"tax_behavior":{"type":"string","nullable":true,"enum":["exclusive","inclusive","unspecified"]},"tiers_mode":{"type":"string","nullable":true,"enum":["graduated","volume"]},"transform_quantity":{"type":"object","nullable":true,"properties":{"divide_by":{"type":"number"},"round":{"type":"string","enum":["down","up"]}},"required":["divide_by","round"]},"type":{"type":"string","enum":["one_time","recurring"]},"unit_amount":{"type":"number","nullable":true},"unit_amount_decimal":{"type":"string","nullable":true}},"required":["id","object","active","billing_scheme","created","currency","custom_unit_amount","livemode","lookup_key","metadata","nickname","product","recurring","tax_behavior","tiers_mode","transform_quantity","type","unit_amount","unit_amount_decimal"]},"CreatePrice":{"type":"object","properties":{"priceId":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}},"required":["priceId","name","email"]},"Subscription":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"CreateSubscription":{"type":"object","properties":{"subscriptionId":{"type":"string"},"subscriptionPeriodCreditsExhaustedAtOverwriteEnabled":{"type":"boolean"},"subscriptionPeriodCreditsExhaustedAtOverwriteDisableAt":{"type":"string","nullable":true},"subscriptionPeriodCreditsExhaustedAtOverwriteValue":{"type":"string","nullable":true},"subscriptionPeriodCreditsIncludedOverwriteEnabled":{"type":"boolean"},"subscriptionPeriodCreditsIncludedOverwriteDisableAt":{"type":"string","nullable":true},"subscriptionPeriodCreditsIncludedOverwriteValue":{"type":"integer","nullable":true},"subscriptionStatusOverwriteEnabled":{"type":"boolean"},"subscriptionStatusOverwriteDisableAt":{"type":"string","nullable":true},"subscriptionStatusOverwriteValue":{"type":"string","nullable":true,"enum":["ACTIVE","INACTIVE","PAUSED","PAST_DUE","TRIAL"]}},"required":["subscriptionId","subscriptionPeriodCreditsExhaustedAtOverwriteEnabled","subscriptionPeriodCreditsIncludedOverwriteEnabled","subscriptionStatusOverwriteEnabled"]},"UpdateSubscription":{"type":"object","properties":{"subscriptionId":{"type":"string"},"subscriptionPeriodCreditsExhaustedAtOverwriteEnabled":{"type":"boolean"},"subscriptionPeriodCreditsExhaustedAtOverwriteDisableAt":{"type":"string","nullable":true},"subscriptionPeriodCreditsExhaustedAtOverwriteValue":{"type":"string","nullable":true},"subscriptionPeriodCreditsIncludedOverwriteEnabled":{"type":"boolean"},"subscriptionPeriodCreditsIncludedOverwriteDisableAt":{"type":"string","nullable":true},"subscriptionPeriodCreditsIncludedOverwriteValue":{"type":"integer","nullable":true},"subscriptionStatusOverwriteEnabled":{"type":"boolean"},"subscriptionStatusOverwriteDisableAt":{"type":"string","nullable":true},"subscriptionStatusOverwriteValue":{"type":"string","nullable":true,"enum":["ACTIVE","INACTIVE","PAUSED","PAST_DUE","TRIAL"]}}},"Invoice":{"type":"object","properties":{"id":{"type":"string","description":"ID of the invoice."},"sort":{"type":"number","description":"Sorting order of this invoice."},"createdAt":{"type":"string","description":"Date when this invoice was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this invoice was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"Date when this invoice was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"object":{"type":"string","enum":["invoice"]},"amount_due":{"type":"number"},"amount_paid":{"type":"number"},"amount_remaining":{"type":"number"},"collection_method":{"type":"string","enum":["charge_automatically","send_invoice"]},"created":{"type":"number"},"currency":{"type":"string"},"customer":{"type":"string"},"customer_email":{"type":"string","nullable":true},"customer_name":{"type":"string","nullable":true},"customer_phone":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"due_date":{"type":"number","nullable":true},"hosted_invoice_url":{"type":"string","nullable":true},"invoice_pdf":{"type":"string","nullable":true},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"number":{"type":"string","nullable":true},"paid":{"type":"boolean"},"payment_intent":{"type":"string","nullable":true},"period_end":{"type":"number"},"period_start":{"type":"number"},"receipt_number":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","open","paid","uncollectible","void"]},"subscription":{"type":"string","nullable":true},"subtotal":{"type":"number"},"tax":{"type":"number","nullable":true},"total":{"type":"number"}},"required":["id","sort","createdAt","updatedAt","deletedAt","object","amount_due","amount_paid","amount_remaining","collection_method","created","currency","customer","customer_email","customer_name","customer_phone","description","due_date","livemode","metadata","number","paid","payment_intent","period_end","period_start","receipt_number","status","subscription","subtotal","tax","total"]},"ClientSecretResponse":{"type":"object","properties":{"clientSecret":{"type":"string","description":"Client secret for payment processing."}},"required":["clientSecret"]},"SessionCreate":{"type":"object","properties":{}},"SessionUpdate":{"type":"object","properties":{}},"TimeZone":{"type":"string","enum":["Pacific/Midway","Pacific/Niue","Pacific/Pago_Pago","America/Adak","Pacific/Honolulu","Pacific/Rarotonga","Pacific/Tahiti","Pacific/Marquesas","America/Anchorage","America/Juneau","America/Metlakatla","America/Nome","America/Sitka","America/Yakutat","Pacific/Gambier","America/Los_Angeles","America/Tijuana","America/Vancouver","Pacific/Pitcairn","America/Boise","America/Cambridge_Bay","America/Chihuahua","America/Creston","America/Dawson","America/Dawson_Creek","America/Denver","America/Edmonton","America/Fort_Nelson","America/Hermosillo","America/Inuvik","America/Mazatlan","America/Ojinaga","America/Phoenix","America/Whitehorse","America/Yellowknife","America/Bahia_Banderas","America/Belize","America/Chicago","America/Costa_Rica","America/El_Salvador","America/Guatemala","America/Indiana/Knox","America/Indiana/Tell_City","America/Managua","America/Matamoros","America/Menominee","America/Merida","America/Mexico_City","America/Monterrey","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Rainy_River","America/Rankin_Inlet","America/Regina","America/Resolute","America/Swift_Current","America/Tegucigalpa","America/Winnipeg","Pacific/Easter","Pacific/Galapagos","America/Atikokan","America/Bogota","America/Cancun","America/Cayman","America/Detroit","America/Eirunepe","America/Grand_Turk","America/Guayaquil","America/Havana","America/Indiana/Indianapolis","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Iqaluit","America/Jamaica","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Lima","America/Nassau","America/New_York","America/Nipigon","America/Panama","America/Pangnirtung","America/Port-au-Prince","America/Rio_Branco","America/Thunder_Bay","America/Toronto","America/Anguilla","America/Antigua","America/Aruba","America/Asuncion","America/Barbados","America/Blanc-Sablon","America/Boa_Vista","America/Campo_Grande","America/Caracas","America/Cuiaba","America/Curacao","America/Dominica","America/Glace_Bay","America/Goose_Bay","America/Grenada","America/Guadeloupe","America/Guyana","America/Halifax","America/Kralendijk","America/La_Paz","America/Lower_Princes","America/Manaus","America/Marigot","America/Martinique","America/Moncton","America/Montserrat","America/Porto_Velho","America/Port_of_Spain","America/Puerto_Rico","America/Santiago","America/Santo_Domingo","America/St_Barthelemy","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Thule","America/Tortola","Atlantic/Bermuda","America/St_Johns","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Bahia","America/Belem","America/Cayenne","America/Fortaleza","America/Godthab","America/Maceio","America/Miquelon","America/Montevideo","America/Paramaribo","America/Punta_Arenas","America/Recife","America/Santarem","America/Sao_Paulo","Antarctica/Palmer","Antarctica/Rothera","Atlantic/Stanley","America/Noronha","Atlantic/South_Georgia","America/Scoresbysund","Atlantic/Azores","Atlantic/Cape_Verde","Africa/Abidjan","Africa/Accra","Africa/Bamako","Africa/Banjul","Africa/Bissau","Africa/Casablanca","Africa/Conakry","Africa/Dakar","Africa/El_Aaiun","Africa/Freetown","Africa/Lome","Africa/Monrovia","Africa/Nouakchott","Africa/Ouagadougou","Africa/Sao_Tome","America/Danmarkshavn","Antarctica/Troll","Atlantic/Canary","Atlantic/Faroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/St_Helena","Europe/Dublin","Europe/Guernsey","Europe/Isle_of_Man","Europe/Jersey","Europe/Lisbon","Europe/London","Africa/Algiers","Africa/Bangui","Africa/Brazzaville","Africa/Ceuta","Africa/Douala","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Luanda","Africa/Malabo","Africa/Ndjamena","Africa/Niamey","Africa/Porto-Novo","Africa/Tunis","Africa/Windhoek","Arctic/Longyearbyen","Europe/Amsterdam","Europe/Andorra","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Budapest","Europe/Copenhagen","Europe/Gibraltar","Europe/Ljubljana","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Monaco","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Rome","Europe/San_Marino","Europe/Sarajevo","Europe/Skopje","Europe/Stockholm","Europe/Tirane","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Africa/Blantyre","Africa/Bujumbura","Africa/Cairo","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Khartoum","Africa/Kigali","Africa/Lubumbashi","Africa/Lusaka","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Tripoli","Asia/Amman","Asia/Beirut","Asia/Damascus","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Jerusalem","Asia/Nicosia","Europe/Athens","Europe/Bucharest","Europe/Chisinau","Europe/Helsinki","Europe/Kaliningrad","Europe/Kyiv","Europe/Mariehamn","Europe/Riga","Europe/Sofia","Europe/Tallinn","Europe/Uzhgorod","Europe/Vilnius","Europe/Zaporizhzhia","Africa/Addis_Ababa","Africa/Asmara","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Kampala","Africa/Mogadishu","Africa/Nairobi","Antarctica/Syowa","Asia/Aden","Asia/Baghdad","Asia/Bahrain","Asia/Kuwait","Asia/Qatar","Asia/Riyadh","Europe/Istanbul","Europe/Kirov","Europe/Minsk","Europe/Moscow","Europe/Simferopol","Europe/Volgograd","Indian/Antananarivo","Indian/Comoro","Indian/Mayotte","Asia/Tehran","Asia/Baku","Asia/Dubai","Asia/Muscat","Asia/Tbilisi","Asia/Yerevan","Europe/Astrakhan","Europe/Samara","Europe/Saratov","Europe/Ulyanovsk","Indian/Mahe","Indian/Mauritius","Indian/Reunion","Asia/Kabul","Antarctica/Mawson","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Dushanbe","Asia/Karachi","Asia/Oral","Asia/Qyzylorda","Asia/Samarkand","Asia/Tashkent","Asia/Yekaterinburg","Indian/Kerguelen","Indian/Maldives","Asia/Colombo","Asia/Kolkata","Asia/Kathmandu","Antarctica/Vostok","Asia/Almaty","Asia/Bishkek","Asia/Dhaka","Asia/Omsk","Asia/Qostanay","Asia/Thimphu","Asia/Urumqi","Indian/Chagos","Asia/Yangon","Indian/Cocos","Antarctica/Davis","Asia/Bangkok","Asia/Barnaul","Asia/Hovd","Asia/Ho_Chi_Minh","Asia/Jakarta","Asia/Krasnoyarsk","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Phnom_Penh","Asia/Pontianak","Asia/Tomsk","Asia/Vientiane","Indian/Christmas","Asia/Brunei","Asia/Choibalsan","Asia/Hong_Kong","Asia/Irkutsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Macau","Asia/Makassar","Asia/Manila","Asia/Shanghai","Asia/Singapore","Asia/Taipei","Asia/Ulaanbaatar","Australia/Perth","Australia/Eucla","Asia/Chita","Asia/Dili","Asia/Jayapura","Asia/Khandyga","Asia/Pyongyang","Asia/Seoul","Asia/Tokyo","Asia/Yakutsk","Pacific/Palau","Australia/Adelaide","Australia/Broken_Hill","Australia/Darwin","Antarctica/DumontDUrville","Antarctica/Macquarie","Asia/Ust-Nera","Asia/Vladivostok","Australia/Brisbane","Australia/Currie","Australia/Hobart","Australia/Lindeman","Australia/Melbourne","Australia/Sydney","Pacific/Chuuk","Pacific/Guam","Pacific/Port_Moresby","Pacific/Saipan","Australia/Lord_Howe","Antarctica/Casey","Asia/Magadan","Asia/Sakhalin","Asia/Srednekolymsk","Pacific/Bougainville","Pacific/Efate","Pacific/Guadalcanal","Pacific/Kosrae","Pacific/Norfolk","Pacific/Noumea","Pacific/Pohnpei","Antarctica/McMurdo","Asia/Anadyr","Asia/Kamchatka","Pacific/Auckland","Pacific/Fiji","Pacific/Funafuti","Pacific/Kwajalein","Pacific/Majuro","Pacific/Nauru","Pacific/Tarawa","Pacific/Wake","Pacific/Wallis","Pacific/Chatham","Pacific/Apia","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Tongatapu","Pacific/Kiritimati"],"description":"Time zone of the user. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."},"UserDisplayPreferences":{"type":"object","nullable":true,"properties":{"columns":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"boolean"}}},"orderBy":{"type":"object","additionalProperties":{"type":"string"}},"sort":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}}},"required":["columns","orderBy","sort"],"description":"Display preferences of the user."},"User":{"type":"object","properties":{"object":{"type":"string","enum":["user"]},"id":{"type":"string","minLength":4,"description":"ID of the user."},"sort":{"type":"number","description":"Sorting order of this user."},"createdAt":{"type":"string","description":"Date when this user was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this user was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this user is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this user is not deleted, this value is null."},"name":{"type":"string","minLength":3,"maxLength":10000,"description":"Full or legal name of the user."},"email":{"type":"string","minLength":3,"format":"email","description":"Email address of the user."},"timeZone":{"$ref":"#/components/schemas/TimeZone"},"displayPreferences":{"$ref":"#/components/schemas/UserDisplayPreferences"}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","email","timeZone","displayPreferences"]},"UserCreate":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":10000,"description":"Full or legal name of the user."},"email":{"type":"string","minLength":3,"format":"email","description":"Email address of the user."},"timeZone":{"$ref":"#/components/schemas/TimeZone"},"displayPreferences":{"$ref":"#/components/schemas/UserDisplayPreferences"}},"required":["name","email","timeZone","displayPreferences"]},"UserUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":10000,"description":"Full or legal name of the user."},"email":{"type":"string","minLength":3,"format":"email","description":"Email address of the user."},"timeZone":{"$ref":"#/components/schemas/TimeZone"},"displayPreferences":{"$ref":"#/components/schemas/UserDisplayPreferences"}}},"EducationWorkHistoryItem":{"type":"object","properties":{"current":{"type":"boolean"},"start":{"type":"string"},"end":{"type":"string"},"organization":{"type":"string"},"title":{"type":"string"},"raw":{"nullable":true}},"required":["current","start","organization"]},"EmailAddress":{"type":"object","properties":{"object":{"type":"string","enum":["emailAddress"]},"id":{"type":"string","minLength":4,"description":"ID of the email address."},"sort":{"type":"number","description":"Sorting order of this email address."},"createdAt":{"type":"string","description":"Date when this email address was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this email address was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this email address is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this email address is not deleted, this value is null."},"email":{"type":"string","minLength":3,"format":"email","description":"Email address in the RFC 5322 format, i.e., local@domain."},"domainAgeDays":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true,"description":"Number of days the domain has been registered."},"isFreeEmail":{"type":"boolean","nullable":true,"description":"Whether the email is a free email registered with a public email provider (e.g., Gmail, Yahoo)."},"hasMxRecord":{"type":"boolean","nullable":true,"description":"Whether the domain has an active and available MX record for receiving emails."},"mxRecord":{"type":"string","nullable":true,"maxLength":10000,"description":"MX record of the domain."},"processedAt":{"type":"string","nullable":true,"description":"Date and time the email address's details were processed. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"smtpProvider":{"type":"string","nullable":true,"maxLength":10000,"description":"SMTP provider of the domain. This value is only available if the domain has an active and available MX record from a known provider."},"status":{"type":"string","enum":["ABUSE","CATCH_ALL","DO_NOT","INVALID","SPAMTRAP","UNKNOWN","VALID"],"description":"Current status of the email address."},"subStatus":{"type":"string","nullable":true,"enum":["ALIAS_ADDRESS","ALTERNATE","ANTISPAM_SYSTEM","DISPOSABLE","DOES_NOT_ACCEPT","EXCEPTION_OCCURRED","FAILED_SMTP_CONNECTION","FAILED_SYNTAX_CHECK","FORCIBLE_DISCONNECT","GLOBAL_SUPPRESSION","GREYLISTED","LEADING_PERIOD_REMOVED","MAIL_SERVER_DID_NOT_RESPOND","MAIL_SERVER_TEMPORARY_ERROR","MAILBOX_NOT_FOUND","MAILBOX_QUOTA_EXCEEDED","NO_DNS_ENTRIES","POSSIBLE_TRAP","POSSIBLE_TYPO","ROLE_BASED","ROLE_BASED_CATCH_ALL","TIMEOUT_EXCEEDED","TOXIC","UNROUTABLE_IP_ADDRESS"],"description":"Sub-status of the email address."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the email address is associated with."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the email address is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","email","domainAgeDays","isFreeEmail","hasMxRecord","mxRecord","processedAt","smtpProvider","status","subStatus","contactId","organizationId"]},"Domain":{"type":"object","properties":{"object":{"type":"string","enum":["domain"]},"id":{"type":"string","minLength":4,"description":"ID of the domain."},"sort":{"type":"number","description":"Sorting order of this domain."},"createdAt":{"type":"string","description":"Date when this domain was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this domain was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this domain is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this domain is not deleted, this value is null."},"name":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain name."},"companyId":{"type":"string","minLength":4,"description":"ID of the company the domain is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","companyId"]},"ViewFilters":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string"},"condition":{"type":"string"},"value":{"anyOf":[{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}},"required":["value","label"]},{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}},"required":["value","label"]}}]}},"required":["property","condition","value"]},"description":"Filters of the view."},"View":{"type":"object","properties":{"object":{"type":"string","enum":["view"]},"id":{"type":"string","minLength":4,"description":"ID of the view."},"sort":{"type":"number","description":"Sorting order of this view."},"createdAt":{"type":"string","description":"Date when this view was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this view was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this view is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this view is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the view."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the view."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the view."},"filters":{"$ref":"#/components/schemas/ViewFilters"},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the view is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","description","target","filters","organizationId"]},"PropertyView":{"type":"object","properties":{"object":{"type":"string","enum":["propertyView"]},"id":{"type":"string","minLength":4,"description":"ID of the property view."},"sort":{"type":"number","description":"Sorting order of this property view."},"createdAt":{"type":"string","description":"Date when this property view was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this property view was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this property view is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this property view is not deleted, this value is null."},"propertyId":{"type":"string","minLength":4,"description":"ID of the property the view is associated with."},"view":{"$ref":"#/components/schemas/View"},"viewId":{"type":"string","minLength":4,"description":"ID of the view the property view is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","propertyId","view","viewId"]},"ImportData":{"type":"object","properties":{"webhook":{"type":"object","properties":{"hash":{"type":"string","minLength":1,"maxLength":10000,"description":"Hash of the webhook."}},"required":["hash"]},"internalLabel":{"type":"string","description":"Internal label of the import."}},"description":"Data of the import."},"Import":{"type":"object","properties":{"object":{"type":"string","enum":["import"]},"id":{"type":"string","minLength":4,"description":"ID of the import."},"sort":{"type":"number","description":"Sorting order of this import."},"createdAt":{"type":"string","description":"Date when this import was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this import was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this import is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this import is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the import."},"type":{"type":"string","enum":["API","FILE_IMPORT","MANUAL","WEBHOOK","APOLLO_IO","EMAIL","SUGGESTION"],"description":"Type of the import."},"zapier":{"type":"string","nullable":true,"enum":["AIRTABLE","SHOPIFY","NOTION","STRIPE","WEBFLOW","COGNITO_FORMS","CONVERTKIT","FORMSTACK","GOOGLE_FORMS","GUMROAD","KLAVIYO","LOOPS","MAILCHIMP","NINJA_FORMS","SURVEY_MONKEY","TALLY","TYPEFORM","ZOHO_FORMS"],"description":"Zapier app of the import."},"app":{"type":"string","nullable":true,"enum":["RB2B","SEGMENT","VECTOR","ZAPIER","CAL_DOT_COM","HUBSPOT"],"description":"App of the import."},"data":{"$ref":"#/components/schemas/ImportData"},"order":{"type":"string","enum":["CHRONOLOGICAL","RANDOM"],"description":"Order of the import."},"status":{"type":"string","enum":["PENDING","IMPORTING","IMPORTED"],"description":"Status of the import."},"event":{"type":"boolean","description":"Whether the import is an event."},"enrich":{"type":"boolean","description":"Whether the import is an enrichment."},"logs":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Logs of the import."},"total":{"type":"number","nullable":true,"description":"Total number of rows in the import."},"version":{"type":"string","description":"Version of the import. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"note":{"type":"string","nullable":true,"maxLength":10000,"description":"Note of the import."},"authorId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the membership that created the import."},"archiveImported":{"type":"boolean","description":"Whether to archive the imported contacts."},"processImported":{"type":"boolean","description":"Whether to process the imported contacts."},"connectExisting":{"type":"boolean","description":"Whether to connect existing contacts to the import."},"prospectingStatus":{"type":"string","nullable":true,"enum":["PROSPECTING","PROSPECTED"],"description":"Status of the prospecting."},"recurringCount":{"type":"number","nullable":true,"description":"Number of recurring rows in the import."},"recurringUnit":{"type":"string","nullable":true,"enum":["DAY","WEEK","MONTH"],"description":"Unit of the recurring rows in the import."},"qualificationCompanyWebsiteDown":{"type":"boolean","description":"Whether rows should be unqualified if their company website is down."},"qualificationContactEmailFreeDomain":{"type":"boolean","description":"Whether rows should be unqualified if their contact email is from a free domain."},"qualificationContactEmailInvalid":{"type":"boolean","description":"Whether rows should be unqualified if their contact email is invalid."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the import is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","type","zapier","app","data","order","status","event","enrich","logs","total","version","note","authorId","archiveImported","processImported","connectExisting","prospectingStatus","recurringCount","recurringUnit","qualificationCompanyWebsiteDown","qualificationContactEmailFreeDomain","qualificationContactEmailInvalid","organizationId"]},"PropertyImport":{"type":"object","properties":{"object":{"type":"string","enum":["propertyImport"]},"id":{"type":"string","minLength":4,"description":"ID of the property import."},"sort":{"type":"number","description":"Sorting order of this property import."},"createdAt":{"type":"string","description":"Date when this property import was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this property import was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this property import is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this property import is not deleted, this value is null."},"propertyId":{"type":"string","minLength":4,"description":"ID of the property the import is associated with."},"import":{"$ref":"#/components/schemas/Import"},"importId":{"type":"string","minLength":4,"description":"ID of the import the property is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","propertyId","import","importId"]},"SendingSchedule":{"type":"object","nullable":true,"properties":{"enabledWeekdays":{"type":"object","properties":{"monday":{"type":"object","properties":{"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"}},"required":["start","end"],"description":"Schedule for sending emails on a particular weekday."},"tuesday":{"type":"object","properties":{"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"}},"required":["start","end"],"description":"Schedule for sending emails on a particular weekday."},"wednesday":{"type":"object","properties":{"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"}},"required":["start","end"],"description":"Schedule for sending emails on a particular weekday."},"thursday":{"type":"object","properties":{"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"}},"required":["start","end"],"description":"Schedule for sending emails on a particular weekday."},"friday":{"type":"object","properties":{"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"}},"required":["start","end"],"description":"Schedule for sending emails on a particular weekday."},"saturday":{"type":"object","properties":{"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"}},"required":["start","end"],"description":"Schedule for sending emails on a particular weekday."},"sunday":{"type":"object","properties":{"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):([0-5]\\d)$"}},"required":["start","end"],"description":"Schedule for sending emails on a particular weekday."}},"description":"Schedule for sending emails."},"sendFirstMessageImmediately":{"type":"boolean","description":"If true, the first message will be sent immediately after the contact is added to the campaign, ignoring the schedule."},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"description":"Time zone of the sending schedule. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]}},"required":["enabledWeekdays"],"description":"Sending schedule of the campaign."},"CampaignImport":{"type":"object","properties":{"object":{"type":"string","enum":["campaignImport"]},"id":{"type":"string","minLength":4,"description":"ID of the campaign import."},"sort":{"type":"number","description":"Sorting order of this campaign import."},"createdAt":{"type":"string","description":"Date when this campaign import was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaign import was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaign import is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaign import is not deleted, this value is null."},"import":{"$ref":"#/components/schemas/Import"},"importId":{"type":"string","minLength":4,"description":"ID of the import."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","import","importId","campaignId"]},"Pipeline":{"type":"object","properties":{"object":{"type":"string","enum":["pipeline"]},"id":{"type":"string","minLength":4,"description":"ID of the pipeline."},"sort":{"type":"number","description":"Sorting order of this pipeline."},"createdAt":{"type":"string","description":"Date when this pipeline was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this pipeline was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this pipeline is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this pipeline is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the pipeline."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the pipeline."},"defaultValue":{"type":"string","description":"Default value of the pipeline."},"valueDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the default value of the pipeline."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the pipeline is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","description","defaultValue","valueDescription","organizationId"]},"CampaignPipeline":{"type":"object","properties":{"object":{"type":"string","enum":["campaignPipeline"]},"id":{"type":"string","minLength":4,"description":"ID of the campaign pipeline."},"sort":{"type":"number","description":"Sorting order of this campaign pipeline."},"createdAt":{"type":"string","description":"Date when this campaign pipeline was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaign pipeline was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaign pipeline is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaign pipeline is not deleted, this value is null."},"pipeline":{"$ref":"#/components/schemas/Pipeline"},"pipelineId":{"type":"string","minLength":4,"description":"ID of the pipeline."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","pipeline","pipelineId","campaignId"]},"CampaignView":{"type":"object","properties":{"object":{"type":"string","enum":["campaignView"]},"id":{"type":"string","minLength":4,"description":"ID of the campaign view."},"sort":{"type":"number","description":"Sorting order of this campaign view."},"createdAt":{"type":"string","description":"Date when this campaign view was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaign view was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaign view is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaign view is not deleted, this value is null."},"view":{"$ref":"#/components/schemas/View"},"viewId":{"type":"string","minLength":4,"description":"ID of the view."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","view","viewId","campaignId"]},"Campaign":{"type":"object","properties":{"object":{"type":"string","enum":["campaign"]},"id":{"type":"string","minLength":4,"description":"ID of the campaign."},"sort":{"type":"number","description":"Sorting order of this campaign."},"createdAt":{"type":"string","description":"Date when this campaign was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaign was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaign is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaign is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the campaign."},"status":{"type":"string","enum":["DRAFT","RUNNING","COMPLETED"],"description":"Status of the campaign."},"version":{"type":"string","description":"Version of the campaign. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"autopilot":{"type":"boolean","description":"Whether the campaign is autopilot."},"autopilotOffHistory":{"type":"boolean","description":"Whether autopilot should be turned off for contacts with a conversation history."},"adjustment":{"type":"boolean","description":"Whether the campaign is adjustment."},"openTracking":{"type":"boolean","description":"Whether the campaign is open tracking."},"openTrackingAll":{"type":"boolean","description":"Whether to track opens for all emails."},"clickTracking":{"type":"boolean","description":"Whether the campaign is click tracking."},"offeringName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the offering."},"offeringUrl":{"type":"string","nullable":true,"description":"URL of the offering."},"offeringDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the offering."},"sendingSchedule":{"$ref":"#/components/schemas/SendingSchedule"},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization."},"imports":{"type":"array","items":{"$ref":"#/components/schemas/CampaignImport"},"description":"Imports associated with the campaign."},"pipelines":{"type":"array","items":{"$ref":"#/components/schemas/CampaignPipeline"},"description":"Pipelines associated with the campaign."},"views":{"type":"array","items":{"$ref":"#/components/schemas/CampaignView"},"description":"Views associated with the campaign."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","status","version","autopilot","autopilotOffHistory","adjustment","openTracking","openTrackingAll","clickTracking","offeringName","offeringUrl","offeringDescription","sendingSchedule","organizationId","imports","pipelines","views"]},"PropertyCampaign":{"type":"object","properties":{"object":{"type":"string","enum":["propertyCampaign"]},"id":{"type":"string","minLength":4,"description":"ID of the property campaign."},"sort":{"type":"number","description":"Sorting order of this property campaign."},"createdAt":{"type":"string","description":"Date when this property campaign was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this property campaign was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this property campaign is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this property campaign is not deleted, this value is null."},"propertyId":{"type":"string","minLength":4,"description":"ID of the property the campaign is associated with."},"campaign":{"$ref":"#/components/schemas/Campaign"},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign the property is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","propertyId","campaign","campaignId"]},"Property":{"type":"object","properties":{"object":{"type":"string","enum":["property"]},"id":{"type":"string","minLength":4,"description":"ID of the property."},"sort":{"type":"number","description":"Sorting order of this property."},"createdAt":{"type":"string","description":"Date when this property was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this property was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this property is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this property is not deleted, this value is null."},"type":{"type":"string","enum":["BOOLEAN","DATETIME","MULTI_SELECT","NUMBER","SELECT","STRING"],"description":"Type of the property."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the property."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the property."},"source":{"type":"string","enum":["EXISTING_PROPERTIES","MANUAL_INPUT","WEB_SEARCH"],"description":"Source of the property."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the property."},"visible":{"type":"boolean","description":"Whether the property is visible."},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Options for the property."},"enrichAll":{"type":"boolean","description":"Whether to enrich all values for the property."},"generatedQueries":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Queries generated for the property."},"generatedDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Description generated for the property."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the property is associated with."},"views":{"type":"array","items":{"$ref":"#/components/schemas/PropertyView"},"description":"Views associated with the property."},"imports":{"type":"array","items":{"$ref":"#/components/schemas/PropertyImport"},"description":"Imports associated with the property."},"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/PropertyCampaign"},"description":"Campaigns associated with the property."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","type","name","description","source","target","visible","options","enrichAll","generatedQueries","generatedDescription","organizationId","views","imports","campaigns"]},"Value":{"type":"object","properties":{"object":{"type":"string","enum":["value"]},"id":{"type":"string","minLength":4,"description":"ID of the value."},"sort":{"type":"number","description":"Sorting order of this value."},"createdAt":{"type":"string","description":"Date when this value was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this value was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this value is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this value is not deleted, this value is null."},"reasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"Reasoning for the status of the property value."},"status":{"type":"string","enum":["EMPTY","ENRICHED_KNOWN","ENRICHED_UNKNOWN","MANUAL_INPUT"],"description":"Status of the property value."},"citations":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Citations for the property value."},"valueAsBoolean":{"type":"boolean","nullable":true,"description":"Value of the property as a boolean."},"valueAsDateTime":{"type":"string","nullable":true,"description":"Value of the property as a date."},"valueAsFormatted":{"type":"string","nullable":true,"maxLength":10000,"description":"Value of the property as a formatted string."},"valueAsNumber":{"type":"string","nullable":true,"description":"Value of the property as a number."},"valueAsSelect":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Value of the property as a select."},"valueAsString":{"type":"string","nullable":true,"maxLength":10000,"description":"Value of the property as a string."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the value is associated with."},"companyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the company the value is associated with."},"property":{"$ref":"#/components/schemas/Property"},"propertyId":{"type":"string","minLength":4,"description":"ID of the property the value is associated with."},"enrichmentUsageId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the enrichment usage the value is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","reasoning","status","citations","valueAsBoolean","valueAsDateTime","valueAsFormatted","valueAsNumber","valueAsSelect","valueAsString","contactId","companyId","property","propertyId","enrichmentUsageId"]},"Company":{"type":"object","properties":{"object":{"type":"string","enum":["company"]},"id":{"type":"string","minLength":4,"description":"ID of the company."},"sort":{"type":"number","description":"Sorting order of this company."},"createdAt":{"type":"string","description":"Date when this company was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this company was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this company is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this company is not deleted, this value is null."},"createdReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"Reasoning for creating the contact."},"enrichedAt":{"type":"string","nullable":true,"description":"Date when the contact was enriched. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastActivityAt":{"type":"string","nullable":true,"description":"Most recent time an activity was performed on the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastSentAt":{"type":"string","nullable":true,"description":"Most recent time an email was sent to the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastReceivedAt":{"type":"string","nullable":true,"description":"Most recent time an email was received from the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"nextSendAt":{"type":"string","nullable":true,"description":"Next time an email is scheduled to be sent to the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Legal name of the company."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or brand name of the company without suffixes like Inc and LLC."},"subtitle":{"type":"string","nullable":true,"maxLength":10000,"description":"Short description of the company."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the company."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the company's logo as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the company's website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the company's primary headquarters."},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the company's primary headquarters. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"annualRevenue":{"type":"string","nullable":true,"description":"Annual revenue of the company in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"employeesCount":{"type":"number","nullable":true,"description":"Number of employees that currently work at the company."},"foundedYear":{"type":"number","nullable":true,"description":"Year the company was founded."},"fundingStage":{"type":"string","nullable":true,"maxLength":10000,"description":"Current funding stage."},"fundingTotal":{"type":"string","nullable":true,"description":"Total funding the company has raised in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"retailLocationsCount":{"type":"number","nullable":true,"description":"Number of retail locations of the company. Only applicable to companies that operate physical stores."},"ticker":{"type":"string","nullable":true,"maxLength":10000,"description":"Stock ticker symbol of the company. Only applicable to publicly traded companies."},"industries":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Industries the company operates in."},"languages":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Spoken languages the company's website is available is."},"stack":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Technologies used on the company's website."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Tags associated with the company."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the organization from the Apollo.io service."},"source":{"type":"string","enum":["API","FILE_IMPORT","MANUAL","WEBHOOK","APOLLO_IO","EMAIL","SUGGESTION"],"description":"Source of the row."},"sourceImportId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the import the row was created from."},"sourceApiKeyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API key that the row was created from."},"sourceFileId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the uploaded file that the row was created from."},"sourceRequestId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API request that the row was created from."},"sourceSessionId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the session that the row was created from."},"bioNicknameGeneratedAt":{"type":"string","nullable":true,"description":"Date when the bio and nickname for the company was generated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"unsubscribeActivityId":{"type":"string","nullable":true,"minLength":4,"description":"If the company has been unsubscribed from all campaigns, the ID of the activity when the happened."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the company belongs to."},"parentId":{"type":"string","nullable":true,"minLength":4,"description":"If the company is a subsidiary of another company, the ID of the parent company."},"enrichmentUsageId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the enrichment usage the company is associated with."},"domains":{"type":"array","items":{"$ref":"#/components/schemas/Domain"},"description":"Domains associated with the company."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the company."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","createdReasoning","enrichedAt","lastActivityAt","lastSentAt","lastReceivedAt","nextSendAt","name","nickname","subtitle","bio","avatar","website","location","timeZone","facebookHandle","gitHubHandle","instagramHandle","linkedInHandle","xHandle","annualRevenue","employeesCount","foundedYear","fundingStage","fundingTotal","retailLocationsCount","ticker","industries","languages","stack","tags","externalIdApollo","source","sourceImportId","sourceApiKeyId","sourceFileId","sourceRequestId","sourceSessionId","bioNicknameGeneratedAt","unsubscribeActivityId","organizationId","parentId","enrichmentUsageId","domains","properties"]},"Stage":{"type":"object","properties":{"object":{"type":"string","enum":["stage"]},"id":{"type":"string","minLength":4,"description":"ID of the stage."},"sort":{"type":"number","description":"Sorting order of this stage."},"createdAt":{"type":"string","description":"Date when this stage was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this stage was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this stage is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this stage is not deleted, this value is null."},"count":{"type":"integer","description":"Count of the stage in the pipeline."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the stage."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the stage."},"goal":{"type":"string","minLength":1,"maxLength":10000,"description":"Goal of the stage."},"goalUrl":{"type":"string","nullable":true,"description":"URL of the goal of the stage."},"weight":{"type":"integer","description":"Weight of the stage in the pipeline."},"pipeline":{"$ref":"#/components/schemas/Pipeline"},"pipelineId":{"type":"string","minLength":4,"description":"ID of the pipeline the stage is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","count","name","description","goal","goalUrl","weight","pipeline","pipelineId"]},"Deal":{"type":"object","properties":{"object":{"type":"string","enum":["deal"]},"id":{"type":"string","minLength":4,"description":"ID of the deal."},"sort":{"type":"number","description":"Sorting order of this deal."},"createdAt":{"type":"string","description":"Date when this deal was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this deal was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this deal is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this deal is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the deal."},"status":{"type":"string","enum":["OPEN","WON","LOST"],"description":"Status of the deal."},"value":{"type":"string","description":"Value of the deal in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"createdReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"Reasoning for the creation of the deal."},"wonAt":{"type":"string","nullable":true,"description":"Date when the deal was won. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lostAt":{"type":"string","nullable":true,"description":"Date when the deal was lost. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"stage":{"$ref":"#/components/schemas/Stage"},"stageId":{"type":"string","minLength":4,"description":"ID of the stage the deal is associated with."},"company":{"$ref":"#/components/schemas/Company"},"companyId":{"type":"string","minLength":4,"description":"ID of the company the deal is associated with."},"ownerId":{"type":"string","minLength":4,"description":"ID of the membership the deal is associated with."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the deal is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","status","value","createdReasoning","wonAt","lostAt","stage","stageId","company","companyId","ownerId","organizationId"]},"PointOfContact":{"type":"object","properties":{"object":{"type":"string","enum":["pointOfContact"]},"id":{"type":"string","minLength":4,"description":"ID of the point of contact."},"sort":{"type":"number","description":"Sorting order of this point of contact."},"createdAt":{"type":"string","description":"Date when this point of contact was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this point of contact was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this point of contact is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this point of contact is not deleted, this value is null."},"removedAt":{"type":"string","nullable":true,"description":"Date when the point of contact was removed. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deal":{"$ref":"#/components/schemas/Deal"},"dealId":{"type":"string","minLength":4,"description":"ID of the deal the point of contact is associated with."},"employmentId":{"type":"string","minLength":4,"description":"ID of the employment the point of contact is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","removedAt","deal","dealId","employmentId"]},"Employment":{"type":"object","properties":{"object":{"type":"string","enum":["employment"]},"id":{"type":"string","minLength":4,"description":"ID of the employment."},"sort":{"type":"number","description":"Sorting order of this employment."},"createdAt":{"type":"string","description":"Date when this employment was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this employment was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this employment is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this employment is not deleted, this value is null."},"title":{"type":"string","nullable":true,"maxLength":10000,"description":"The title of the employment."},"seniority":{"type":"string","nullable":true,"enum":["A_INTERN","B_ENTRY","C_SENIOR","D_MANAGER","E_LEAD_DIRECTOR_HEAD","F_EXECUTIVE","G_FOUNDER","H_OWNER"],"description":"The seniority of the employment."},"contactId":{"type":"string","minLength":4,"description":"ID of the contact the employment is associated with."},"company":{"$ref":"#/components/schemas/Company"},"companyId":{"type":"string","minLength":4,"description":"ID of the company the employment is associated with."},"deals":{"type":"array","items":{"$ref":"#/components/schemas/PointOfContact"},"description":"Deals associated with the employment."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","title","seniority","contactId","company","companyId","deals"]},"ContactWithoutRelations":{"type":"object","properties":{"object":{"type":"string","enum":["contact"]},"id":{"type":"string","minLength":4,"description":"ID of the contact."},"sort":{"type":"number","description":"Sorting order of this contact."},"createdAt":{"type":"string","description":"Date when this contact was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this contact was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this contact is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this contact is not deleted, this value is null."},"internal":{"type":"boolean","description":"Whether the contact is internal to the organization."},"createdReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"Reasoning for creating the contact."},"enrichedAt":{"type":"string","nullable":true,"description":"Date when the contact was enriched. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastActivityAt":{"type":"string","nullable":true,"description":"Most recent time an activity was performed on the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastSentAt":{"type":"string","nullable":true,"description":"Most recent time an email was sent to the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastReceivedAt":{"type":"string","nullable":true,"description":"Most recent time an email was received from the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"nextSendAt":{"type":"string","nullable":true,"description":"Next time an email is scheduled to be sent to the contact. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"firstSyncedAt":{"type":"string","nullable":true,"description":"Date when the contact was first synced. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastSyncedAt":{"type":"string","nullable":true,"description":"Date when the contact was last synced. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"processingAt":{"type":"string","nullable":true,"description":"Date when the contact last started processing. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastProcessedAt":{"type":"string","nullable":true,"description":"Date when the contact was last processed. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"firstProcessedAt":{"type":"string","nullable":true,"description":"Date when the contact was first processed. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"lastNurturedAt":{"type":"string","nullable":true,"description":"Date when the contact was last nurtured. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"unacceptedCount":{"type":"integer","minimum":0,"description":"Number of unaccepted actions for the contact."},"summary":{"type":"string","nullable":true,"maxLength":10000,"description":"Summary of the contact."},"summaryUpdatedAt":{"type":"string","nullable":true,"description":"Date when the contact's summary was last updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Full name of the contact."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or preferred name of the contact, such as their first name."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the contact, typically sourced from their social media bio."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the contact's profile picture as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the contact's personal website."},"domain":{"type":"string","nullable":true,"pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the contact's personal website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the contact's residence"},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the contact's residential location. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"strength":{"type":"integer","minimum":0,"description":"Relationship strength with the contact."},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"educationHistory":{"type":"array","items":{"$ref":"#/components/schemas/EducationWorkHistoryItem"},"description":"Education history of the contact."},"employmentHistory":{"type":"array","items":{"$ref":"#/components/schemas/EducationWorkHistoryItem"},"description":"Employment history of the contact."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the contact from the Apollo.io service."},"source":{"type":"string","enum":["API","FILE_IMPORT","MANUAL","WEBHOOK","APOLLO_IO","EMAIL","SUGGESTION"],"description":"Source of the row."},"sourceImportId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the import the row was created from."},"sourceApiKeyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API key that the row was created from."},"sourceFileId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the uploaded file that the row was created from."},"sourceRequestId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API request that the row was created from."},"sourceSessionId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the session that the row was created from."},"archiveActivityId":{"type":"string","nullable":true,"minLength":4,"description":"If the contact has been archived, the ID of the activity when the happened."},"unsubscribeActivityId":{"type":"string","nullable":true,"minLength":4,"description":"If the contact has been unsubscribed from all campaigns, the ID of the activity when the happened."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the contact belongs to."},"enrichmentUsageId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the enrichment usage the contact is associated with."},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"},"description":"Email addresses of the contact."},"mergedWithId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact that this contact was merged with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","internal","createdReasoning","enrichedAt","lastActivityAt","lastSentAt","lastReceivedAt","nextSendAt","firstSyncedAt","lastSyncedAt","processingAt","lastProcessedAt","firstProcessedAt","lastNurturedAt","unacceptedCount","summary","summaryUpdatedAt","name","nickname","bio","avatar","website","domain","location","timeZone","strength","facebookHandle","gitHubHandle","instagramHandle","linkedInHandle","xHandle","educationHistory","employmentHistory","externalIdApollo","source","sourceImportId","sourceApiKeyId","sourceFileId","sourceRequestId","sourceSessionId","archiveActivityId","unsubscribeActivityId","organizationId","enrichmentUsageId","emailAddresses","mergedWithId"]},"Contact":{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}]},"Organization":{"type":"object","properties":{"object":{"type":"string","enum":["organization"]},"id":{"type":"string","minLength":4,"description":"ID of the organization."},"sort":{"type":"number","description":"Sorting order of this organization."},"createdAt":{"type":"string","description":"Date when this organization was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this organization was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this organization is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this organization is not deleted, this value is null."},"slug":{"type":"string","minLength":3,"maxLength":64,"pattern":"^[a-z0-9-]+$","description":"Unique identifier for the organization."},"hidden":{"type":"boolean","description":"Whether the organization is hidden."},"enabled":{"type":"boolean","description":"Whether the organization is enabled."},"sendingSchedule":{"allOf":[{"$ref":"#/components/schemas/SendingSchedule"},{"description":"Schedule for sending emails."}]},"minWaitMinutes":{"type":"integer","nullable":true,"description":"Minimum wait minutes of the organization."},"campaignDailyLimit":{"type":"integer","nullable":true,"description":"Campaign daily limit of the organization."},"campaignRampUp":{"type":"integer","nullable":true,"description":"Campaign ramp up of the organization."},"followUpSeconds":{"type":"array","items":{"type":"integer","nullable":true},"description":"Follow up seconds of the organization."},"sandbox":{"type":"boolean","description":"Whether the organization is in sandbox mode."},"openTracking":{"type":"boolean","description":"Whether to track email opens by injecting a tracking pixel."},"openTrackingAll":{"type":"boolean","description":"Whether to track opens for all emails."},"clickTracking":{"type":"boolean","description":"Whether to track email link clicks by wrapping links with tracking URLs."},"dailySuggestionsLimit":{"type":"integer","nullable":true,"minimum":0,"maximum":1000,"description":"Maximum number of suggestions allowed per day."},"salesRelatedPrompt":{"type":"string","nullable":true,"maxLength":10000,"description":"Custom instructions for determining if an email is sales-related."},"memory":{"type":"string","nullable":true,"maxLength":10000,"description":"Memory of the organization."},"onboardingStage":{"type":"integer","nullable":true,"description":"Onboarding stage of the organization."},"autoImportEmailSalesRelated":{"type":"boolean","description":"Whether to automatically import sales-related emails."},"autoImportEmailParticipants":{"type":"boolean","description":"Whether to automatically import participant emails."},"autoImportEventSalesRelated":{"type":"boolean","description":"Whether to automatically import sales-related events."},"autoImportEventParticipants":{"type":"boolean","description":"Whether to automatically import participant events."},"autoArchiveWonDeals":{"type":"string","enum":["CREATE_TASK","AUTO_ARCHIVE","NO_ARCHIVE"],"description":"How to handle archiving points of contact when a deal is won."},"featurePreview":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Feature preview of the organization."},"suggestionsEnabled":{"type":"string","enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are enabled."},"suggestionsAutopilot":{"type":"string","enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are autopilot."},"suggestionsToday":{"type":"integer","description":"Number of suggestions run today."},"processedToday":{"type":"integer","description":"Number of emails or calendar events processed today."},"subscriptionStatus":{"type":"string","enum":["ACTIVE","INACTIVE","PAUSED","PAST_DUE","TRIAL"],"description":"Status of the subscription."},"subscriptionPeriodCreditsIncluded":{"type":"integer","description":"Number of credits included in the subscription period."},"subscriptionPeriodCreditsUsed":{"type":"integer","description":"Number of credits used in the subscription period."},"subscriptionPeriodStartedAt":{"type":"string","nullable":true,"description":"Date the subscription period started."},"subscriptionPeriodEndsAt":{"type":"string","nullable":true,"description":"Date the subscription period ends."},"subscriptionStartedAt":{"type":"string","nullable":true,"description":"Date the subscription started."},"subscriptionTrialEndsAt":{"type":"string","nullable":true,"description":"Date the subscription trial ends."},"subscriptionCancelsAt":{"type":"string","nullable":true,"description":"Date the subscription will cancel."},"subscriptionPeriodCreditsExhaustedAt":{"type":"string","nullable":true,"description":"Date the subscription period credits will be exhausted."},"subscriptionPeriodCreditsExhaustedAtOverwriteEnabled":{"type":"boolean","description":"Whether the subscription period credits will be exhausted at can be overwritten."},"subscriptionPeriodCreditsExhaustedAtOverwriteDisableAt":{"type":"string","nullable":true,"description":"Date the subscription period credits will be exhausted at can be overwritten."},"subscriptionPeriodCreditsExhaustedAtOverwriteValue":{"type":"string","nullable":true,"description":"Value of the subscription period credits will be exhausted at can be overwritten."},"subscriptionPeriodCreditsIncludedOverwriteEnabled":{"type":"boolean","description":"Whether the subscription period credits included can be overwritten."},"subscriptionPeriodCreditsIncludedOverwriteDisableAt":{"type":"string","nullable":true,"description":"Date the subscription period credits included can be overwritten."},"subscriptionPeriodCreditsIncludedOverwriteValue":{"type":"integer","nullable":true,"description":"Value of the subscription period credits included."},"subscriptionStatusOverwriteEnabled":{"type":"boolean","description":"Whether the subscription status can be overwritten."},"subscriptionStatusOverwriteDisableAt":{"type":"string","nullable":true,"description":"Date the subscription status can be overwritten."},"subscriptionStatusOverwriteValue":{"type":"string","nullable":true,"enum":["ACTIVE","INACTIVE","PAUSED","PAST_DUE","TRIAL"],"description":"Value of the subscription status."},"externalIdStripe":{"type":"string","nullable":true,"maxLength":10000,"description":"ID of the Stripe subscription."},"externalIdSlack":{"type":"string","nullable":true,"maxLength":10000,"description":"ID of the Slack workspace."},"internalCompany":{"allOf":[{"$ref":"#/components/schemas/Company"},{"nullable":true}]},"internalCompanyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the company that is the primary company for this organization."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","slug","hidden","enabled","sendingSchedule","minWaitMinutes","campaignDailyLimit","campaignRampUp","followUpSeconds","sandbox","openTracking","openTrackingAll","clickTracking","dailySuggestionsLimit","salesRelatedPrompt","memory","onboardingStage","autoImportEmailSalesRelated","autoImportEmailParticipants","autoImportEventSalesRelated","autoImportEventParticipants","autoArchiveWonDeals","featurePreview","suggestionsEnabled","suggestionsAutopilot","suggestionsToday","processedToday","subscriptionStatus","subscriptionPeriodCreditsIncluded","subscriptionPeriodCreditsUsed","subscriptionPeriodStartedAt","subscriptionPeriodEndsAt","subscriptionStartedAt","subscriptionTrialEndsAt","subscriptionCancelsAt","subscriptionPeriodCreditsExhaustedAt","subscriptionPeriodCreditsExhaustedAtOverwriteEnabled","subscriptionPeriodCreditsExhaustedAtOverwriteDisableAt","subscriptionPeriodCreditsExhaustedAtOverwriteValue","subscriptionPeriodCreditsIncludedOverwriteEnabled","subscriptionPeriodCreditsIncludedOverwriteDisableAt","subscriptionPeriodCreditsIncludedOverwriteValue","subscriptionStatusOverwriteEnabled","subscriptionStatusOverwriteDisableAt","subscriptionStatusOverwriteValue","externalIdStripe","externalIdSlack","internalCompany","internalCompanyId"]},"Membership":{"type":"object","properties":{"object":{"type":"string","enum":["membership"]},"id":{"type":"string","minLength":4,"description":"ID of the membership."},"sort":{"type":"number","description":"Sorting order of this membership."},"createdAt":{"type":"string","description":"Date when this membership was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this membership was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this membership is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this membership is not deleted, this value is null."},"active":{"type":"boolean","description":"Whether the membership is currently active."},"schedulingLink":{"type":"string","nullable":true,"description":"Scheduling link of the membership."},"signature":{"type":"string","nullable":true,"maxLength":10000,"description":"Signature of the membership."},"replyToAddress":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"Reply to address of the membership."},"user":{"$ref":"#/components/schemas/User"},"userId":{"type":"string","minLength":4,"description":"ID of the user the membership is associated with."},"contact":{"$ref":"#/components/schemas/Contact"},"contactId":{"type":"string","minLength":4,"description":"ID of the contact the membership is associated with."},"organization":{"$ref":"#/components/schemas/Organization"},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the membership is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","active","schedulingLink","signature","replyToAddress","user","userId","contact","contactId","organization","organizationId"]},"CampaignCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the campaign."},"autopilot":{"type":"boolean","description":"Whether the campaign is autopilot."},"autopilotOffHistory":{"type":"boolean","description":"Whether autopilot should be turned off for contacts with a conversation history."},"adjustment":{"type":"boolean","description":"Whether the campaign is adjustment."},"openTracking":{"type":"boolean","description":"Whether the campaign is open tracking."},"openTrackingAll":{"type":"boolean","description":"Whether to track opens for all emails."},"clickTracking":{"type":"boolean","description":"Whether the campaign is click tracking."},"offeringName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the offering."},"offeringDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the offering."},"offeringUrl":{"type":"string","nullable":true,"description":"URL of the offering."},"sendingSchedule":{"$ref":"#/components/schemas/SendingSchedule"},"status":{"type":"string","enum":["DRAFT","RUNNING","COMPLETED"],"description":"Status of the campaign."},"importIds":{"type":"array","items":{"type":"string","minLength":4}},"membershipIds":{"type":"array","items":{"type":"string","minLength":4}},"pipelineIds":{"type":"array","items":{"type":"string","minLength":4}},"viewIds":{"type":"array","items":{"type":"string","minLength":4}}},"required":["name","autopilot","autopilotOffHistory","adjustment","openTracking","openTrackingAll","clickTracking","offeringName","offeringDescription","offeringUrl","sendingSchedule"]},"CampaignUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the campaign."},"autopilot":{"type":"boolean","description":"Whether the campaign is autopilot."},"autopilotOffHistory":{"type":"boolean","description":"Whether autopilot should be turned off for contacts with a conversation history."},"adjustment":{"type":"boolean","description":"Whether the campaign is adjustment."},"openTracking":{"type":"boolean","description":"Whether the campaign is open tracking."},"openTrackingAll":{"type":"boolean","description":"Whether to track opens for all emails."},"clickTracking":{"type":"boolean","description":"Whether the campaign is click tracking."},"offeringName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the offering."},"offeringDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the offering."},"offeringUrl":{"type":"string","nullable":true,"description":"URL of the offering."},"sendingSchedule":{"$ref":"#/components/schemas/SendingSchedule"},"status":{"type":"string","enum":["DRAFT","RUNNING","COMPLETED"],"description":"Status of the campaign."},"importIds":{"type":"array","items":{"type":"string","minLength":4}},"membershipIds":{"type":"array","items":{"type":"string","minLength":4}},"pipelineIds":{"type":"array","items":{"type":"string","minLength":4}},"viewIds":{"type":"array","items":{"type":"string","minLength":4}}}},"QueueEvent":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]},"FineTuningCampaign":{"type":"object","properties":{"object":{"type":"string","enum":["fineTuningCampaign"]},"id":{"type":"string","minLength":4,"description":"ID of the fine-tuning campaign."},"sort":{"type":"number","description":"Sorting order of this fine-tuning campaign."},"createdAt":{"type":"string","description":"Date when this fine-tuning campaign was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this fine-tuning campaign was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this fine-tuning campaign is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this fine-tuning campaign is not deleted, this value is null."},"statuses":{"type":"array","items":{"type":"string","enum":["PENDING","SEQUENCED","RUNNING","COMPLETED"]},"description":"Statuses of the fine-tuning campaign."},"campaign":{"$ref":"#/components/schemas/Campaign"},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign the fine-tuning campaign is associated with."},"fineTuningId":{"type":"string","minLength":4,"description":"ID of the fine-tuning the fine-tuning campaign is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","statuses","campaign","campaignId","fineTuningId"]},"FineTuningImport":{"type":"object","properties":{"object":{"type":"string","enum":["fineTuningImport"]},"id":{"type":"string","minLength":4,"description":"ID of the fine-tuning import."},"sort":{"type":"number","description":"Sorting order of this fine-tuning import."},"createdAt":{"type":"string","description":"Date when this fine-tuning import was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this fine-tuning import was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this fine-tuning import is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this fine-tuning import is not deleted, this value is null."},"statuses":{"type":"array","items":{"type":"string","enum":["PENDING","SEQUENCED","RUNNING","COMPLETED"]},"description":"Statuses of the fine-tuning import."},"import":{"$ref":"#/components/schemas/Import"},"importId":{"type":"string","minLength":4,"description":"ID of the import the fine-tuning import is associated with."},"fineTuningId":{"type":"string","minLength":4,"description":"ID of the fine-tuning the fine-tuning import is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","statuses","import","importId","fineTuningId"]},"FineTuningView":{"type":"object","properties":{"object":{"type":"string","enum":["fineTuningView"]},"id":{"type":"string","minLength":4,"description":"ID of the fine-tuning view."},"sort":{"type":"number","description":"Sorting order of this fine-tuning view."},"createdAt":{"type":"string","description":"Date when this fine-tuning view was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this fine-tuning view was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this fine-tuning view is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this fine-tuning view is not deleted, this value is null."},"statuses":{"type":"array","items":{"type":"string","enum":["PENDING","UNQUALIFIED","QUALIFIED"]},"description":"Statuses of the fine-tuning view."},"view":{"$ref":"#/components/schemas/View"},"viewId":{"type":"string","minLength":4,"description":"ID of the view the fine-tuning view is associated with."},"fineTuningId":{"type":"string","minLength":4,"description":"ID of the fine-tuning the fine-tuning view is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","statuses","view","viewId","fineTuningId"]},"FineTuningPipeline":{"type":"object","properties":{"object":{"type":"string","enum":["fineTuningPipeline"]},"id":{"type":"string","minLength":4,"description":"ID of the fine-tuning pipeline."},"sort":{"type":"number","description":"Sorting order of this fine-tuning pipeline."},"createdAt":{"type":"string","description":"Date when this fine-tuning pipeline was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this fine-tuning pipeline was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this fine-tuning pipeline is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this fine-tuning pipeline is not deleted, this value is null."},"statuses":{"type":"array","items":{"type":"string","enum":["OPEN","WON","LOST"]},"description":"Statuses of the fine-tuning pipeline."},"pipeline":{"$ref":"#/components/schemas/Pipeline"},"pipelineId":{"type":"string","minLength":4,"description":"ID of the pipeline the fine-tuning pipeline is associated with."},"fineTuningId":{"type":"string","minLength":4,"description":"ID of the fine-tuning the fine-tuning pipeline is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","statuses","pipeline","pipelineId","fineTuningId"]},"FineTuning":{"type":"object","properties":{"object":{"type":"string","enum":["fineTuning"]},"id":{"type":"string","minLength":4,"description":"ID of the fine-tuning."},"sort":{"type":"number","description":"Sorting order of this fine-tuning."},"createdAt":{"type":"string","description":"Date when this fine-tuning was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this fine-tuning was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this fine-tuning is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this fine-tuning is not deleted, this value is null."},"priority":{"type":"number","description":"Priority of the fine-tuning."},"trigger":{"type":"string","enum":["CALENDAR_EVENT_DELETED","CALENDAR_EVENT_RESPONSE_MAYBE","CALENDAR_EVENT_RESPONSE_NO","CALENDAR_EVENT_RESPONSE_YES","COMPANY_UNSUBSCRIBED","CONTACT_UNSUBSCRIBED","EMAIL_LINK_CLICKED","EMAIL_RECEIVED","GENERAL_RULE","KNOWLEDGE_ENTRY","NOTE_ADDED","NURTURING"],"description":"Trigger of the fine-tuning."},"instructions":{"type":"string","minLength":1,"maxLength":10000,"description":"Instructions of the fine-tuning."},"autopilot":{"type":"boolean","description":"Autopilot of the fine-tuning."},"allCampaigns":{"type":"boolean","description":"All campaigns of the fine-tuning."},"allImports":{"type":"boolean","description":"All imports of the fine-tuning."},"allPipelines":{"type":"boolean","description":"All pipelines of the fine-tuning."},"allViews":{"type":"boolean","description":"All views of the fine-tuning."},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the fine-tuning."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the fine-tuning."},"color":{"type":"string","nullable":true,"maxLength":10000,"description":"Color of the fine-tuning."},"cadenceMonths":{"type":"integer","nullable":true,"minimum":1,"maximum":256,"description":"Cadence of the fine-tuning in months."},"count":{"type":"integer","nullable":true,"minimum":1,"maximum":256,"description":"Number of contacts to nurture with the fine-tuning."},"anchor":{"type":"string","nullable":true,"enum":["CONTACT_CREATED_AT","DEAL_LOST_AT","DEAL_WON_AT","LAST_ACTIVITY_AT","LAST_RECEIVED_AT","LAST_SENT_AT"],"description":"Anchor of the fine-tuning."},"generatedInstructions":{"type":"string","minLength":1,"maxLength":10000,"description":"Generated instructions of the fine-tuning."},"generatedShortDescription":{"type":"string","minLength":1,"maxLength":10000,"description":"Generated short description of the fine-tuning."},"generatedDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Generated classification description of the fine-tuning."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the fine-tuning is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","priority","trigger","instructions","autopilot","allCampaigns","allImports","allPipelines","allViews","name","description","color","cadenceMonths","count","anchor","generatedInstructions","generatedShortDescription","generatedDescription","organizationId"]},"FineTuningWithRelations":{"allOf":[{"$ref":"#/components/schemas/FineTuning"},{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningCampaign"},"description":"Campaigns the fine-tuning is associated with."},"imports":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningImport"},"description":"Imports the fine-tuning is associated with."},"views":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningView"},"description":"Views the fine-tuning is associated with."},"pipelines":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningPipeline"},"description":"Pipelines the fine-tuning is associated with."}},"required":["campaigns","imports","views","pipelines"]}]},"EmailAddressWithContact":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","nullable":true,"properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]},"Calendar":{"type":"object","properties":{"object":{"type":"string","enum":["calendar"]},"id":{"type":"string","minLength":4,"description":"ID of the calendar."},"sort":{"type":"number","description":"Sorting order of this calendar."},"createdAt":{"type":"string","description":"Date when this calendar was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this calendar was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this calendar is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this calendar is not deleted, this value is null."},"uid":{"type":"string","minLength":1,"maxLength":10000,"description":"UID of the calendar."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the calendar."},"enabled":{"type":"boolean","description":"Whether the calendar is enabled."},"owned":{"type":"boolean","description":"Whether the calendar is owned by the user."},"primary":{"type":"boolean","description":"Whether the calendar is the primary calendar."},"readOnly":{"type":"boolean","description":"Whether the calendar is read-only."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the calendar."},"hexColor":{"type":"string","nullable":true,"maxLength":10000,"description":"Hex color of the calendar."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the calendar."},"timeZone":{"type":"string","nullable":true,"maxLength":10000,"description":"Time zone of the calendar. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection the calendar is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","uid","name","enabled","owned","primary","readOnly","description","hexColor","location","timeZone","connectionId"]},"Connection":{"type":"object","properties":{"object":{"type":"string","enum":["connection"]},"id":{"type":"string","minLength":4,"description":"ID of the connection."},"sort":{"type":"number","description":"Sorting order of this connection."},"createdAt":{"type":"string","description":"Date when this connection was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this connection was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this connection is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this connection is not deleted, this value is null."},"grant":{"type":"string","description":"Grant ID of the connection."},"app":{"type":"string","enum":["APPLE_ICLOUD_CALENDAR","APPLE_ICLOUD_MAIL","GMAIL","GOOGLE_CALENDAR","IMAP","MICROSOFT_365_OUTLOOK_CALENDAR","MICROSOFT_365_OUTLOOK_MAIL","MICROSOFT_EXCHANGE_CALENDAR","MICROSOFT_EXCHANGE_MAIL","YAHOO_CALENDAR","YAHOO_MAIL","HUBSPOT"]},"type":{"type":"string","enum":["CALENDAR","CRM","MAILBOX"]},"auth":{"type":"object","additionalProperties":{"type":"string"}},"data":{"type":"object","additionalProperties":{"type":"string"}},"status":{"type":"string","enum":["VALID","INVALID"]},"logs":{"type":"array","items":{"type":"string"},"description":"Logs of the connection."},"contentIdentifier":{"type":"string","nullable":true,"maxLength":10000,"description":"Content identifier of the connection."},"signature":{"type":"string","nullable":true,"maxLength":10000,"description":"Signature of the connection."},"minWaitMinutes":{"type":"integer","nullable":true,"description":"Minimum wait minutes of the connection."},"campaignDailyLimit":{"type":"integer","nullable":true,"description":"Campaign daily limit of the connection."},"campaignRampUp":{"type":"integer","nullable":true,"description":"Campaign ramp up of the connection."},"replyToAddress":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"Reply to address of the connection."},"suggestionsEnabled":{"type":"string","nullable":true,"enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are enabled."},"suggestionsAutopilot":{"type":"string","nullable":true,"enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are autopilot."},"historicalSyncCursor":{"type":"string","nullable":true,"description":"The date of the last historical sync cursor."},"historicalSyncEnabled":{"type":"boolean","description":"Whether historical sync is enabled."},"source":{"type":"string","enum":["API","FILE_IMPORT","MANUAL"]},"sourceApiKey":{"allOf":[{"$ref":"#/components/schemas/ApiKey"},{"nullable":true}]},"sourceApiKeyId":{"type":"string","nullable":true,"minLength":4},"sourceFileId":{"type":"string","nullable":true,"minLength":4},"sourceRequestId":{"type":"string","nullable":true,"minLength":4},"sourceSessionId":{"type":"string","nullable":true,"minLength":4},"emailAddress":{"$ref":"#/components/schemas/EmailAddressWithContact"},"emailAddressId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the email address the connection is associated with."},"membership":{"allOf":[{"$ref":"#/components/schemas/Membership"},{"nullable":true}]},"membershipId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the membership the connection is associated with."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the connection is associated with."},"calendars":{"type":"array","items":{"$ref":"#/components/schemas/Calendar"},"description":"Calendars associated with the connection."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","grant","app","type","auth","data","status","logs","contentIdentifier","signature","minWaitMinutes","campaignDailyLimit","campaignRampUp","replyToAddress","suggestionsEnabled","suggestionsAutopilot","historicalSyncCursor","historicalSyncEnabled","source","sourceApiKey","sourceApiKeyId","sourceFileId","sourceRequestId","sourceSessionId","emailAddress","emailAddressId","membership","membershipId","organizationId","calendars"],"description":"The connection associated with the campaignConnection."},"CampaignConnection":{"type":"object","properties":{"object":{"type":"string","enum":["campaignConnection"]},"id":{"type":"string","minLength":4,"description":"ID of the campaignConnection."},"sort":{"type":"number","description":"Sorting order of this campaignConnection."},"createdAt":{"type":"string","description":"Date when this campaignConnection was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaignConnection was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaignConnection is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaignConnection is not deleted, this value is null."},"enabled":{"type":"boolean","description":"Whether the campaignConnection is enabled."},"connection":{"$ref":"#/components/schemas/Connection"},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection associated with the campaignConnection."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign associated with the campaignConnection."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","enabled","connection","connectionId","campaignId"]},"Count":{"type":"object","properties":{"id":{"type":"number"}},"required":["id"]},"CampaignConnectionCreate":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the campaignConnection is enabled."},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection associated with the campaignConnection."}},"required":["enabled","connectionId"]},"CampaignConnectionUpdate":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the campaignConnection is enabled."},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection associated with the campaignConnection."}}},"CampaignMembership":{"type":"object","properties":{"object":{"type":"string","enum":["campaignMembership"]},"id":{"type":"string","minLength":4,"description":"ID of the campaignMembership."},"sort":{"type":"number","description":"Sorting order of this campaignMembership."},"createdAt":{"type":"string","description":"Date when this campaignMembership was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaignMembership was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaignMembership is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaignMembership is not deleted, this value is null."},"membership":{"allOf":[{"$ref":"#/components/schemas/Membership"},{"description":"The membership associated with the campaignMembership."}]},"membershipId":{"type":"string","minLength":4,"description":"ID of the membership associated with the campaignMembership."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign associated with the campaignMembership."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","membership","membershipId","campaignId"]},"OrganizationCampaignMembership":{"type":"object","properties":{"object":{"type":"string","enum":["membership"]},"id":{"type":"string","minLength":4,"description":"ID of the membership."},"sort":{"type":"number","description":"Sorting order of this membership."},"createdAt":{"type":"string","description":"Date when this membership was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this membership was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this membership is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this membership is not deleted, this value is null."},"active":{"type":"boolean","description":"Whether the membership is currently active."},"schedulingLink":{"type":"string","nullable":true,"description":"Scheduling link of the membership."},"signature":{"type":"string","nullable":true,"maxLength":10000,"description":"Signature of the membership."},"replyToAddress":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"Reply to address of the membership."},"user":{"allOf":[{"$ref":"#/components/schemas/User"},{"description":"The user associated with the membership."}]},"userId":{"type":"string","minLength":4,"description":"ID of the user the membership is associated with."},"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"description":"The contact associated with the membership."}]},"contactId":{"type":"string","minLength":4,"description":"ID of the contact the membership is associated with."},"organization":{"allOf":[{"$ref":"#/components/schemas/Organization"},{"description":"The organization associated with the membership."}]},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the membership is associated with."},"teams":{"type":"array","items":{"type":"object","properties":{"team":{"type":"object","properties":{"object":{"type":"string","enum":["team"]},"id":{"type":"string","minLength":4,"description":"ID of the team."},"sort":{"type":"number","description":"Sorting order of this team."},"createdAt":{"type":"string","description":"Date when this team was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this team was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this team is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this team is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the team."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the team is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","organizationId"]},"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":4,"description":"ID of the campaign team."},"sort":{"type":"number","description":"Sorting order of the campaign team."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign."},"teamId":{"type":"string","minLength":4,"description":"ID of the team."}},"required":["id","sort","campaignId","teamId"]}}},"required":["team","campaigns"]},"description":"The teams associated with the membership."},"campaigns":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","enum":["campaignMembership"]},"id":{"type":"string","minLength":4,"description":"ID of the campaign membership."},"sort":{"type":"number","description":"Sorting order of this campaign membership."},"createdAt":{"type":"string","description":"Date when this campaign membership was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaign membership was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaign membership is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaign membership is not deleted, this value is null."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign associated with the campaign membership."},"membershipId":{"type":"string","minLength":4,"description":"ID of the membership associated with the campaign membership."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","campaignId","membershipId"]},"description":"The campaigns associated with the membership."},"connections":{"type":"array","items":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","enum":["campaignConnection"]},"id":{"type":"string","minLength":4,"description":"ID of the campaignConnection."},"sort":{"type":"number","description":"Sorting order of this campaignConnection."},"createdAt":{"type":"string","description":"Date when this campaignConnection was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaignConnection was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaignConnection is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaignConnection is not deleted, this value is null."},"enabled":{"type":"boolean","description":"Whether the campaignConnection is enabled."},"connection":{"type":"object","properties":{"app":{"type":"string","enum":["APPLE_ICLOUD_CALENDAR","APPLE_ICLOUD_MAIL","GMAIL","GOOGLE_CALENDAR","IMAP","MICROSOFT_365_OUTLOOK_CALENDAR","MICROSOFT_365_OUTLOOK_MAIL","MICROSOFT_EXCHANGE_CALENDAR","MICROSOFT_EXCHANGE_MAIL","YAHOO_CALENDAR","YAHOO_MAIL","HUBSPOT"]},"type":{"type":"string","enum":["CALENDAR","CRM","MAILBOX"]},"auth":{"type":"object","additionalProperties":{"type":"string"}},"data":{"type":"object","additionalProperties":{"type":"string"}},"status":{"type":"string","enum":["VALID","INVALID"]},"source":{"type":"string","enum":["API","FILE_IMPORT","MANUAL"]},"sourceApiKey":{"allOf":[{"$ref":"#/components/schemas/ApiKey"},{"nullable":true}]},"sourceApiKeyId":{"type":"string","nullable":true,"minLength":4},"sourceFileId":{"type":"string","nullable":true,"minLength":4},"sourceRequestId":{"type":"string","nullable":true,"minLength":4},"sourceSessionId":{"type":"string","nullable":true,"minLength":4},"emailAddress":{"$ref":"#/components/schemas/EmailAddressWithContact"},"emailAddressId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the email address the connection is associated with."},"membershipId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the membership the connection is associated with."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the connection is associated with."}},"required":["app","type","auth","data","status","source","sourceApiKey","sourceApiKeyId","sourceFileId","sourceRequestId","sourceSessionId","emailAddress","emailAddressId","membershipId","organizationId"],"description":"The connection associated with the campaignConnection."},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection associated with the campaignConnection."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign associated with the campaignConnection."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","enabled","connection","connectionId","campaignId"]}}},"required":["campaigns"]},"description":"The campaigns associated with the membership."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","active","schedulingLink","signature","replyToAddress","user","userId","contact","contactId","organization","organizationId","teams","campaigns","connections"]},"CampaignMembershipCreate":{"type":"object","properties":{"membershipId":{"type":"string","minLength":4,"description":"ID of the membership associated with the campaignMembership."}},"required":["membershipId"]},"CampaignMembershipUpdate":{"type":"object","properties":{"membershipId":{"type":"string","minLength":4,"description":"ID of the membership associated with the campaignMembership."}}},"Sequence":{"type":"object","properties":{"object":{"type":"string","enum":["sequence"]},"id":{"type":"string","minLength":4,"description":"ID of the sequence."},"sort":{"type":"number","description":"Sorting order of this sequence."},"createdAt":{"type":"string","description":"Date when this sequence was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this sequence was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this sequence is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this sequence is not deleted, this value is null."},"status":{"type":"string","enum":["PENDING","SEQUENCED","RUNNING","COMPLETED"],"description":"Status of the sequence."},"generatedAt":{"type":"string","nullable":true,"description":"Date and time the sequence was generated."},"pausedAt":{"type":"string","nullable":true,"description":"Date and time the sequence was paused."},"opensTracked":{"type":"boolean","description":"Whether the sequence is open tracking."},"source":{"type":"string","enum":["API","VIEW","IMPORT","MANUAL"],"description":"Source of the sequence."},"sourceApiKeyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API key that the sequence was created from."},"sourceViewId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the view that the sequence was created from."},"sourceImportId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the import that the sequence was created from."},"sourceRequestId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API request that the sequence was created from."},"sourceSessionId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the session that the sequence was created from."},"contact":{"$ref":"#/components/schemas/Contact"},"contactId":{"type":"string","minLength":4,"description":"ID of the contact associated with the sequence."},"employment":{"allOf":[{"$ref":"#/components/schemas/Employment"},{"nullable":true,"description":"Employment associated with the sequence."}]},"employmentId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the employment associated with the sequence."},"variantId":{"type":"string","minLength":4,"description":"ID of the variant associated with the sequence."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign associated with the sequence."},"campaign":{"$ref":"#/components/schemas/Campaign"},"replyActivityId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the reply activity associated with the sequence."},"createdDealId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the deal associated with the sequence."},"enrichmentUsageId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the usage associated with the sequence."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","status","generatedAt","pausedAt","opensTracked","source","sourceApiKeyId","sourceViewId","sourceImportId","sourceRequestId","sourceSessionId","contact","contactId","employment","employmentId","variantId","campaignId","campaign","replyActivityId","createdDealId","enrichmentUsageId"]},"SequenceCreate":{"type":"object","properties":{"contactId":{"type":"string","minLength":4,"description":"ID of the contact associated with the sequence."},"employmentId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the employment associated with the sequence."},"pausedAt":{"type":"string","nullable":true,"description":"Date and time the sequence was paused."}},"required":["contactId","employmentId","pausedAt"]},"SequenceCounts":{"type":"object","properties":{"PENDING":{"type":"number"},"SEQUENCED":{"type":"number"},"RUNNING":{"type":"number"},"COMPLETED":{"type":"number"}},"required":["PENDING","SEQUENCED","RUNNING","COMPLETED"]},"SequenceUpdate":{"type":"object","properties":{"contactId":{"type":"string","minLength":4,"description":"ID of the contact associated with the sequence."},"employmentId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the employment associated with the sequence."},"pausedAt":{"type":"string","nullable":true,"description":"Date and time the sequence was paused."}}},"SequenceContent":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject of the sequence."},"body":{"type":"array","items":{"type":"object","properties":{"stepId":{"type":"string","minLength":4},"content":{"type":"string","minLength":1,"maxLength":10000}},"required":["stepId","content"]},"description":"Body of the sequence."}},"required":["subject","body"]},"TeamMembership":{"type":"object","properties":{"object":{"type":"string","enum":["teamMembership"]},"id":{"type":"string","minLength":4,"description":"ID of the team membership."},"sort":{"type":"number","description":"Sorting order of this team membership."},"createdAt":{"type":"string","description":"Date when this team membership was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this team membership was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this team membership is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this team membership is not deleted, this value is null."},"teamId":{"type":"string","minLength":4,"description":"ID of the team the team membership is associated with."},"membership":{"$ref":"#/components/schemas/Membership"},"membershipId":{"type":"string","minLength":4,"description":"ID of the membership the team membership is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","teamId","membership","membershipId"]},"Team":{"type":"object","properties":{"object":{"type":"string","enum":["team"]},"id":{"type":"string","minLength":4,"description":"ID of the team."},"sort":{"type":"number","description":"Sorting order of this team."},"createdAt":{"type":"string","description":"Date when this team was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this team was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this team is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this team is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the team."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the team is associated with."},"memberships":{"type":"array","items":{"$ref":"#/components/schemas/TeamMembership"},"description":"Memberships associated with the team."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","organizationId","memberships"],"description":"The team associated with the campaignTeam."},"CampaignTeam":{"type":"object","properties":{"object":{"type":"string","enum":["campaignTeam"]},"id":{"type":"string","minLength":4,"description":"ID of the campaignTeam."},"sort":{"type":"number","description":"Sorting order of this campaignTeam."},"createdAt":{"type":"string","description":"Date when this campaignTeam was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this campaignTeam was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this campaignTeam is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this campaignTeam is not deleted, this value is null."},"team":{"$ref":"#/components/schemas/Team"},"teamId":{"type":"string","minLength":4,"description":"ID of the team associated with the campaignTeam."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign associated with the campaignTeam."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","team","teamId","campaignId"]},"CampaignTeamCreate":{"type":"object","properties":{"teamId":{"type":"string","minLength":4,"description":"ID of the team associated with the campaignTeam."}},"required":["teamId"]},"CampaignTeamUpdate":{"type":"object","properties":{"teamId":{"type":"string","minLength":4,"description":"ID of the team associated with the campaignTeam."}}},"Variant":{"type":"object","properties":{"object":{"type":"string","enum":["variant"]},"id":{"type":"string","minLength":4,"description":"ID of the variant."},"sort":{"type":"number","description":"Sorting order of this variant."},"createdAt":{"type":"string","description":"Date when this variant was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this variant was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this variant is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this variant is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the variant."},"count":{"type":"number","minimum":0,"description":"Count of the variant."},"allocation":{"type":"number","minimum":0,"description":"Allocation percentage of the variant."},"campaignId":{"type":"string","minLength":4,"description":"ID of the campaign the variant is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","count","allocation","campaignId"]},"VariantCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the variant."},"allocation":{"type":"number","minimum":0,"description":"Allocation percentage of the variant."},"template":{"type":"string","enum":["FRIENDLY","PROFESSIONAL","CONCISE"]}},"required":["name","allocation"]},"VariantUpdate":{"type":"object","properties":{"allocation":{"type":"number","minimum":0,"description":"Allocation percentage of the variant."}}},"VariantVariableUpdate":{"type":"object","properties":{"variable":{"type":"string","minLength":1,"maxLength":10000},"example":{"type":"string","nullable":true,"maxLength":10000},"length":{"type":"string","enum":["very short","short","medium","long","auto"]}},"required":["variable","example","length"]},"StepEmail":{"type":"object","nullable":true,"properties":{"object":{"type":"string","enum":["stepEmail"]},"id":{"type":"string","minLength":4,"description":"ID of the stepEmail."},"sort":{"type":"number","description":"Sorting order of this stepEmail."},"createdAt":{"type":"string","description":"Date when this stepEmail was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this stepEmail was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this stepEmail is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this stepEmail is not deleted, this value is null."},"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject of the email."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Body of the email. It is represented as a markdown string. If an HTML string is provided, it will be converted to markdown."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","subject","body"],"description":"Email step."},"Step":{"type":"object","properties":{"object":{"type":"string","enum":["step"]},"id":{"type":"string","minLength":4,"description":"ID of the step."},"sort":{"type":"number","description":"Sorting order of this step."},"createdAt":{"type":"string","description":"Date when this step was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this step was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this step is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this step is not deleted, this value is null."},"delay":{"type":"number","minimum":0,"description":"Delay in seconds before the step is executed."},"type":{"type":"string","enum":["EMAIL","MANUAL_ACTION"],"description":"Type of the step."},"variantId":{"type":"string","minLength":4,"description":"ID of the variant the step is associated with."},"email":{"$ref":"#/components/schemas/StepEmail"}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","delay","type","variantId","email"]},"StepEmailUpdate":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject of the email."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Body of the email. It is represented as a markdown string. If an HTML string is provided, it will be converted to markdown."}}},"StepCreate":{"type":"object","properties":{"delay":{"type":"number","minimum":0,"description":"Delay in seconds before the step is executed."},"type":{"type":"string","enum":["EMAIL","MANUAL_ACTION"],"description":"Type of the step."},"email":{"$ref":"#/components/schemas/StepEmailUpdate"},"template":{"type":"string","enum":["FRIENDLY","PROFESSIONAL","CONCISE"]}},"required":["delay","type"]},"StepUpdate":{"type":"object","properties":{"delay":{"type":"number","minimum":0,"description":"Delay in seconds before the step is executed."},"type":{"type":"string","enum":["EMAIL","MANUAL_ACTION"],"description":"Type of the step."},"email":{"$ref":"#/components/schemas/StepEmailUpdate"},"template":{"type":"string","enum":["FRIENDLY","PROFESSIONAL","CONCISE"]}}},"ContactUpdate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Full name of the contact."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or preferred name of the contact, such as their first name."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the contact, typically sourced from their social media bio."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the contact's profile picture as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the contact's personal website."},"domain":{"type":"string","nullable":true,"pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the contact's personal website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the contact's residence"},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the contact's residential location. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"educationHistory":{"type":"array","items":{"$ref":"#/components/schemas/EducationWorkHistoryItem"},"description":"Education history of the contact."},"employmentHistory":{"type":"array","items":{"$ref":"#/components/schemas/EducationWorkHistoryItem"},"description":"Employment history of the contact."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the contact from the Apollo.io service."},"employments":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"seniority":{"type":"string","enum":["A_INTERN","B_ENTRY","C_SENIOR","D_MANAGER","E_LEAD_DIRECTOR_HEAD","F_EXECUTIVE","G_FOUNDER","H_OWNER"]},"companyId":{"type":"string","minLength":4},"companyDomain":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$"},"companyFacebookHandle":{"type":"string"},"companyGitHubHandle":{"type":"string"},"companyInstagramHandle":{"type":"string"},"companyLinkedInHandle":{"type":"string"},"companyXHandle":{"type":"string"},"companyApolloId":{"type":"string"}}}},"note":{"type":"string","nullable":true,"maxLength":10000},"email":{"type":"string","nullable":true,"maxLength":10000}}},"DealUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the deal."},"value":{"type":"string","description":"Value of the deal in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"status":{"type":"string","enum":["OPEN","WON","LOST"],"description":"Status of the deal."},"stageId":{"type":"string","minLength":4,"description":"ID of the stage the deal is associated with."},"companyId":{"type":"string","minLength":4,"description":"ID of the company the deal is associated with."},"ownerId":{"type":"string","minLength":4,"description":"ID of the membership the deal is associated with."},"pipelineId":{"type":"string","nullable":true,"minLength":4,"description":"Pipeline ID assigned to the deal."}}},"EmploymentUpdate":{"type":"object","properties":{"companyId":{"type":"string","minLength":4,"description":"ID of the company the employment is associated with."},"title":{"type":"string","nullable":true,"maxLength":10000,"description":"The title of the employment."},"seniority":{"type":"string","nullable":true,"enum":["A_INTERN","B_ENTRY","C_SENIOR","D_MANAGER","E_LEAD_DIRECTOR_HEAD","F_EXECUTIVE","G_FOUNDER","H_OWNER"],"description":"The seniority of the employment."}}},"CompanyUpdate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Legal name of the company."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or brand name of the company without suffixes like Inc and LLC."},"subtitle":{"type":"string","nullable":true,"maxLength":10000,"description":"Short description of the company."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the company."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the company's logo as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the company's website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the company's primary headquarters."},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the company's primary headquarters. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"annualRevenue":{"type":"string","nullable":true,"description":"Annual revenue of the company in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"employeesCount":{"type":"number","nullable":true,"description":"Number of employees that currently work at the company."},"foundedYear":{"type":"number","nullable":true,"description":"Year the company was founded."},"fundingStage":{"type":"string","nullable":true,"maxLength":10000,"description":"Current funding stage."},"fundingTotal":{"type":"string","nullable":true,"description":"Total funding the company has raised in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"retailLocationsCount":{"type":"number","nullable":true,"description":"Number of retail locations of the company. Only applicable to companies that operate physical stores."},"ticker":{"type":"string","nullable":true,"maxLength":10000,"description":"Stock ticker symbol of the company. Only applicable to publicly traded companies."},"industries":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Industries the company operates in."},"languages":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Spoken languages the company's website is available is."},"stack":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Technologies used on the company's website."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Tags associated with the company."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the organization from the Apollo.io service."},"parentId":{"type":"string","nullable":true,"minLength":4,"description":"If the company is a subsidiary of another company, the ID of the parent company."}}},"ActivityUndo":{"type":"object","nullable":true,"properties":{"updates":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"object":{"type":"string","enum":["contact"]},"id":{"type":"string","minLength":4},"data":{"$ref":"#/components/schemas/ContactUpdate"}},"required":["object","id","data"]},{"type":"object","properties":{"object":{"type":"string","enum":["deal"]},"id":{"type":"string","minLength":4},"data":{"$ref":"#/components/schemas/DealUpdate"}},"required":["object","id","data"]},{"type":"object","properties":{"object":{"type":"string","enum":["employment"]},"id":{"type":"string","minLength":4},"data":{"$ref":"#/components/schemas/EmploymentUpdate"}},"required":["object","id","data"]},{"type":"object","properties":{"object":{"type":"string","enum":["company"]},"id":{"type":"string","minLength":4},"data":{"$ref":"#/components/schemas/CompanyUpdate"}},"required":["object","id","data"]},{"type":"object","properties":{"object":{"type":"string","enum":["value"]},"id":{"type":"string","minLength":4},"data":{"type":"object","properties":{"valueAsFormatted":{"type":"string","nullable":true,"maxLength":10000,"description":"Value of the property as a formatted string."}}}},"required":["object","id","data"]}]}},"deletes":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"object":{"type":"string","enum":["activity"]},"id":{"type":"string","minLength":4}},"required":["object","id"]},{"type":"object","properties":{"object":{"type":"string","enum":["deal"]},"id":{"type":"string","minLength":4}},"required":["object","id"]},{"type":"object","properties":{"object":{"type":"string","enum":["draftEmail"]},"id":{"type":"string","minLength":4}},"required":["object","id"]},{"type":"object","properties":{"object":{"type":"string","enum":["sequence"]},"id":{"type":"string","minLength":4}},"required":["object","id"]},{"type":"object","properties":{"object":{"type":"string","enum":["pointOfContact"]},"id":{"type":"string","minLength":4}},"required":["object","id"]}]}}},"required":["updates","deletes"],"description":"The undo of the activity"},"Action":{"type":"object","nullable":true,"properties":{"object":{"type":"string","enum":["action"]},"id":{"type":"string","minLength":4,"description":"ID of the action."},"sort":{"type":"number","description":"Sorting order of this action."},"createdAt":{"type":"string","description":"Date when this action was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this action was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this action is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this action is not deleted, this value is null."},"completedAt":{"type":"string","nullable":true},"snoozedFor":{"type":"string","nullable":true},"unSnoozedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true,"maxLength":10000,"description":"Title of the action."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the action."},"labels":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Labels of the action."},"membershipId":{"type":"string","minLength":4},"sourceActivityId":{"type":"string","minLength":4,"description":"ID of the activity this action is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","completedAt","snoozedFor","unSnoozedAt","title","description","labels","membershipId","sourceActivityId"],"description":"Action associated with the draft email."},"DraftEmail":{"type":"object","nullable":true,"properties":{"object":{"type":"string","enum":["draftEmail"]},"id":{"type":"string","minLength":4,"description":"ID of the draft email."},"sort":{"type":"number","description":"Sorting order of this draft email."},"createdAt":{"type":"string","description":"Date when this draft email was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this draft email was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this draft email is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this draft email is not deleted, this value is null."},"scheduledFor":{"type":"string","nullable":true,"description":"Date and time this draft is or previously was scheduled to be sent. It is only available if the draft will be sent in the future or has already been sent. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"status":{"type":"string","enum":["UNAPPROVED","APPROVED_AUTOPILOT","APPROVED_MANUAL","SCHEDULED","ERRORED","SENT","SENT_BOUNCED"],"description":"Current status of the draft email."},"date":{"type":"string","nullable":true,"description":"Date when the draft email is scheduled to be sent. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"delay":{"type":"integer","minimum":0,"description":"Number of minutes to delay from the first email when scheduling this draft. This field is deprecated and will be removed in a future version. Use followUpDelay instead."},"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject line of the email."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Content of the email."},"followUpDelay":{"type":"integer","minimum":0,"description":"Number of minutes to delay from the previous email when scheduling this draft."},"sendingError":{"type":"string","nullable":true,"maxLength":10000,"description":"Error message from the most recent attempt to send the draft email."},"sendingLogs":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Logs from sending the draft email."},"sendingAttempts":{"type":"integer","nullable":true,"minimum":0,"description":"Number of attempts to send the draft email."},"stepId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the step this draft is associated with. It is only available if the draft email is part of a campaign."},"sequenceId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the sequence this draft is associated with."},"sourceActivityId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the activity this draft is associated with."},"sentId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the email that was sent from this draft. It is only available if the draft has been sent."},"inFollowUpToId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the draft email this draft is following up on."},"action":{"$ref":"#/components/schemas/Action"},"actionId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the action this draft is associated with."},"fromConnectionId":{"type":"string","minLength":4,"description":"ID of the connection this draft will be sent from."},"fromConnection":{"$ref":"#/components/schemas/Connection"},"to":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"description":"List of email addresses this draft will be sent to."},"cc":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"description":"List of email addresses this draft will be sent to as a carbon copy."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","scheduledFor","status","date","delay","subject","body","followUpDelay","sendingError","sendingLogs","sendingAttempts","stepId","sequenceId","sourceActivityId","sentId","inFollowUpToId","action","actionId","fromConnectionId","fromConnection","to","cc"]},"NylasFile":{"type":"object","properties":{"id":{"type":"string"},"grantId":{"type":"string"},"filename":{"type":"string"},"contentType":{"type":"string"},"isInline":{"type":"boolean"},"size":{"type":"number"},"contentId":{"type":"string"},"contentDisposition":{"type":"string"}},"required":["id","grantId","filename","contentType"]},"NylasEvent":{"type":"object","properties":{}},"NylasLabel":{"type":"string"},"NylasHeader":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"Engagement":{"type":"object","properties":{"object":{"type":"string","enum":["engagement"]},"id":{"type":"string","minLength":4,"description":"ID of the engagement."},"sort":{"type":"number","description":"Sorting order of this engagement."},"createdAt":{"type":"string","description":"Date when this engagement was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this engagement was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this engagement is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this engagement is not deleted, this value is null."},"type":{"type":"string","enum":["EMAIL_OPEN","EMAIL_CLICK","EMAIL_SEND","EMAIL_DELIVERY","CALENDAR_EVENT_RESPONSE_YES","CALENDAR_EVENT_RESPONSE_NO","CALENDAR_EVENT_RESPONSE_MAYBE","CALENDAR_EVENT_DELETED"],"description":"Type of the engagement."},"href":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the engagement."},"emailId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the email associated with the engagement."},"participantId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the participant associated with the engagement."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization this engagement is associated with."},"requestId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the request the event is associated with. This value is only available if the event was created as a side effect of an HTTP request."},"userAgentString":{"type":"string","nullable":true,"maxLength":10000,"description":"User agent the event is associated with. This value is only available if the event was created as a side effect of an HTTP request."},"userAgentBrowserName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the web browser extracted from the user agent."},"userAgentBrowserVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the web browser extracted from the user agent."},"userAgentDeviceModel":{"type":"string","nullable":true,"maxLength":10000,"description":"Model of the device extracted from the user agent."},"userAgentDeviceVendor":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the device vendor extracted from the user agent."},"userAgentEngineName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the browser engine extracted from the user agent."},"userAgentEngineVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the browser engine extracted from the user agent."},"userAgentOsName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the operating system extracted from the user agent."},"userAgentOsVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the operating system extracted from the user agent."},"ipAddressHash":{"type":"string","nullable":true,"maxLength":10000,"description":"ID of the IP address the event is associated with. This value is only available if the event was created as a side effect of an HTTP request."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","type","href","emailId","participantId","organizationId","requestId","userAgentString","userAgentBrowserName","userAgentBrowserVersion","userAgentDeviceModel","userAgentDeviceVendor","userAgentEngineName","userAgentEngineVersion","userAgentOsName","userAgentOsVersion","ipAddressHash"]},"EmailLabel":{"type":"object","properties":{"object":{"type":"string","enum":["emailLabel"]},"id":{"type":"string","minLength":4,"description":"ID of the email label."},"sort":{"type":"number","description":"Sorting order of this email label."},"createdAt":{"type":"string","description":"Date when this email label was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this email label was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this email label is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this email label is not deleted, this value is null."},"reasoning":{"type":"string","minLength":1,"maxLength":10000,"description":"Reasoning of the fine tuning."},"emailId":{"type":"string","minLength":4,"description":"ID of the email the label is associated with."},"fineTuning":{"allOf":[{"$ref":"#/components/schemas/FineTuningWithRelations"},{"description":"Fine tuning the label is associated with."}]},"fineTuningId":{"type":"string","minLength":4,"description":"ID of the fine tuning the label is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","reasoning","emailId","fineTuning","fineTuningId"]},"Email":{"type":"object","nullable":true,"properties":{"object":{"type":"string","enum":["email"]},"id":{"type":"string","minLength":4,"description":"ID of the email."},"sort":{"type":"number","description":"Sorting order of this email."},"createdAt":{"type":"string","description":"Date when this email was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this email was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this email is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this email is not deleted, this value is null."},"processedAt":{"type":"string","nullable":true,"description":"Date when the email was processed. If the email is not processed, this value is null."},"logs":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Logs from processing the email."},"suggestedAt":{"type":"string","nullable":true,"description":"Date when the email was considered for nurturing. If not considered yet, this value is null."},"messageId":{"type":"string","minLength":1,"maxLength":10000,"description":"Globally unique message ID of the email generated by the client program sending the email or by the first mail server."},"externalId":{"type":"string","minLength":1,"maxLength":10000,"description":"External ID of the email."},"date":{"type":"string","description":"Date when the email was sent. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"dateIso8601":{"type":"string","minLength":1,"maxLength":10000,"description":"Date of the email in ISO 8601 format."},"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject of the email."},"html":{"type":"string","minLength":1,"maxLength":10000,"description":"HTML content of the email."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Plain text content of the email."},"text":{"type":"string","minLength":1,"maxLength":10000,"description":"Plain text content of the email without quoted text."},"snippet":{"type":"string","minLength":1,"maxLength":10000,"description":"Short preview of the email content."},"files":{"type":"array","items":{"$ref":"#/components/schemas/NylasFile"},"description":"List of files attached to the email."},"events":{"type":"array","items":{"$ref":"#/components/schemas/NylasEvent"},"description":"List of events associated with the email."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/NylasLabel"},"description":"List of folders associated with the email."},"headers":{"type":"array","items":{"$ref":"#/components/schemas/NylasHeader"},"description":"List of headers associated with the email."},"salesRelated":{"type":"boolean","nullable":true,"description":"Whether the email is sales related."},"salesRelatedReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"Reasoning for why the email is sales related."},"salesRelatedThoughtProcess":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Thought process for why the email is sales related."},"draft":{"allOf":[{"$ref":"#/components/schemas/DraftEmail"},{"description":"Draft email associated with the email."}]},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection used to send or receive the email."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization associated with this email."},"fromId":{"type":"string","minLength":4,"description":"ID of the sender of the email."},"from":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"to":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"description":"List of email addresses this email was sent to."},"cc":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"description":"List of email addresses this email was sent to as a carbon copy."},"mentioned":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"description":"List of email addresses mentioned in the email."},"engagements":{"type":"array","items":{"$ref":"#/components/schemas/Engagement"},"description":"List of engagements associated with the email."},"labels":{"type":"array","items":{"$ref":"#/components/schemas/EmailLabel"},"description":"List of labels associated with the email."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","processedAt","logs","suggestedAt","messageId","externalId","date","dateIso8601","subject","html","body","text","snippet","files","events","folders","headers","salesRelated","salesRelatedReasoning","salesRelatedThoughtProcess","draft","connectionId","organizationId","fromId","from","to","cc","mentioned","engagements","labels"]},"CalendarEventConferencing":{"anyOf":[{"allOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["GOOGLE_MEET","ZOOM_MEETING","MICROSOFT_TEAMS","GOTOMEETING","WEBEX","OTHER"],"description":"Provider of the conferencing."}},"required":["provider"]},{"anyOf":[{"type":"object","properties":{"details":{"type":"object","properties":{"meetingCode":{"type":"string","description":"Meeting code of the conferencing, used for Zoom."},"password":{"type":"string","description":"Password of the conferencing, used for Zoom."},"url":{"type":"string","format":"uri","description":"URL of the conferencing."},"pin":{"type":"string","description":"Pin of the conferencing, used for Google Meet."},"phone":{"type":"array","items":{"type":"string"},"description":"Phone numbers of the conferencing, used for Google Meet."}}}},"required":["details"]},{"type":"object","properties":{"autocreate":{"type":"object","additionalProperties":{"type":"string"}}},"required":["autocreate"]}]}]},{"nullable":true}],"description":"Conferencing information of the event."},"CalendarEventResource":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the resource."},"name":{"type":"string","description":"Name of the resource."}},"required":["email"]},"Participant":{"type":"object","properties":{"object":{"type":"string","enum":["participant"]},"id":{"type":"string","minLength":4,"description":"ID of the participant."},"sort":{"type":"number","description":"Sorting order of this participant."},"createdAt":{"type":"string","description":"Date when this participant was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this participant was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this participant is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this participant is not deleted, this value is null."},"status":{"type":"string","enum":["YES","NO","MAYBE","NOREPLY"],"description":"Status of the participant."},"comment":{"type":"string","nullable":true,"maxLength":10000,"description":"Comment that the participant left in the calendar event."},"phoneNumber":{"type":"string","nullable":true,"maxLength":10000,"description":"Phone number of the participant."},"emailAddress":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"emailAddressId":{"type":"string","minLength":4,"description":"ID of the email address of the participant."},"calendarEventId":{"type":"string","minLength":4,"description":"ID of the calendar event of the participant."},"engagements":{"type":"array","items":{"$ref":"#/components/schemas/Engagement"},"description":"List of engagements associated with the participant."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","status","comment","phoneNumber","emailAddress","emailAddressId","calendarEventId","engagements"]},"CalendarEvent":{"type":"object","nullable":true,"properties":{"object":{"type":"string","enum":["calendarEvent"]},"id":{"type":"string","minLength":4,"description":"ID of the calendar event."},"sort":{"type":"number","description":"Sorting order of this calendar event."},"createdAt":{"type":"string","description":"Date when this calendar event was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this calendar event was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this calendar event is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this calendar event is not deleted, this value is null."},"processedAt":{"type":"string","nullable":true,"description":"Date when the event was processed. If the event is not processed, this value is null."},"logs":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Logs from processing the event."},"suggestedAt":{"type":"string","nullable":true,"description":"Date when the event was considered for nurturing. If not considered yet, this value is null."},"uid":{"type":"string","minLength":1,"maxLength":10000,"description":"Persistent, globally unique identifier for the iCalendar object. Many calendar providers format this similar to an email address."},"externalId":{"type":"string","minLength":1,"maxLength":10000,"description":"External ID of the event."},"title":{"type":"string","minLength":1,"maxLength":10000,"description":"Title of the event."},"start":{"type":"string","description":"Date when this calendar event starts. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"end":{"type":"string","description":"Date when this calendar event ends. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"status":{"type":"string","enum":["CONFIRMED","TENTATIVE","CANCELED"],"description":"Current status of the event: can be one of CONFIRMED, TENTATIVE, or CANCELLED."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the event set by the organizer."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the event."},"conferencing":{"$ref":"#/components/schemas/CalendarEventConferencing"},"primaryEventId":{"type":"string","nullable":true,"maxLength":10000,"description":"ID of the primary event."},"resources":{"type":"array","items":{"$ref":"#/components/schemas/CalendarEventResource"},"description":"Resources of the event."},"url":{"type":"string","nullable":true,"description":"URL of the event."},"salesRelated":{"type":"boolean","nullable":true,"description":"Whether the email is sales related."},"salesRelatedReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"Reasoning for why the email is sales related."},"salesRelatedThoughtProcess":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Thought process for why the email is sales related."},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection (calendar integration) this event belongs to."},"calendar":{"allOf":[{"$ref":"#/components/schemas/Calendar"},{"nullable":true}]},"calendarId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the calendar this event belongs to."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization this event belongs to."},"organizerId":{"type":"string","minLength":4,"description":"ID of the organizer of the event."},"organizer":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Participant"},"description":"Participants of the event."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","processedAt","logs","suggestedAt","uid","externalId","title","start","end","status","description","location","conferencing","primaryEventId","resources","url","salesRelated","salesRelatedReasoning","salesRelatedThoughtProcess","connectionId","calendar","calendarId","organizationId","organizerId","organizer","participants"]},"Note":{"type":"object","nullable":true,"properties":{"object":{"type":"string","enum":["note"]},"id":{"type":"string","minLength":4,"description":"ID of the note."},"sort":{"type":"number","description":"Sorting order of this note."},"createdAt":{"type":"string","description":"Date when this note was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this note was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this note is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this note is not deleted, this value is null."},"content":{"type":"string","minLength":1,"maxLength":10000,"description":"Content of the note."},"calendarEventId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the calendar event the note is associated with."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the note is associated with."},"author":{"$ref":"#/components/schemas/Membership"},"authorId":{"type":"string","minLength":4,"description":"ID of the membership the note is associated with."},"import":{"allOf":[{"$ref":"#/components/schemas/Import"},{"nullable":true}]},"importId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the import the note is associated with."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the note is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","content","calendarEventId","contactId","author","authorId","import","importId","organizationId"]},"Task":{"type":"object","nullable":true,"properties":{"object":{"type":"string","enum":["task"]},"id":{"type":"string","minLength":4,"description":"ID of the task."},"sort":{"type":"number","description":"Sorting order of this task."},"createdAt":{"type":"string","description":"Date when this task was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this task was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this task is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this task is not deleted, this value is null."},"dueAt":{"type":"string","nullable":true,"description":"Date when the task is due. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"status":{"type":"string","enum":["PENDING","COMPLETED"],"description":"Status of the task."},"type":{"type":"string","enum":["ACCESS_SYSTEM","ANSWER_QUESTION","AUTO_ARCHIVED","CONTRACT_REVIEW","CUSTOM_REQUEST","DEAL_STALE","ESCALATION","MEETING_NOTES","NOTHING_REVIEW","PAYMENT_HANDLING","PHONE_CALL","PROVIDE_DOCUMENT","REVIEW_PROPOSAL","SCHEDULE_APPOINTMENT","SUGGESTED_IMPORT","SUGGESTED_UNARCHIVE","TECHNICAL_ASSISTANCE"],"description":"Type of the task."},"title":{"type":"string","minLength":1,"maxLength":10000,"description":"Title of the task."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the task."},"suggestions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Suggested responses to the task."},"completedAt":{"type":"string","nullable":true,"description":"Date when the task was completed. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"url":{"type":"string","nullable":true,"description":"URL associated with the task."},"label":{"type":"string","nullable":true,"maxLength":10000,"description":"Label associated with the task."},"response":{"type":"string","nullable":true,"maxLength":10000,"description":"Response to the task."},"action":{"allOf":[{"$ref":"#/components/schemas/Action"},{"description":"Action associated with the task."}]},"actionId":{"type":"string","minLength":4,"description":"ID of the action this task is associated with."},"sourceActivityId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the activity this task is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","dueAt","status","type","title","description","suggestions","completedAt","url","label","response","action","actionId","sourceActivityId"]},"FineTuningRun":{"type":"object","properties":{"object":{"type":"string","enum":["fineTuningRun"]},"id":{"type":"string","minLength":4,"description":"ID of the fine-tuning run."},"sort":{"type":"number","description":"Sorting order of this fine-tuning run."},"createdAt":{"type":"string","description":"Date when this fine-tuning run was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this fine-tuning run was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this fine-tuning run is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this fine-tuning run is not deleted, this value is null."},"reasoning":{"type":"string","minLength":1,"maxLength":10000,"description":"AI-generated reasoning for the fine-tuning run."},"activityId":{"type":"string","minLength":4,"description":"ID of the activity the activity is associated with."},"fineTuningId":{"type":"string","minLength":4,"description":"ID of the fine-tuning the activity is associated with."},"fineTuning":{"$ref":"#/components/schemas/FineTuning"}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","reasoning","activityId","fineTuningId","fineTuning"]},"Activity":{"type":"object","properties":{"object":{"type":"string","enum":["activity"]},"id":{"type":"string","minLength":4,"description":"ID of the activity."},"sort":{"type":"number","description":"Sorting order of this activity."},"createdAt":{"type":"string","description":"Date when this activity was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this activity was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this activity is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this activity is not deleted, this value is null."},"date":{"type":"string","description":"The date of the activity"},"type":{"type":"string","enum":["ADDED_TO_CAMPAIGN","CALENDAR_EVENT_ORGANIZED","CALENDAR_EVENT_PARTICIPATED","CALENDAR_EVENT_UPDATED","COMPANY_UNSUBSCRIBED","CONTACT_ARCHIVED","CONTACT_CREATED","CONTACT_MERGED","CONTACT_REFERRED","CONTACT_UNARCHIVED","CONTACT_UNSUBSCRIBED","DEAL_ADDED_POINT_OF_CONTACT","DEAL_CREATED","DEAL_LOST","DEAL_REMOVED_POINT_OF_CONTACT","DEAL_STALE","DEAL_UPDATED","DEAL_WON","DRAFT_EMAIL_CC","DRAFT_EMAIL_FROM","DRAFT_EMAIL_TO","EMAIL_CC","EMAIL_FROM","EMAIL_MENTIONED","EMAIL_TO","NOTE","NURTURING_TRIGGERED","PROPERTY_UPDATE","TASK"],"description":"The type of activity"},"hidden":{"type":"boolean","description":"Whether the activity is hidden"},"count":{"type":"integer","minimum":1,"default":1,"description":"Number of times this activity occurred"},"label":{"type":"string","nullable":true,"maxLength":10000,"description":"The label of the activity"},"reasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"The reasoning of the activity"},"runReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"The reasoning of the activity"},"undo":{"$ref":"#/components/schemas/ActivityUndo"},"status":{"type":"string","enum":["SKIPPED","PROCESSING","COMPLETED"],"description":"The status of the activity"},"logs":{"type":"array","items":{"type":"string"},"description":"The logs of the activity"},"public":{"type":"array","items":{"type":"string"},"description":"The public logs of the activity"},"contact":{"$ref":"#/components/schemas/Contact"},"contactId":{"type":"string","minLength":4,"description":"The ID of the contact"},"draftEmail":{"$ref":"#/components/schemas/DraftEmail"},"draftEmailId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the draft email"},"email":{"$ref":"#/components/schemas/Email"},"emailId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the email"},"calendarEvent":{"$ref":"#/components/schemas/CalendarEvent"},"calendarEventId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the calendar event"},"note":{"$ref":"#/components/schemas/Note"},"noteId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the note"},"sequence":{"allOf":[{"$ref":"#/components/schemas/Sequence"},{"nullable":true}]},"sequenceId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the sequence"},"pointOfContact":{"allOf":[{"$ref":"#/components/schemas/PointOfContact"},{"nullable":true}]},"pointOfContactId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the point of contact"},"task":{"$ref":"#/components/schemas/Task"},"taskId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the task"},"usageId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the usage"},"sourceActivityId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the source activity"},"deletedByActivityId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the activity that deleted this activity"},"deletedReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"The reasoning of the activity that deleted this activity"},"nurturingTrigger":{"type":"string","nullable":true,"enum":["CALENDAR_EVENT_DELETED","CALENDAR_EVENT_RESPONSE_MAYBE","CALENDAR_EVENT_RESPONSE_NO","CALENDAR_EVENT_RESPONSE_YES","COMPANY_UNSUBSCRIBED","CONTACT_UNSUBSCRIBED","EMAIL_LINK_CLICKED","EMAIL_RECEIVED","GENERAL_RULE","KNOWLEDGE_ENTRY","NOTE_ADDED","NURTURING"],"description":"The nurturing trigger of the activity"},"nurturingFineTuning":{"allOf":[{"$ref":"#/components/schemas/FineTuningWithRelations"},{"allOf":[{"$ref":"#/components/schemas/FineTuning"},{"type":"object","nullable":true,"properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningCampaign"},"description":"Campaigns the fine-tuning is associated with."},"imports":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningImport"},"description":"Imports the fine-tuning is associated with."},"views":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningView"},"description":"Views the fine-tuning is associated with."},"pipelines":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningPipeline"},"description":"Pipelines the fine-tuning is associated with."}},"required":["campaigns","imports","views","pipelines"]}],"description":"The nurturing fine tuning of the activity"}]},"nurturingFineTuningId":{"type":"string","nullable":true,"minLength":4,"description":"The ID of the nurturing fine tuning"},"fineTuningRuns":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningRun"},"description":"Runs associated with the activity."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","date","type","hidden","label","reasoning","runReasoning","undo","status","logs","public","contact","contactId","draftEmail","draftEmailId","email","emailId","calendarEvent","calendarEventId","note","noteId","sequence","sequenceId","pointOfContact","pointOfContactId","task","taskId","usageId","sourceActivityId","deletedByActivityId","deletedReasoning","nurturingTrigger","nurturingFineTuning","nurturingFineTuningId","fineTuningRuns"],"description":"Activity associated with the action."},"ActionUpdate":{"type":"object","properties":{"completedAt":{"type":"string","nullable":true},"snoozedFor":{"type":"string","nullable":true},"unSnoozedAt":{"type":"string","nullable":true},"membershipId":{"type":"string","minLength":4}}},"CalendarEventCreate":{"type":"object","properties":{}},"CalendarEventUpdate":{"type":"object","properties":{}},"DraftEmailCreate":{"type":"object","properties":{"scheduledFor":{"type":"string","nullable":true,"description":"Date and time this draft is or previously was scheduled to be sent. It is only available if the draft will be sent in the future or has already been sent. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"status":{"type":"string","enum":["UNAPPROVED","APPROVED_AUTOPILOT","APPROVED_MANUAL","SCHEDULED","ERRORED","SENT","SENT_BOUNCED"],"description":"Current status of the draft email."},"date":{"type":"string","nullable":true,"description":"Date when the draft email is scheduled to be sent. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"followUpDelay":{"type":"integer","minimum":0,"description":"Number of minutes to delay from the previous email when scheduling this draft."},"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject line of the email."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Content of the email."},"fromConnectionId":{"type":"string","minLength":4},"toEmails":{"type":"array","items":{"type":"string","format":"email"}},"ccEmails":{"type":"array","items":{"type":"string","format":"email"}}},"required":["scheduledFor","status","date","followUpDelay","subject","body","fromConnectionId","toEmails","ccEmails"]},"ComposeEmailRequest":{"type":"object","properties":{"message":{"type":"string","description":"Message or instructions for composing the email."},"subject":{"type":"string","description":"Subject line for the email."},"body":{"type":"string","description":"Body content of the email."},"contactId":{"type":"string","minLength":4,"description":"ID of the contact to send the email to."},"connectionId":{"type":"string","minLength":4,"description":"ID of the connection to use for sending."}},"required":["message","subject","body","contactId","connectionId"]},"DraftEmailUpdate":{"type":"object","properties":{"scheduledFor":{"type":"string","nullable":true,"description":"Date and time this draft is or previously was scheduled to be sent. It is only available if the draft will be sent in the future or has already been sent. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"status":{"type":"string","enum":["UNAPPROVED","APPROVED_AUTOPILOT","APPROVED_MANUAL","SCHEDULED","ERRORED","SENT","SENT_BOUNCED"],"description":"Current status of the draft email."},"date":{"type":"string","nullable":true,"description":"Date when the draft email is scheduled to be sent. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"followUpDelay":{"type":"integer","minimum":0,"description":"Number of minutes to delay from the previous email when scheduling this draft."},"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject line of the email."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Content of the email."},"fromConnectionId":{"type":"string","minLength":4},"toEmails":{"type":"array","items":{"type":"string","format":"email"}},"ccEmails":{"type":"array","items":{"type":"string","format":"email"}}}},"EmailAddressCreate":{"type":"object","properties":{"email":{"type":"string","minLength":3,"format":"email","description":"Email address in the RFC 5322 format, i.e., local@domain."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the email address is associated with."}},"required":["email","contactId"]},"EmailAddressUpdate":{"type":"object","properties":{"email":{"type":"string","minLength":3,"format":"email","description":"Email address in the RFC 5322 format, i.e., local@domain."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the email address is associated with."}}},"EmailCreate":{"type":"object","properties":{}},"EmailUpdate":{"type":"object","properties":{"labelIds":{"type":"array","items":{"type":"string","minLength":4}}}},"NoteCreate":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":10000,"description":"Content of the note."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the note is associated with."},"calendarEventId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the calendar event the note is associated with."},"authorId":{"type":"string","minLength":4,"description":"ID of the membership the note is associated with."}},"required":["content","contactId","calendarEventId","authorId"]},"NoteUpdate":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":10000,"description":"Content of the note."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the note is associated with."},"calendarEventId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the calendar event the note is associated with."},"authorId":{"type":"string","minLength":4,"description":"ID of the membership the note is associated with."}}},"TaskUpdate":{"type":"object","properties":{"dueAt":{"type":"string","nullable":true,"description":"Date when the task is due. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"status":{"type":"string","enum":["PENDING","COMPLETED"],"description":"Status of the task."},"response":{"type":"string","nullable":true,"maxLength":10000,"description":"Response to the task."},"completedAt":{"type":"string","nullable":true,"description":"Date when the task was completed. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."}}},"ActivityCreate":{"type":"object","properties":{"date":{"type":"string","description":"The date of the activity"},"type":{"type":"string","enum":["ADDED_TO_CAMPAIGN","CALENDAR_EVENT_ORGANIZED","CALENDAR_EVENT_PARTICIPATED","CALENDAR_EVENT_UPDATED","COMPANY_UNSUBSCRIBED","CONTACT_ARCHIVED","CONTACT_CREATED","CONTACT_MERGED","CONTACT_REFERRED","CONTACT_UNARCHIVED","CONTACT_UNSUBSCRIBED","DEAL_ADDED_POINT_OF_CONTACT","DEAL_CREATED","DEAL_LOST","DEAL_REMOVED_POINT_OF_CONTACT","DEAL_STALE","DEAL_UPDATED","DEAL_WON","DRAFT_EMAIL_CC","DRAFT_EMAIL_FROM","DRAFT_EMAIL_TO","EMAIL_CC","EMAIL_FROM","EMAIL_MENTIONED","EMAIL_TO","NOTE","NURTURING_TRIGGERED","PROPERTY_UPDATE","TASK"],"description":"The type of activity"},"hidden":{"type":"boolean","description":"Whether the activity is hidden"}},"required":["date","type","hidden"]},"ActivityUpdate":{"type":"object","properties":{"date":{"type":"string","description":"The date of the activity"},"type":{"type":"string","enum":["ADDED_TO_CAMPAIGN","CALENDAR_EVENT_ORGANIZED","CALENDAR_EVENT_PARTICIPATED","CALENDAR_EVENT_UPDATED","COMPANY_UNSUBSCRIBED","CONTACT_ARCHIVED","CONTACT_CREATED","CONTACT_MERGED","CONTACT_REFERRED","CONTACT_UNARCHIVED","CONTACT_UNSUBSCRIBED","DEAL_ADDED_POINT_OF_CONTACT","DEAL_CREATED","DEAL_LOST","DEAL_REMOVED_POINT_OF_CONTACT","DEAL_STALE","DEAL_UPDATED","DEAL_WON","DRAFT_EMAIL_CC","DRAFT_EMAIL_FROM","DRAFT_EMAIL_TO","EMAIL_CC","EMAIL_FROM","EMAIL_MENTIONED","EMAIL_TO","NOTE","NURTURING_TRIGGERED","PROPERTY_UPDATE","TASK"],"description":"The type of activity"},"hidden":{"type":"boolean","description":"Whether the activity is hidden"}}},"ActivityRegenerate":{"type":"object","properties":{"createFineTunings":{"type":"array","items":{"type":"string","minLength":4}},"deleteFineTuningIds":{"type":"array","items":{"type":"string","minLength":4}},"selectedActions":{"type":"array","items":{"type":"string","enum":["reply-now","reply-later","reply-now-follow-ups","reply-later-follow-ups","follow-up","unsubscribe","create-task"]}},"deleteActions":{"type":"array","items":{"type":"string","enum":["reply-now","reply-later","reply-now-follow-ups","reply-later-follow-ups","unsubscribe","create-task","follow-up"]}}},"required":["createFineTunings","deleteFineTuningIds","selectedActions","deleteActions"]},"DealAnalytics":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","description":"The date and time the analytics were last updated."},"conversionRate":{"type":"number","description":"Conversion rate of won deals."},"count":{"type":"object","properties":{"total":{"type":"number","description":"Number of deals."},"won":{"type":"number","description":"Number of won deals."}},"required":["total","won"]},"values":{"type":"object","properties":{"total":{"type":"string","description":"Value of all deals"},"won":{"type":"string","description":"Value of won deals"},"weighed":{"type":"string","description":"Value of won deals weighed by stage weight"}},"required":["total","won","weighed"]},"stages":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"object","properties":{"object":{"type":"string","enum":["stage"]},"id":{"type":"string","minLength":4,"description":"ID of the stage."},"sort":{"type":"number","description":"Sorting order of this stage."},"createdAt":{"type":"string","description":"Date when this stage was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this stage was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this stage is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this stage is not deleted, this value is null."},"count":{"type":"integer","description":"Count of the stage in the pipeline."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the stage."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the stage."},"goal":{"type":"string","minLength":1,"maxLength":10000,"description":"Goal of the stage."},"goalUrl":{"type":"string","nullable":true,"description":"URL of the goal of the stage."},"weight":{"type":"integer","description":"Weight of the stage in the pipeline."},"pipelineId":{"type":"string","minLength":4,"description":"ID of the pipeline the stage is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","count","name","description","goal","goalUrl","weight","pipelineId"]},"count":{"type":"object","properties":{"total":{"type":"number","description":"Number of deals."},"won":{"type":"number","description":"Number of won deals."}},"required":["total","won"]},"values":{"type":"object","properties":{"total":{"type":"string","description":"Value of all deals"},"won":{"type":"string","description":"Value of won deals"},"weighed":{"type":"string","description":"Value of won deals weighed by stage weight"}},"required":["total","won","weighed"]}},"required":["stage","count","values"]}},"owners":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","minLength":4,"description":"The membership ID of the owner."},"count":{"type":"object","properties":{"total":{"type":"number","description":"Number of deals."},"won":{"type":"number","description":"Number of won deals."}},"required":["total","won"]},"values":{"type":"object","properties":{"total":{"type":"string","description":"Value of all deals"},"won":{"type":"string","description":"Value of won deals"},"weighed":{"type":"string","description":"Value of won deals weighed by stage weight"}},"required":["total","won","weighed"]}},"required":["membershipId","count","values"]}},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string","minLength":4,"description":"The company ID."},"count":{"type":"object","properties":{"total":{"type":"number","description":"Number of deals."},"won":{"type":"number","description":"Number of won deals."}},"required":["total","won"]},"values":{"type":"object","properties":{"total":{"type":"string","description":"Value of all deals"},"won":{"type":"string","description":"Value of won deals"},"weighed":{"type":"string","description":"Value of won deals weighed by stage weight"}},"required":["total","won","weighed"]}},"required":["companyId","count","values"]}}},"required":["updatedAt","conversionRate","count","values","stages","owners","companies"]},"CampaignAnalytics":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","description":"The date and time the analytics were last updated."},"conversionRateDealCreated":{"type":"number","description":"Conversion rate of created deals."},"conversionRateDealWon":{"type":"number","description":"Conversion rate of won deals."},"sequences":{"type":"object","properties":{"total":{"type":"number","description":"Number of sequences."},"pending":{"type":"number","description":"Number of pending sequences."},"sequenced":{"type":"number","description":"Number of sequenced contacts."},"running":{"type":"number","description":"Number of running sequences."},"completed":{"type":"number","description":"Number of completed sequences."},"replies":{"type":"number","description":"Number of replies."},"bounces":{"type":"number","description":"Number of bounces."},"opens":{"type":"number","description":"Number of opens."},"opensTracked":{"type":"number","description":"Number of opens tracked."},"clicks":{"type":"number","description":"Number of clicks."},"deals":{"type":"number","description":"Number of deals created."},"dealsWon":{"type":"number","description":"Number of deals won."}},"required":["total","pending","sequenced","running","completed","replies","bounces","opens","opensTracked","clicks","deals","dealsWon"]},"emails":{"type":"object","properties":{"total":{"type":"number","description":"Number of emails sent."},"opens":{"type":"number","description":"Number of opens."},"clicks":{"type":"number","description":"Number of clicks."}},"required":["total","opens","clicks"]},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string","minLength":4,"description":"The company ID."},"count":{"type":"object","properties":{"total":{"type":"number","description":"Number of sequences."},"pending":{"type":"number","description":"Number of pending sequences."},"sequenced":{"type":"number","description":"Number of sequenced sequences."},"running":{"type":"number","description":"Number of running sequences."},"completed":{"type":"number","description":"Number of completed sequences."},"replied":{"type":"number","description":"Number of replied sequences."},"deals":{"type":"number","description":"Number of deals created."},"dealsWon":{"type":"number","description":"Number of deals won."}},"required":["total","pending","sequenced","running","completed","replied","deals","dealsWon"]}},"required":["companyId","count"]}},"variants":{"type":"array","items":{"type":"object","properties":{"variant":{"$ref":"#/components/schemas/Variant"},"count":{"type":"object","properties":{"total":{"type":"number","description":"Number of sequences."},"pending":{"type":"number","description":"Number of pending sequences."},"sequenced":{"type":"number","description":"Number of sequenced sequences."},"running":{"type":"number","description":"Number of running sequences."},"completed":{"type":"number","description":"Number of completed sequences."},"replies":{"type":"number","description":"Number of replied sequences."},"opens":{"type":"number","description":"Number of opens."},"opensTracked":{"type":"number","description":"Number of opens tracked."},"clicks":{"type":"number","description":"Number of clicks."},"deals":{"type":"number","description":"Number of deals created."},"dealsWon":{"type":"number","description":"Number of deals won."}},"required":["total","pending","sequenced","running","completed","replies","opens","opensTracked","clicks","deals","dealsWon"]}},"required":["variant","count"]}}},"required":["updatedAt","conversionRateDealCreated","conversionRateDealWon","sequences","emails","companies","variants"]},"CompanyCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Legal name of the company."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or brand name of the company without suffixes like Inc and LLC."},"subtitle":{"type":"string","nullable":true,"maxLength":10000,"description":"Short description of the company."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the company."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the company's logo as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the company's website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the company's primary headquarters."},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the company's primary headquarters. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"annualRevenue":{"type":"string","nullable":true,"description":"Annual revenue of the company in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"employeesCount":{"type":"number","nullable":true,"description":"Number of employees that currently work at the company."},"foundedYear":{"type":"number","nullable":true,"description":"Year the company was founded."},"fundingStage":{"type":"string","nullable":true,"maxLength":10000,"description":"Current funding stage."},"fundingTotal":{"type":"string","nullable":true,"description":"Total funding the company has raised in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"retailLocationsCount":{"type":"number","nullable":true,"description":"Number of retail locations of the company. Only applicable to companies that operate physical stores."},"ticker":{"type":"string","nullable":true,"maxLength":10000,"description":"Stock ticker symbol of the company. Only applicable to publicly traded companies."},"industries":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Industries the company operates in."},"languages":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Spoken languages the company's website is available is."},"stack":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Technologies used on the company's website."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Tags associated with the company."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the organization from the Apollo.io service."},"parentId":{"type":"string","nullable":true,"minLength":4,"description":"If the company is a subsidiary of another company, the ID of the parent company."}},"required":["name","nickname","subtitle","bio","avatar","website","location","timeZone","facebookHandle","gitHubHandle","instagramHandle","linkedInHandle","xHandle","annualRevenue","employeesCount","foundedYear","fundingStage","fundingTotal","retailLocationsCount","ticker","industries","languages","stack","tags","externalIdApollo","parentId"]},"CompanyMerge":{"type":"object","properties":{"companyId":{"type":"string"}},"required":["companyId"]},"ContactCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Full name of the contact."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or preferred name of the contact, such as their first name."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the contact, typically sourced from their social media bio."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the contact's profile picture as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the contact's personal website."},"domain":{"type":"string","nullable":true,"pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the contact's personal website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the contact's residence"},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the contact's residential location. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"educationHistory":{"type":"array","items":{"$ref":"#/components/schemas/EducationWorkHistoryItem"},"description":"Education history of the contact."},"employmentHistory":{"type":"array","items":{"$ref":"#/components/schemas/EducationWorkHistoryItem"},"description":"Employment history of the contact."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the contact from the Apollo.io service."},"employments":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"seniority":{"type":"string","enum":["A_INTERN","B_ENTRY","C_SENIOR","D_MANAGER","E_LEAD_DIRECTOR_HEAD","F_EXECUTIVE","G_FOUNDER","H_OWNER"]},"companyId":{"type":"string","minLength":4},"companyDomain":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$"},"companyFacebookHandle":{"type":"string"},"companyGitHubHandle":{"type":"string"},"companyInstagramHandle":{"type":"string"},"companyLinkedInHandle":{"type":"string"},"companyXHandle":{"type":"string"},"companyApolloId":{"type":"string"}}}},"note":{"type":"string","nullable":true,"maxLength":10000},"email":{"type":"string","nullable":true,"maxLength":10000}},"required":["name","nickname","bio","avatar","website","domain","location","timeZone","facebookHandle","gitHubHandle","instagramHandle","linkedInHandle","xHandle","educationHistory","employmentHistory","externalIdApollo","note","email"]},"ContactMerge":{"type":"object","properties":{"contactId":{"type":"string"}},"required":["contactId"]},"EmploymentCreate":{"type":"object","properties":{"companyId":{"type":"string","minLength":4,"description":"ID of the company the employment is associated with."},"title":{"type":"string","nullable":true,"maxLength":10000,"description":"The title of the employment."},"seniority":{"type":"string","nullable":true,"enum":["A_INTERN","B_ENTRY","C_SENIOR","D_MANAGER","E_LEAD_DIRECTOR_HEAD","F_EXECUTIVE","G_FOUNDER","H_OWNER"],"description":"The seniority of the employment."}},"required":["companyId","title","seniority"]},"DeletedContact":{"type":"object","properties":{"object":{"type":"string","enum":["deletedContact"]},"id":{"type":"string","minLength":4,"description":"ID of the deleted contact."},"sort":{"type":"number","description":"Sorting order of this deleted contact."},"createdAt":{"type":"string","description":"Date when this deleted contact was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this deleted contact was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this deleted contact is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this deleted contact is not deleted, this value is null."},"permanent":{"type":"boolean","description":"Whether the contact deletion is permanent"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"The email of the contact"},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"The external ID of the contact in Apollo"},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The Facebook handle of the contact"},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The GitHub handle of the contact"},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The Instagram handle of the contact"},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The LinkedIn handle of the contact"},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"The name of the contact"},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"The nickname of the contact"},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The X handle of the contact"},"organizationId":{"type":"string","minLength":4,"description":"The ID of the organization the deleted contact belongs to"}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","permanent","email","externalIdApollo","facebookHandle","gitHubHandle","instagramHandle","linkedInHandle","name","nickname","xHandle","organizationId"]},"DeletedContactCreate":{"type":"object","properties":{"permanent":{"type":"boolean","description":"Whether the contact deletion is permanent"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"The email of the contact"},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"The external ID of the contact in Apollo"},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The Facebook handle of the contact"},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The GitHub handle of the contact"},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The Instagram handle of the contact"},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The LinkedIn handle of the contact"},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"The name of the contact"},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"The nickname of the contact"},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The X handle of the contact"},"organizationId":{"type":"string","minLength":4,"description":"The ID of the organization the deleted contact belongs to"}},"required":["permanent","email","externalIdApollo","facebookHandle","gitHubHandle","instagramHandle","linkedInHandle","name","nickname","xHandle","organizationId"]},"DeletedContactUpdate":{"type":"object","properties":{"permanent":{"type":"boolean","description":"Whether the contact deletion is permanent"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"The email of the contact"},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"The external ID of the contact in Apollo"},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The Facebook handle of the contact"},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The GitHub handle of the contact"},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The Instagram handle of the contact"},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The LinkedIn handle of the contact"},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"The name of the contact"},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"The nickname of the contact"},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"The X handle of the contact"},"organizationId":{"type":"string","minLength":4,"description":"The ID of the organization the deleted contact belongs to"}}},"DomainCreate":{"type":"object","properties":{"name":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain name."},"companyId":{"type":"string","minLength":4,"description":"ID of the company the domain is associated with."}},"required":["name","companyId"]},"DomainUpdate":{"type":"object","properties":{"name":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain name."},"companyId":{"type":"string","minLength":4,"description":"ID of the company the domain is associated with."}}},"PropertyCreate":{"type":"object","properties":{"type":{"type":"string","enum":["BOOLEAN","DATETIME","MULTI_SELECT","NUMBER","SELECT","STRING"],"description":"Type of the property."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the property."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the property."},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Options for the property."},"source":{"type":"string","enum":["EXISTING_PROPERTIES","MANUAL_INPUT","WEB_SEARCH"],"description":"Source of the property."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the property."},"visible":{"type":"boolean","description":"Whether the property is visible."},"enrichAll":{"type":"boolean","description":"Whether to enrich all values for the property."},"viewIds":{"type":"array","items":{"type":"string","minLength":4}},"campaignIds":{"type":"array","items":{"type":"string","minLength":4}},"importIds":{"type":"array","items":{"type":"string","minLength":4}}},"required":["type","name","description","options","source","target","visible","enrichAll"]},"PropertyUpdate":{"type":"object","properties":{"type":{"type":"string","enum":["BOOLEAN","DATETIME","MULTI_SELECT","NUMBER","SELECT","STRING"],"description":"Type of the property."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the property."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the property."},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Options for the property."},"source":{"type":"string","enum":["EXISTING_PROPERTIES","MANUAL_INPUT","WEB_SEARCH"],"description":"Source of the property."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the property."},"visible":{"type":"boolean","description":"Whether the property is visible."},"enrichAll":{"type":"boolean","description":"Whether to enrich all values for the property."},"viewIds":{"type":"array","items":{"type":"string","minLength":4}},"campaignIds":{"type":"array","items":{"type":"string","minLength":4}},"importIds":{"type":"array","items":{"type":"string","minLength":4}}}},"SuppressionList":{"type":"object","properties":{"object":{"type":"string","enum":["suppressionList"]},"id":{"type":"string","minLength":4,"description":"ID of the suppression list."},"sort":{"type":"number","description":"Sorting order of this suppression list."},"createdAt":{"type":"string","description":"Date when this suppression list was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this suppression list was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this suppression list is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this suppression list is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the suppression list."},"connectionId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the connection the suppression list is associated with. This value is only available if this suppression list is created by a connection."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the suppression list is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","connectionId","organizationId"]},"SuppressionListCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the suppression list."}},"required":["name"]},"SuppressionListUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the suppression list."}}},"Suppression":{"type":"object","properties":{"object":{"type":"string","enum":["suppression"]},"id":{"type":"string","minLength":4,"description":"ID of the suppression."},"sort":{"type":"number","description":"Sorting order of this suppression."},"createdAt":{"type":"string","description":"Date when this suppression was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this suppression was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this suppression is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this suppression is not deleted, this value is null."},"type":{"type":"string","enum":["CONTACT_NAME","CONTACT_EMAIL","CONTACT_DOMAIN","CONTACT_FACEBOOK_HANDLE","CONTACT_GITHUB_HANDLE","CONTACT_INSTAGRAM_HANDLE","CONTACT_LINKEDIN_HANDLE","CONTACT_X_HANDLE","COMPANY_NAME","COMPANY_DOMAIN","COMPANY_FACEBOOK_HANDLE","COMPANY_GITHUB_HANDLE","COMPANY_INSTAGRAM_HANDLE","COMPANY_LINKEDIN_HANDLE","COMPANY_X_HANDLE"],"description":"Type of suppression."},"value":{"type":"string","minLength":1,"maxLength":10000,"description":"Value to suppress."},"source":{"type":"string","enum":["API","FILE_IMPORT","MANUAL"],"description":"Source of the row."},"sourceApiKeyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API key that the row was created from."},"sourceFileId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the uploaded file that the row was created from."},"sourceRequestId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API request that the row was created from."},"sourceSessionId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the session that the row was created from."},"suppressionListId":{"type":"string","minLength":4,"description":"ID of the suppression list the row belongs to."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the suppression list belongs to."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","type","value","source","sourceApiKeyId","sourceFileId","sourceRequestId","sourceSessionId","suppressionListId","organizationId"]},"SuppressionCreate":{"type":"object","properties":{"type":{"type":"string","enum":["CONTACT_NAME","CONTACT_EMAIL","CONTACT_DOMAIN","CONTACT_FACEBOOK_HANDLE","CONTACT_GITHUB_HANDLE","CONTACT_INSTAGRAM_HANDLE","CONTACT_LINKEDIN_HANDLE","CONTACT_X_HANDLE","COMPANY_NAME","COMPANY_DOMAIN","COMPANY_FACEBOOK_HANDLE","COMPANY_GITHUB_HANDLE","COMPANY_INSTAGRAM_HANDLE","COMPANY_LINKEDIN_HANDLE","COMPANY_X_HANDLE"],"description":"Type of suppression."},"value":{"type":"string","minLength":1,"maxLength":10000,"description":"Value to suppress."}},"required":["type","value"]},"SuppressionUpdate":{"type":"object","properties":{"type":{"type":"string","enum":["CONTACT_NAME","CONTACT_EMAIL","CONTACT_DOMAIN","CONTACT_FACEBOOK_HANDLE","CONTACT_GITHUB_HANDLE","CONTACT_INSTAGRAM_HANDLE","CONTACT_LINKEDIN_HANDLE","CONTACT_X_HANDLE","COMPANY_NAME","COMPANY_DOMAIN","COMPANY_FACEBOOK_HANDLE","COMPANY_GITHUB_HANDLE","COMPANY_INSTAGRAM_HANDLE","COMPANY_LINKEDIN_HANDLE","COMPANY_X_HANDLE"],"description":"Type of suppression."},"value":{"type":"string","minLength":1,"maxLength":10000,"description":"Value to suppress."}}},"ValueCreate":{"type":"object","properties":{"valueAsBoolean":{"type":"boolean","nullable":true,"description":"Value of the property as a boolean."},"valueAsDateTime":{"type":"string","nullable":true,"description":"Value of the property as a date."},"valueAsNumber":{"type":"string","nullable":true,"description":"Value of the property as a number."},"valueAsSelect":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Value of the property as a select."},"valueAsString":{"type":"string","nullable":true,"maxLength":10000,"description":"Value of the property as a string."},"valueAsFormatted":{"type":"string","nullable":true,"maxLength":10000,"description":"Value of the property as a formatted string."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the value is associated with."},"companyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the company the value is associated with."},"propertyId":{"type":"string","minLength":4,"description":"ID of the property the value is associated with."}},"required":["valueAsBoolean","valueAsDateTime","valueAsNumber","valueAsSelect","valueAsString","valueAsFormatted","contactId","companyId","propertyId"]},"ValueUpdate":{"type":"object","properties":{"valueAsBoolean":{"type":"boolean","nullable":true,"description":"Value of the property as a boolean."},"valueAsDateTime":{"type":"string","nullable":true,"description":"Value of the property as a date."},"valueAsNumber":{"type":"string","nullable":true,"description":"Value of the property as a number."},"valueAsSelect":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Value of the property as a select."},"valueAsString":{"type":"string","nullable":true,"maxLength":10000,"description":"Value of the property as a string."},"valueAsFormatted":{"type":"string","nullable":true,"maxLength":10000,"description":"Value of the property as a formatted string."},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the value is associated with."},"companyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the company the value is associated with."},"propertyId":{"type":"string","minLength":4,"description":"ID of the property the value is associated with."}}},"ViewCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the view."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the view."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the view."},"filters":{"$ref":"#/components/schemas/ViewFilters"}},"required":["name","description","target","filters"]},"ViewUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the view."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the view."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the view."},"filters":{"$ref":"#/components/schemas/ViewFilters"}}},"DealCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the deal."},"value":{"type":"string","description":"Value of the deal in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"status":{"type":"string","enum":["OPEN","WON","LOST"],"description":"Status of the deal."},"stageId":{"type":"string","minLength":4,"description":"ID of the stage the deal is associated with."},"companyId":{"type":"string","minLength":4,"description":"ID of the company the deal is associated with."},"ownerId":{"type":"string","minLength":4,"description":"ID of the membership the deal is associated with."}},"required":["name","value","status","stageId","companyId","ownerId"]},"PointOfContactCreate":{"type":"object","properties":{"employmentId":{"type":"string","minLength":4,"description":"ID of the employment the point of contact is associated with."}},"required":["employmentId"]},"PointOfContactUpdate":{"type":"object","properties":{"employmentId":{"type":"string","minLength":4,"description":"ID of the employment the point of contact is associated with."}}},"PipelineCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the pipeline."},"defaultValue":{"type":"string","description":"Default value of the pipeline."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the pipeline."},"valueDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the default value of the pipeline."}},"required":["name","defaultValue","description","valueDescription"]},"PipelineUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the pipeline."},"defaultValue":{"type":"string","description":"Default value of the pipeline."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the pipeline."},"valueDescription":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the default value of the pipeline."}}},"StageCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the stage."},"goal":{"type":"string","minLength":1,"maxLength":10000,"description":"Goal of the stage."},"goalUrl":{"type":"string","nullable":true,"description":"URL of the goal of the stage."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the stage."}},"required":["name","goal","goalUrl","description"]},"StageUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the stage."},"goal":{"type":"string","minLength":1,"maxLength":10000,"description":"Goal of the stage."},"goalUrl":{"type":"string","nullable":true,"description":"URL of the goal of the stage."},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Description of the stage."}}},"StageReorder":{"type":"object","properties":{"direction":{"type":"string","enum":["previous","next"],"description":"Position to reorder the stage relative to its current position."}},"required":["direction"]},"File":{"type":"object","properties":{"object":{"type":"string","enum":["file"]},"id":{"type":"string","minLength":4,"description":"ID of the file."},"sort":{"type":"number","description":"Sorting order of this file."},"createdAt":{"type":"string","description":"Date when this file was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this file was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this file is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this file is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the file."},"importId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the import the file is associated with."},"suppressionListId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the suppression list the file is associated with. This value is only available if the file was used to import suppressions."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the file is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","importId","suppressionListId","organizationId"]},"RowData":{"type":"object","properties":{"contact":{"type":"object","properties":{"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Full name of the contact."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or preferred name of the contact, such as their first name."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the contact, typically sourced from their social media bio."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the contact's profile picture as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the contact's personal website."},"domain":{"type":"string","nullable":true,"pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the contact's personal website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the contact's residence"},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the contact's residential location. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the contact from the Apollo.io service."},"email":{"type":"string","nullable":true,"minLength":3,"format":"email","description":"Email address of the contact."},"note":{"type":"string","nullable":true,"maxLength":10000,"description":"Note to add to the contact."},"raw":{"nullable":true,"description":"Raw data from the source."}}},"employment":{"type":"object","nullable":true,"properties":{"title":{"type":"string","nullable":true,"maxLength":10000,"description":"The title of the employment."},"seniority":{"type":"string","nullable":true,"enum":["A_INTERN","B_ENTRY","C_SENIOR","D_MANAGER","E_LEAD_DIRECTOR_HEAD","F_EXECUTIVE","G_FOUNDER","H_OWNER"],"description":"The seniority of the employment."},"history":{"type":"array","items":{"$ref":"#/components/schemas/EducationWorkHistoryItem"}}}},"company":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Legal name of the company."},"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or brand name of the company without suffixes like Inc and LLC."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the company."},"subtitle":{"type":"string","nullable":true,"maxLength":10000,"description":"Short description of the company."},"avatar":{"type":"string","nullable":true,"maxLength":10000,"description":"URL of the company's logo as a square image."},"website":{"type":"string","nullable":true,"description":"URL of the company's website."},"location":{"type":"string","nullable":true,"maxLength":10000,"description":"Location of the company's primary headquarters."},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"},{"nullable":true,"description":"Time zone of the company's primary headquarters. It is represented in the IANA Time Zone Database format, for example \"America/Los_Angeles\" and \"Asia/Kolkata\"."}]},"facebookHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Facebook handle of the contact. It must be at least 5 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods. They also cannot contain generic terms or domain extensions (e.g., .com, .net), including country extensions (e.g., .ie, .de, .ca)."},"gitHubHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"GitHub handle of the contact. It can be up to 39 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and hyphens. It cannot have multiple consecutive hyphens and cannot begin or end with a hyphen."},"instagramHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"Instagram handle of the contact. It can be up to 30 characters long and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) and periods."},"linkedInHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"LinkedIn handle of the contact. It is typically 3 to 100 characters long and does not contain spaces, symbols, special characters, or the word \"LinkedIn\"."},"xHandle":{"type":"string","nullable":true,"maxLength":10000,"description":"X (formerly Twitter) handle of the contact. It is shorter than 16 characters and can only contain alphanumeric characters (uppercase and lowercase letters A-Z and numbers 0-9) with the exception of underscores."},"annualRevenue":{"type":"string","nullable":true,"description":"Annual revenue of the company in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"employeesCount":{"type":"number","nullable":true,"description":"Number of employees that currently work at the company."},"foundedYear":{"type":"number","nullable":true,"description":"Year the company was founded."},"fundingStage":{"type":"string","nullable":true,"maxLength":10000,"description":"Current funding stage."},"fundingTotal":{"type":"string","nullable":true,"description":"Total funding the company has raised in US dollars. It is represented in the smallest unit of the currency, for example $12.50 is represented as 1250."},"retailLocationsCount":{"type":"number","nullable":true,"description":"Number of retail locations of the company. Only applicable to companies that operate physical stores."},"ticker":{"type":"string","nullable":true,"maxLength":10000,"description":"Stock ticker symbol of the company. Only applicable to publicly traded companies."},"industries":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Industries the company operates in."},"languages":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Spoken languages the company's website is available is."},"stack":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Technologies used on the company's website."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Tags associated with the company."},"externalIdApollo":{"type":"string","nullable":true,"maxLength":10000,"description":"External ID of the organization from the Apollo.io service."},"domain":{"type":"string","nullable":true,"pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the company's primary website."}}}},"required":["contact"]},"SuppressionRow":{"type":"object","properties":{"type":{"type":"string","enum":["CONTACT_NAME","CONTACT_EMAIL","CONTACT_DOMAIN","CONTACT_FACEBOOK_HANDLE","CONTACT_GITHUB_HANDLE","CONTACT_INSTAGRAM_HANDLE","CONTACT_LINKEDIN_HANDLE","CONTACT_X_HANDLE","COMPANY_NAME","COMPANY_DOMAIN","COMPANY_FACEBOOK_HANDLE","COMPANY_GITHUB_HANDLE","COMPANY_INSTAGRAM_HANDLE","COMPANY_LINKEDIN_HANDLE","COMPANY_X_HANDLE"],"description":"Type of suppression."},"value":{"type":"string","minLength":1,"maxLength":10000,"description":"Value to suppress."}},"required":["type","value"]},"FileCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the file."},"importId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the import the file is associated with."},"suppressionListId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the suppression list the file is associated with. This value is only available if the file was used to import suppressions."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/RowData"}},"suppressions":{"type":"array","items":{"$ref":"#/components/schemas/SuppressionRow"}}},"required":["name","importId","suppressionListId"]},"FileUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the file."}}},"ImportCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the import."},"type":{"type":"string","enum":["API","FILE_IMPORT","MANUAL","WEBHOOK","APOLLO_IO","EMAIL","SUGGESTION"],"description":"Type of the import."},"app":{"type":"string","nullable":true,"enum":["RB2B","SEGMENT","VECTOR","ZAPIER","CAL_DOT_COM","HUBSPOT"],"description":"App of the import."},"zapier":{"type":"string","nullable":true,"enum":["AIRTABLE","SHOPIFY","NOTION","STRIPE","WEBFLOW","COGNITO_FORMS","CONVERTKIT","FORMSTACK","GOOGLE_FORMS","GUMROAD","KLAVIYO","LOOPS","MAILCHIMP","NINJA_FORMS","SURVEY_MONKEY","TALLY","TYPEFORM","ZOHO_FORMS"],"description":"Zapier app of the import."},"order":{"type":"string","enum":["CHRONOLOGICAL","RANDOM"],"description":"Order of the import."},"status":{"type":"string","enum":["PENDING","IMPORTING","IMPORTED"],"description":"Status of the import."},"note":{"type":"string","nullable":true,"maxLength":10000,"description":"Note of the import."},"authorId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the membership that created the import."},"event":{"type":"boolean","description":"Whether the import is an event."},"connectExisting":{"type":"boolean","description":"Whether to connect existing contacts to the import."},"archiveImported":{"type":"boolean","description":"Whether to archive the imported contacts."},"enrich":{"type":"boolean","description":"Whether the import is an enrichment."},"processImported":{"type":"boolean","description":"Whether to process the imported contacts."},"recurringCount":{"type":"number","nullable":true,"description":"Number of recurring rows in the import."},"recurringUnit":{"type":"string","nullable":true,"enum":["DAY","WEEK","MONTH"],"description":"Unit of the recurring rows in the import."},"qualificationCompanyWebsiteDown":{"type":"boolean","description":"Whether rows should be unqualified if their company website is down."},"qualificationContactEmailFreeDomain":{"type":"boolean","description":"Whether rows should be unqualified if their contact email is from a free domain."},"qualificationContactEmailInvalid":{"type":"boolean","description":"Whether rows should be unqualified if their contact email is invalid."}},"required":["name","type","app","zapier","order","status","note","authorId","event","connectExisting","archiveImported","enrich","processImported","recurringCount","recurringUnit","qualificationCompanyWebsiteDown","qualificationContactEmailFreeDomain","qualificationContactEmailInvalid"]},"ImportUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the import."},"type":{"type":"string","enum":["API","FILE_IMPORT","MANUAL","WEBHOOK","APOLLO_IO","EMAIL","SUGGESTION"],"description":"Type of the import."},"app":{"type":"string","nullable":true,"enum":["RB2B","SEGMENT","VECTOR","ZAPIER","CAL_DOT_COM","HUBSPOT"],"description":"App of the import."},"zapier":{"type":"string","nullable":true,"enum":["AIRTABLE","SHOPIFY","NOTION","STRIPE","WEBFLOW","COGNITO_FORMS","CONVERTKIT","FORMSTACK","GOOGLE_FORMS","GUMROAD","KLAVIYO","LOOPS","MAILCHIMP","NINJA_FORMS","SURVEY_MONKEY","TALLY","TYPEFORM","ZOHO_FORMS"],"description":"Zapier app of the import."},"order":{"type":"string","enum":["CHRONOLOGICAL","RANDOM"],"description":"Order of the import."},"status":{"type":"string","enum":["PENDING","IMPORTING","IMPORTED"],"description":"Status of the import."},"note":{"type":"string","nullable":true,"maxLength":10000,"description":"Note of the import."},"authorId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the membership that created the import."},"event":{"type":"boolean","description":"Whether the import is an event."},"connectExisting":{"type":"boolean","description":"Whether to connect existing contacts to the import."},"archiveImported":{"type":"boolean","description":"Whether to archive the imported contacts."},"enrich":{"type":"boolean","description":"Whether the import is an enrichment."},"processImported":{"type":"boolean","description":"Whether to process the imported contacts."},"recurringCount":{"type":"number","nullable":true,"description":"Number of recurring rows in the import."},"recurringUnit":{"type":"string","nullable":true,"enum":["DAY","WEEK","MONTH"],"description":"Unit of the recurring rows in the import."},"qualificationCompanyWebsiteDown":{"type":"boolean","description":"Whether rows should be unqualified if their company website is down."},"qualificationContactEmailFreeDomain":{"type":"boolean","description":"Whether rows should be unqualified if their contact email is from a free domain."},"qualificationContactEmailInvalid":{"type":"boolean","description":"Whether rows should be unqualified if their contact email is invalid."},"deleteExistingRows":{"type":"boolean"},"reQualifyExistingRows":{"type":"boolean"}}},"QualifyingQuestion":{"type":"object","properties":{"object":{"type":"string","enum":["qualifyingQuestion"]},"id":{"type":"string","minLength":4,"description":"ID of the qualifying question."},"sort":{"type":"number","description":"Sorting order of this qualifying question."},"createdAt":{"type":"string","description":"Date when this qualifying question was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this qualifying question was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this qualifying question is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this qualifying question is not deleted, this value is null."},"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the qualifying question."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the qualifying question."},"source":{"type":"string","enum":["EXISTING_PROPERTIES","MANUAL_INPUT","WEB_SEARCH"],"description":"Source of the qualifying question."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the qualifying question."},"values":{"type":"array","items":{"type":"string","enum":["TRUE","FALSE","UNKNOWN","PENDING"]},"description":"Values of the qualifying question."},"generatedQueries":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Queries generated for the qualifying question."},"generatedLabel":{"type":"string","minLength":1,"maxLength":10000,"description":"Label generated for the qualifying question."},"generatedDescription":{"type":"string","minLength":1,"maxLength":10000,"description":"Description generated for the qualifying question."},"importId":{"type":"string","minLength":4,"description":"ID of the import the qualifying question is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","name","description","source","target","values","generatedQueries","generatedLabel","generatedDescription","importId"]},"QualifyingAnswer":{"type":"object","properties":{"object":{"type":"string","enum":["qualifyingAnswer"]},"id":{"type":"string","minLength":4,"description":"ID of the qualifying answer."},"sort":{"type":"number","description":"Sorting order of this qualifying answer."},"createdAt":{"type":"string","description":"Date when this qualifying answer was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this qualifying answer was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this qualifying answer is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this qualifying answer is not deleted, this value is null."},"reasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"AI-generated reasoning for the qualifying answer."},"value":{"type":"string","enum":["TRUE","FALSE","UNKNOWN","PENDING"],"description":"Value of the qualifying answer."},"citations":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Citations for the qualifying answer."},"enrichmentUsageId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the enrichment usage the qualifying answer is associated with."},"question":{"$ref":"#/components/schemas/QualifyingQuestion"},"questionId":{"type":"string","minLength":4,"description":"ID of the qualifying question the qualifying answer is associated with."},"rowId":{"type":"string","minLength":4,"description":"ID of the row the qualifying answer is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","reasoning","value","citations","enrichmentUsageId","question","questionId","rowId"]},"Row":{"type":"object","properties":{"object":{"type":"string","enum":["row"]},"id":{"type":"string","minLength":4,"description":"ID of the row."},"sort":{"type":"number","description":"Sorting order of this row."},"createdAt":{"type":"string","description":"Date when this row was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this row was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this row is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this row is not deleted, this value is null."},"data":{"allOf":[{"$ref":"#/components/schemas/RowData"},{"description":"Data of the row."}]},"idempotencyKey":{"type":"string","minLength":1,"maxLength":10000,"description":"Idempotency key of the row."},"importAt":{"type":"string","description":"Date when this row should be imported. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"sortKeyIncrement":{"type":"number","description":"Sort key increment of the row."},"sortKeyRandom":{"type":"number","description":"Sort key random of the row."},"status":{"type":"string","enum":["PENDING","UNQUALIFIED","QUALIFIED"],"description":"Status of the row."},"version":{"type":"string","description":"Version of the row. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"unqualifiedReason":{"type":"string","nullable":true,"enum":["COMPANY_WEBSITE_DOWN","CONTACT_EMAIL_FREE_DOMAIN","CONTACT_EMAIL_INVALID","CONTACT_EXISTING","MANUALLY_UNQUALIFIED","QUALIFYING_ANSWER"],"description":"Reason the row is unqualified."},"unqualifiedReasonReasoning":{"type":"string","nullable":true,"maxLength":10000,"description":"AI-generated reasoning for why the row is unqualified."},"unqualifiedReasonDuplicatedById":{"type":"string","nullable":true,"minLength":4},"unqualifiedReasonUnqualifiedById":{"type":"string","nullable":true,"minLength":4},"unqualifiedReasonExistingId":{"type":"string","nullable":true,"minLength":4},"unqualifiedReasonSuppressedById":{"type":"string","nullable":true,"minLength":4},"processingLogs":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"Logs of the row's processing."},"processingError":{"type":"string","nullable":true,"maxLength":10000,"description":"Error that occurred during the row's processing, if any."},"sourceFileId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the file the row was created from."},"sourceRequestId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the request the row was created from."},"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the row is associated with."}]},"contactId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the contact the row is associated with."},"employment":{"allOf":[{"$ref":"#/components/schemas/Employment"},{"nullable":true,"description":"Employment the row is associated with."}]},"employmentId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the employment the row is associated with."},"enrichmentUsageId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the usage of the row's enrichment."},"importId":{"type":"string","minLength":4,"description":"ID of the import the row is associated with."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the row is associated with."},"answers":{"type":"array","items":{"$ref":"#/components/schemas/QualifyingAnswer"},"description":"Answers to the qualifying questions."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","data","idempotencyKey","importAt","sortKeyIncrement","sortKeyRandom","status","version","unqualifiedReason","unqualifiedReasonReasoning","unqualifiedReasonDuplicatedById","unqualifiedReasonUnqualifiedById","unqualifiedReasonExistingId","unqualifiedReasonSuppressedById","processingLogs","processingError","sourceFileId","sourceRequestId","contact","contactId","employment","employmentId","enrichmentUsageId","importId","organizationId","answers"]},"EmailNoteRequest":{"type":"object","properties":{"note":{"type":"string","description":"Note to send in the email."},"email":{"type":"string","minLength":3,"format":"email","description":"Email address to send the note to."}},"required":["note","email"]},"QualifyingQuestionCounts":{"type":"object","properties":{"EXISTING_PROPERTIES":{"type":"number"},"MANUAL_INPUT":{"type":"number"},"WEB_SEARCH":{"type":"number"}},"required":["EXISTING_PROPERTIES","MANUAL_INPUT","WEB_SEARCH"]},"QualifyingQuestionCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the qualifying question."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the qualifying question."},"source":{"type":"string","enum":["EXISTING_PROPERTIES","MANUAL_INPUT","WEB_SEARCH"],"description":"Source of the qualifying question."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the qualifying question."},"values":{"type":"array","items":{"type":"string","enum":["TRUE","FALSE","UNKNOWN","PENDING"]},"description":"Values of the qualifying question."}},"required":["name","description","source","target","values"]},"QualifyingQuestionUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the qualifying question."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the qualifying question."},"source":{"type":"string","enum":["EXISTING_PROPERTIES","MANUAL_INPUT","WEB_SEARCH"],"description":"Source of the qualifying question."},"target":{"type":"string","enum":["COMPANY","CONTACT"],"description":"Target of the qualifying question."},"values":{"type":"array","items":{"type":"string","enum":["TRUE","FALSE","UNKNOWN","PENDING"]},"description":"Values of the qualifying question."}}},"RowCreate":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/RowData"},{"description":"Data of the row."}]},"status":{"type":"string","enum":["PENDING","UNQUALIFIED","QUALIFIED"],"description":"Status of the row."}},"required":["data","status"]},"RowCounts":{"type":"object","properties":{"PENDING":{"type":"number"},"UNQUALIFIED":{"type":"number"},"QUALIFIED":{"type":"number"}},"required":["PENDING","UNQUALIFIED","QUALIFIED"]},"RowUpdate":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/RowData"},{"description":"Data of the row."}]},"status":{"type":"string","enum":["PENDING","UNQUALIFIED","QUALIFIED"],"description":"Status of the row."}}},"ConnectionCreateOAuth":{"type":"object","properties":{"type":{"type":"string","enum":["CALENDAR","CRM","MAILBOX"],"description":"The type of connection to create."},"membershipId":{"type":"string","minLength":4,"description":"The ID of the membership to connect."},"provider":{"type":"string","enum":["google","imap","microsoft","icloud","ews","yahoo"],"description":"The provider to connect to."},"integrationId":{"type":"string","description":"The integration to connect to."},"connectionId":{"type":"string","description":"The connection to connect to."},"loginHint":{"type":"string","description":"The email address to login with."},"redirectUrl":{"type":"string","description":"The URL to redirect to after the connection is created."}},"required":["type"]},"ConnectionCreate":{"type":"object","properties":{"membershipId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the membership the connection is associated with."},"contentIdentifier":{"type":"string","nullable":true,"maxLength":10000,"description":"Content identifier of the connection."},"signature":{"type":"string","nullable":true,"maxLength":10000,"description":"Signature of the connection."},"minWaitMinutes":{"type":"integer","nullable":true,"description":"Minimum wait minutes of the connection."},"campaignDailyLimit":{"type":"integer","nullable":true,"description":"Campaign daily limit of the connection."},"campaignRampUp":{"type":"integer","nullable":true,"description":"Campaign ramp up of the connection."},"replyToAddress":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"Reply to address of the connection."},"suggestionsEnabled":{"type":"string","nullable":true,"enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are enabled."},"suggestionsAutopilot":{"type":"string","nullable":true,"enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are autopilot."},"enabledCalendarIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the calendars that are enabled."}},"required":["membershipId","contentIdentifier","signature","minWaitMinutes","campaignDailyLimit","campaignRampUp","replyToAddress","suggestionsEnabled","suggestionsAutopilot"]},"ConnectionUpdate":{"type":"object","properties":{"membershipId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the membership the connection is associated with."},"contentIdentifier":{"type":"string","nullable":true,"maxLength":10000,"description":"Content identifier of the connection."},"signature":{"type":"string","nullable":true,"maxLength":10000,"description":"Signature of the connection."},"minWaitMinutes":{"type":"integer","nullable":true,"description":"Minimum wait minutes of the connection."},"campaignDailyLimit":{"type":"integer","nullable":true,"description":"Campaign daily limit of the connection."},"campaignRampUp":{"type":"integer","nullable":true,"description":"Campaign ramp up of the connection."},"replyToAddress":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"Reply to address of the connection."},"suggestionsEnabled":{"type":"string","nullable":true,"enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are enabled."},"suggestionsAutopilot":{"type":"string","nullable":true,"enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are autopilot."},"enabledCalendarIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the calendars that are enabled."}}},"HubSpotData":{"type":"object","properties":{"portalId":{"type":"number"},"dataHostingLocation":{"type":"string"},"bccEmail":{"type":"string","format":"email"},"bccEnabled":{"type":"boolean"},"syncPipelinesEnabled":{"type":"boolean"}},"required":["portalId","dataHostingLocation"]},"HubSpotPipelineResponse":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"displayOrder":{"type":"number"},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"displayOrder":{"type":"number"},"metadata":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"writePermissions":{"type":"string"}},"required":["id","label","displayOrder","metadata","archived","createdAt","updatedAt","writePermissions"]}},"archived":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"}},"required":["id","label","displayOrder","stages","archived","createdAt","updatedAt"]},"HubSpotDealProperties":{"type":"object","properties":{"dealname":{"type":"string"},"dealstage":{"type":"string"},"pipeline":{"type":"string"},"amount":{"type":"string"},"closedate":{"type":"string"},"description":{"type":"string"},"hubspot_owner_id":{"type":"string"}}},"HubSpotDealResponse":{"type":"object","properties":{"id":{"type":"string"},"properties":{"$ref":"#/components/schemas/HubSpotDealProperties"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","properties","createdAt","updatedAt","archived"]},"TrackingDomain":{"type":"object","properties":{"object":{"type":"string","enum":["trackingDomain"]},"id":{"type":"string","minLength":4,"description":"ID of the tracking domain."},"sort":{"type":"number","description":"Sorting order of this tracking domain."},"createdAt":{"type":"string","description":"Date when this tracking domain was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this tracking domain was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this tracking domain is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this tracking domain is not deleted, this value is null."},"domain":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the tracking domain."},"verifiedAt":{"type":"string","nullable":true,"description":"Date when the tracking domain was verified."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the tracking domain is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","domain","verifiedAt","organizationId"]},"TrackingDomainCreate":{"type":"object","properties":{"domain":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the tracking domain."}},"required":["domain"]},"TrackingDomainUpdate":{"type":"object","properties":{"domain":{"type":"string","pattern":"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\\.(xn--)?([a-z0-9\\-]{1,61}|[a-z0-9-]{1,30}\\.[a-z]{2,})$","description":"Domain of the tracking domain."}}},"Event":{"type":"object","properties":{"object":{"type":"string","enum":["event"]},"id":{"type":"string","minLength":4,"description":"ID of the event."},"sort":{"type":"number","description":"Sorting order of this event."},"createdAt":{"type":"string","description":"Date when this event was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this event was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this event is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this event is not deleted, this value is null."},"type":{"type":"string","minLength":1,"maxLength":10000,"description":"Type of the event."},"ids":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10000},"description":"IDs of the objects the event is associated with."},"data":{"type":"object","properties":{},"description":"Data of the event."},"before":{"type":"object","nullable":true,"properties":{},"description":"Data of the object before it was updated."},"after":{"type":"object","nullable":true,"properties":{},"description":"Data of the object after it was updated."},"diff":{"type":"object","nullable":true,"properties":{},"description":"Diff of the object before and after it was updated."},"requestId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the request the event is associated with. This value is only available if the event was created as a side effect of an HTTP request."},"userAgentString":{"type":"string","nullable":true,"maxLength":10000,"description":"User agent the event is associated with. This value is only available if the event was created as a side effect of an HTTP request."},"userAgentBrowserName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the web browser extracted from the user agent."},"userAgentBrowserVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the web browser extracted from the user agent."},"userAgentDeviceModel":{"type":"string","nullable":true,"maxLength":10000,"description":"Model of the device extracted from the user agent."},"userAgentDeviceVendor":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the device vendor extracted from the user agent."},"userAgentEngineName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the browser engine extracted from the user agent."},"userAgentEngineVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the browser engine extracted from the user agent."},"userAgentOsName":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the operating system extracted from the user agent."},"userAgentOsVersion":{"type":"string","nullable":true,"maxLength":10000,"description":"Version of the operating system extracted from the user agent."},"sessionId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the session the event is associated with. This value is only available if the event was created as a side effect of an HTTP request from a user session."},"apiKeyId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the API key the event is associated with. This value is only available if the event was created as a side effect of an HTTP request from an API key."},"ipAddressHash":{"type":"string","nullable":true,"maxLength":10000,"description":"ID of the API key the event is associated with. This value is only available if the event was created as a side effect of an HTTP request."},"organizationId":{"type":"string","nullable":true,"minLength":4,"description":"ID of the organization the event is associated with."}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","type","ids","data","before","after","diff","requestId","userAgentString","userAgentBrowserName","userAgentBrowserVersion","userAgentDeviceModel","userAgentDeviceVendor","userAgentEngineName","userAgentEngineVersion","userAgentOsName","userAgentOsVersion","sessionId","apiKeyId","ipAddressHash","organizationId"]},"MembershipUserCreate":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":10000,"description":"Full or legal name of the user."},"email":{"type":"string","minLength":3,"format":"email","description":"Email address of the user."}},"required":["name","email"]},"MembershipCreate":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the membership is currently active."},"schedulingLink":{"type":"string","nullable":true,"description":"Scheduling link of the membership."},"signature":{"type":"string","nullable":true,"maxLength":10000,"description":"Signature of the membership."},"replyToAddress":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"Reply to address of the membership."},"user":{"$ref":"#/components/schemas/MembershipUserCreate"}},"required":["active","schedulingLink","signature","replyToAddress","user"]},"MembershipUpdate":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the membership is currently active."},"schedulingLink":{"type":"string","nullable":true,"description":"Scheduling link of the membership."},"signature":{"type":"string","nullable":true,"maxLength":10000,"description":"Signature of the membership."},"replyToAddress":{"anyOf":[{"type":"string","format":"email"},{"type":"string","enum":[""]},{"type":"string","enum":["[null]"]},{"nullable":true}],"description":"Reply to address of the membership."}}},"OrganizationCreate":{"type":"object","properties":{"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or brand name of the company without suffixes like Inc and LLC."},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Legal name of the company."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the company."},"website":{"type":"string","nullable":true,"description":"URL of the company's website."},"enabled":{"type":"boolean","description":"Whether the organization is enabled."},"sendingSchedule":{"allOf":[{"$ref":"#/components/schemas/SendingSchedule"},{"description":"Schedule for sending emails."}]},"sandbox":{"type":"boolean","description":"Whether the organization is in sandbox mode."},"autoImportEmailSalesRelated":{"type":"boolean","description":"Whether to automatically import sales-related emails."},"autoImportEmailParticipants":{"type":"boolean","description":"Whether to automatically import participant emails."},"autoImportEventSalesRelated":{"type":"boolean","description":"Whether to automatically import sales-related events."},"autoImportEventParticipants":{"type":"boolean","description":"Whether to automatically import participant events."},"autoArchiveWonDeals":{"type":"string","enum":["CREATE_TASK","AUTO_ARCHIVE","NO_ARCHIVE"],"description":"How to handle archiving points of contact when a deal is won."},"followUpSeconds":{"type":"array","items":{"type":"integer","nullable":true},"description":"Follow up seconds of the organization."},"openTracking":{"type":"boolean","description":"Whether to track email opens by injecting a tracking pixel."},"openTrackingAll":{"type":"boolean","description":"Whether to track opens for all emails."},"clickTracking":{"type":"boolean","description":"Whether to track email link clicks by wrapping links with tracking URLs."},"dailySuggestionsLimit":{"type":"integer","nullable":true,"minimum":0,"maximum":1000,"description":"Maximum number of suggestions allowed per day."},"suggestionsEnabled":{"type":"string","enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are enabled."},"suggestionsAutopilot":{"type":"string","enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are autopilot."},"onboardingStage":{"type":"integer","nullable":true,"description":"Onboarding stage of the organization."},"salesRelatedPrompt":{"type":"string","nullable":true,"maxLength":10000,"description":"Custom instructions for determining if an email is sales-related."},"memory":{"type":"string","nullable":true,"maxLength":10000,"description":"Memory of the organization."},"featurePreview":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Feature preview of the organization."},"slug":{"type":"string","minLength":3,"maxLength":64,"pattern":"^[a-z0-9-]+$","description":"Unique identifier for the organization."}},"required":["nickname","name","bio","website"]},"OrganizationUpdate":{"type":"object","properties":{"nickname":{"type":"string","nullable":true,"maxLength":10000,"description":"Common or brand name of the company without suffixes like Inc and LLC."},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Legal name of the company."},"bio":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the company."},"website":{"type":"string","nullable":true,"description":"URL of the company's website."},"enabled":{"type":"boolean","description":"Whether the organization is enabled."},"sendingSchedule":{"allOf":[{"$ref":"#/components/schemas/SendingSchedule"},{"description":"Schedule for sending emails."}]},"sandbox":{"type":"boolean","description":"Whether the organization is in sandbox mode."},"autoImportEmailSalesRelated":{"type":"boolean","description":"Whether to automatically import sales-related emails."},"autoImportEmailParticipants":{"type":"boolean","description":"Whether to automatically import participant emails."},"autoImportEventSalesRelated":{"type":"boolean","description":"Whether to automatically import sales-related events."},"autoImportEventParticipants":{"type":"boolean","description":"Whether to automatically import participant events."},"autoArchiveWonDeals":{"type":"string","enum":["CREATE_TASK","AUTO_ARCHIVE","NO_ARCHIVE"],"description":"How to handle archiving points of contact when a deal is won."},"followUpSeconds":{"type":"array","items":{"type":"integer","nullable":true},"description":"Follow up seconds of the organization."},"openTracking":{"type":"boolean","description":"Whether to track email opens by injecting a tracking pixel."},"openTrackingAll":{"type":"boolean","description":"Whether to track opens for all emails."},"clickTracking":{"type":"boolean","description":"Whether to track email link clicks by wrapping links with tracking URLs."},"dailySuggestionsLimit":{"type":"integer","nullable":true,"minimum":0,"maximum":1000,"description":"Maximum number of suggestions allowed per day."},"suggestionsEnabled":{"type":"string","enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are enabled."},"suggestionsAutopilot":{"type":"string","enum":["ENABLED","DISABLED","ENABLED_SALES_RELATED"],"description":"Whether suggestions are autopilot."},"onboardingStage":{"type":"integer","nullable":true,"description":"Onboarding stage of the organization."},"salesRelatedPrompt":{"type":"string","nullable":true,"maxLength":10000,"description":"Custom instructions for determining if an email is sales-related."},"memory":{"type":"string","nullable":true,"maxLength":10000,"description":"Memory of the organization."},"featurePreview":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Feature preview of the organization."},"slug":{"type":"string","minLength":3,"maxLength":64,"pattern":"^[a-z0-9-]+$","description":"Unique identifier for the organization."}}},"FineTuningCreate":{"type":"object","properties":{"trigger":{"type":"string","enum":["CALENDAR_EVENT_DELETED","CALENDAR_EVENT_RESPONSE_MAYBE","CALENDAR_EVENT_RESPONSE_NO","CALENDAR_EVENT_RESPONSE_YES","COMPANY_UNSUBSCRIBED","CONTACT_UNSUBSCRIBED","EMAIL_LINK_CLICKED","EMAIL_RECEIVED","GENERAL_RULE","KNOWLEDGE_ENTRY","NOTE_ADDED","NURTURING"],"description":"Trigger of the fine-tuning."},"instructions":{"type":"string","minLength":1,"maxLength":10000,"description":"Instructions of the fine-tuning."},"autopilot":{"type":"boolean","description":"Autopilot of the fine-tuning."},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the fine-tuning."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the fine-tuning."},"anchor":{"type":"string","nullable":true,"enum":["CONTACT_CREATED_AT","DEAL_LOST_AT","DEAL_WON_AT","LAST_ACTIVITY_AT","LAST_RECEIVED_AT","LAST_SENT_AT"],"description":"Anchor of the fine-tuning."},"cadenceMonths":{"type":"integer","nullable":true,"minimum":1,"maximum":256,"description":"Cadence of the fine-tuning in months."},"count":{"type":"integer","nullable":true,"minimum":1,"maximum":256,"description":"Number of contacts to nurture with the fine-tuning."},"color":{"type":"string","nullable":true,"maxLength":10000,"description":"Color of the fine-tuning."},"allCampaigns":{"type":"boolean","description":"All campaigns of the fine-tuning."},"allImports":{"type":"boolean","description":"All imports of the fine-tuning."},"allPipelines":{"type":"boolean","description":"All pipelines of the fine-tuning."},"allViews":{"type":"boolean","description":"All views of the fine-tuning."},"campaignIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the campaigns that the fine-tuning applies to."},"importIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the imports that the fine-tuning applies to."},"viewIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the views that the fine-tuning applies to."},"pipelineIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the pipelines that the fine-tuning applies to."}},"required":["trigger","instructions","autopilot","name","description","anchor","cadenceMonths","count","color","allCampaigns","allImports","allPipelines","allViews"]},"CountResponse":{"type":"object","properties":{"count":{"type":"number","description":"The count of items."}},"required":["count"]},"DescriptionRecommendation":{"type":"object","properties":{"description":{"type":"string","description":"Recommended description for the fine-tuning."}}},"FineTuningUpdate":{"type":"object","properties":{"trigger":{"type":"string","enum":["CALENDAR_EVENT_DELETED","CALENDAR_EVENT_RESPONSE_MAYBE","CALENDAR_EVENT_RESPONSE_NO","CALENDAR_EVENT_RESPONSE_YES","COMPANY_UNSUBSCRIBED","CONTACT_UNSUBSCRIBED","EMAIL_LINK_CLICKED","EMAIL_RECEIVED","GENERAL_RULE","KNOWLEDGE_ENTRY","NOTE_ADDED","NURTURING"],"description":"Trigger of the fine-tuning."},"instructions":{"type":"string","minLength":1,"maxLength":10000,"description":"Instructions of the fine-tuning."},"autopilot":{"type":"boolean","description":"Autopilot of the fine-tuning."},"name":{"type":"string","nullable":true,"maxLength":10000,"description":"Name of the fine-tuning."},"description":{"type":"string","nullable":true,"maxLength":10000,"description":"Description of the fine-tuning."},"anchor":{"type":"string","nullable":true,"enum":["CONTACT_CREATED_AT","DEAL_LOST_AT","DEAL_WON_AT","LAST_ACTIVITY_AT","LAST_RECEIVED_AT","LAST_SENT_AT"],"description":"Anchor of the fine-tuning."},"cadenceMonths":{"type":"integer","nullable":true,"minimum":1,"maximum":256,"description":"Cadence of the fine-tuning in months."},"count":{"type":"integer","nullable":true,"minimum":1,"maximum":256,"description":"Number of contacts to nurture with the fine-tuning."},"color":{"type":"string","nullable":true,"maxLength":10000,"description":"Color of the fine-tuning."},"allCampaigns":{"type":"boolean","description":"All campaigns of the fine-tuning."},"allImports":{"type":"boolean","description":"All imports of the fine-tuning."},"allPipelines":{"type":"boolean","description":"All pipelines of the fine-tuning."},"allViews":{"type":"boolean","description":"All views of the fine-tuning."},"campaignIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the campaigns that the fine-tuning applies to."},"importIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the imports that the fine-tuning applies to."},"viewIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the views that the fine-tuning applies to."},"pipelineIds":{"type":"array","items":{"type":"string","minLength":4},"description":"IDs of the pipelines that the fine-tuning applies to."}}},"FineTuningActivityCreate":{"type":"object","properties":{"contactId":{"type":"string","minLength":4,"description":"ID of the contact to add to the fine-tuning."}},"required":["contactId"]},"TeamCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the team."},"membershipIds":{"type":"array","items":{"type":"string","minLength":4}}},"required":["name"]},"TeamUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":10000,"description":"Name of the team."},"membershipIds":{"type":"array","items":{"type":"string","minLength":4}}}},"Usage":{"type":"object","properties":{"object":{"type":"string","enum":["usage"]},"id":{"type":"string","minLength":4,"description":"ID of the usage."},"sort":{"type":"number","description":"Sorting order of this usage."},"createdAt":{"type":"string","description":"Date when this usage was first created. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"updatedAt":{"type":"string","description":"Date when this usage was most recently updated. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z."},"deletedAt":{"type":"string","nullable":true,"description":"If this usage is deleted, the date when it was deleted. It is represented in the date time string format, a simplified format based on ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ). The timezone is always UTC, as denoted by the suffix Z. If this usage is not deleted, this value is null."},"count":{"type":"number","description":"The number of credits consumed by the usage."},"type":{"type":"string","enum":["ACTION_GENERATION","CONTACT_ENRICHMENT","EMAIL_ENRICHMENT","PROPERTY_ENRICHMENT_EXISTING_PROPERTIES","PROPERTY_ENRICHMENT_WEB_SEARCH","QUALIFYING_ANSWER_EXISTING_PROPERTIES","QUALIFYING_ANSWER_WEB_SEARCH","SEQUENCE_GENERATION"],"description":"The type of usage."},"label":{"type":"string","nullable":true,"maxLength":10000,"description":"The label of the usage."},"organizationId":{"type":"string","minLength":4,"description":"ID of the organization the usage is associated with."},"enrichedAnswer":{"allOf":[{"$ref":"#/components/schemas/QualifyingAnswer"},{"nullable":true,"description":"The qualifying answer the usage is associated with."}]},"enrichedCompany":{"allOf":[{"$ref":"#/components/schemas/Company"},{"nullable":true,"description":"The company the usage is associated with."}]},"enrichedContact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"The contact the usage is associated with."}]},"enrichedRow":{"allOf":[{"$ref":"#/components/schemas/Row"},{"nullable":true,"description":"The row the usage is associated with."}]},"enrichedValue":{"allOf":[{"$ref":"#/components/schemas/Value"},{"nullable":true,"description":"The value the usage is associated with."}]},"activity":{"allOf":[{"$ref":"#/components/schemas/Activity"},{"nullable":true,"description":"The activity the usage is associated with."}]},"sequence":{"allOf":[{"$ref":"#/components/schemas/Sequence"},{"nullable":true,"description":"The sequence the usage is associated with."}]}},"required":["object","id","sort","createdAt","updatedAt","deletedAt","count","type","label","organizationId","enrichedAnswer","enrichedCompany","enrichedContact","enrichedRow","enrichedValue","activity","sequence"]},"UsageCounts":{"type":"object","properties":{"ACTION_GENERATION":{"type":"number"},"CONTACT_ENRICHMENT":{"type":"number"},"EMAIL_ENRICHMENT":{"type":"number"},"PROPERTY_ENRICHMENT_EXISTING_PROPERTIES":{"type":"number"},"PROPERTY_ENRICHMENT_WEB_SEARCH":{"type":"number"},"QUALIFYING_ANSWER_EXISTING_PROPERTIES":{"type":"number"},"QUALIFYING_ANSWER_WEB_SEARCH":{"type":"number"},"SEQUENCE_GENERATION":{"type":"number"}},"required":["ACTION_GENERATION","CONTACT_ENRICHMENT","EMAIL_ENRICHMENT","PROPERTY_ENRICHMENT_EXISTING_PROPERTIES","PROPERTY_ENRICHMENT_WEB_SEARCH","QUALIFYING_ANSWER_EXISTING_PROPERTIES","QUALIFYING_ANSWER_WEB_SEARCH","SEQUENCE_GENERATION"]}},"parameters":{}},"paths":{"/v5/health":{"get":{"tags":["Meta"],"description":"Verify the service is running","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":10000,"description":"Challenge string to be echoed back for debugging purposes."},"required":false,"description":"Challenge string to be echoed back for debugging purposes.","name":"challenge","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthCheckResponse"}}}}}}},"/v5/run":{"get":{"tags":["Meta"],"description":"Test something in development","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"nullable":true}}}}}}},"/v5/inngest-run":{"get":{"tags":["Meta"],"description":"Test something in development using Inngest","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"nullable":true}}}}}}},"/v5/resources/{id}":{"get":{"tags":["Meta"],"description":"Get a resource","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":10000,"description":"The ID of the resource"},"required":true,"description":"The ID of the resource","name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedirectResponse"}}}}}}},"/v5/generations/{objectId}":{"options":{"tags":["Integrations"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":10000,"description":"The ID of the object.","example":"cpg_example"},"required":true,"description":"The ID of the object.","name":"objectId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Integrations"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":10000,"description":"The ID of the object.","example":"cpg_example"},"required":true,"description":"The ID of the object.","name":"objectId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Integrations"],"description":"List generations","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":10000,"description":"The ID of the object.","example":"cpg_example"},"required":true,"description":"The ID of the object.","name":"objectId","in":"path"}],"responses":{"200":{"description":"List of generations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Generation"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/queue":{"options":{"tags":["Queue"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Queue"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":10000,"description":"Token from the queue event."},"required":true,"description":"Token from the queue event.","name":"token","in":"query"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/queue/event-status":{"get":{"tags":["Queue"],"description":"Get queue event status","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":10000,"description":"Token from the queue event."},"required":true,"description":"Token from the queue event.","name":"token","in":"query"}],"responses":{"200":{"description":"Queue event status","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}},"required":["status"]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/logs":{"get":{"tags":["Integrations"],"description":"Get logs","responses":{"200":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/consumer-webhooks/nylas":{"get":{"tags":["Webhooks"],"description":"Respond with the challenge to verify webhook requests","responses":{"200":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Webhooks"],"description":"Receive webhook events","responses":{"200":{"description":"Webhook received","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]}},"required":["success"]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/consumer-webhooks/nylas/callback":{"get":{"tags":["Webhooks"],"description":"Receive OAuth callback","responses":{"200":{"description":"Redirect"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/consumer-webhooks/stripe":{"post":{"tags":["Webhooks"],"description":"Receive Stripe webhook events","responses":{"200":{"description":"Webhook received","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]}},"required":["success"]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/consumer-webhooks/stripe/callback":{"get":{"tags":["Webhooks"],"description":"Handle Stripe checkout success callback","parameters":[{"schema":{"type":"string"},"required":true,"name":"session_id","in":"query"},{"schema":{"type":"string"},"required":false,"name":"name","in":"query"},{"schema":{"type":"string"},"required":false,"name":"company","in":"query"},{"schema":{"type":"string"},"required":false,"name":"email","in":"query"},{"schema":{"type":"string"},"required":false,"name":"website","in":"query"},{"schema":{"type":"string"},"required":false,"name":"rowId","in":"query"}],"responses":{"302":{"description":"Redirect to success page"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/consumer-webhooks/hubspot":{"post":{"tags":["Webhooks"],"description":"Receive webhook events","responses":{"200":{"description":"Webhook received","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]}},"required":["success"]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/tracking":{"get":{"tags":["Tracking"],"description":"Success","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingResponse"}}}}}}},"/v5/tracking/{draftEmailId}/signature-image.gif":{"get":{"tags":["Tracking"],"description":"Get a signature image tracking pixel for a draft email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"responses":{"200":{"description":"Tracking pixel"}}}},"/v5/tracking/{draftEmailId}/:encodedUrl":{"get":{"tags":["Tracking"],"description":"Track a link click and redirect to the original URL","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"responses":{"200":{"description":"HTML page"}}}},"/v5/api-keys":{"options":{"tags":["API Keys"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["API Keys"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["API Keys"],"description":"List API keys","responses":{"200":{"description":"List of API keys","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["API Keys"],"description":"Create a new API key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreate"}}}},"responses":{"200":{"description":"Created API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/api-keys/{apiKeyId}":{"options":{"tags":["API Keys"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the API key.","example":"api_example"},"required":true,"description":"ID of the API key.","name":"apiKeyId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["API Keys"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the API key.","example":"api_example"},"required":true,"description":"ID of the API key.","name":"apiKeyId","in":"path"}],"responses":{"200":{"description":"API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["API Keys"],"description":"Get a apiKey","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the API key.","example":"api_example"},"required":true,"description":"ID of the API key.","name":"apiKeyId","in":"path"}],"responses":{"200":{"description":"API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["API Keys"],"description":"Replace an API key","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the API key.","example":"api_example"},"required":true,"description":"ID of the API key.","name":"apiKeyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreate"}}}},"responses":{"200":{"description":"API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["API Keys"],"description":"Update an API key","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the API key.","example":"api_example"},"required":true,"description":"ID of the API key.","name":"apiKeyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUpdate"}}}},"responses":{"200":{"description":"API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["API Keys"],"description":"Delete an API key","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the API key.","example":"api_example"},"required":true,"description":"ID of the API key.","name":"apiKeyId","in":"path"}],"responses":{"200":{"description":"API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/api-keys/{apiKeyId}/regenerate":{"post":{"tags":["API Keys"],"description":"Regenerate an API key","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the API key.","example":"api_example"},"required":true,"description":"ID of the API key.","name":"apiKeyId","in":"path"}],"responses":{"200":{"description":"API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/auth":{"get":{"tags":["Authentication"],"description":"Get authentication details","responses":{"200":{"description":"Access token or API key","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"accessToken":{"$ref":"#/components/schemas/AccessTokenPayload"}},"required":["accessToken"]},{"type":"object","properties":{"apiKey":{"$ref":"#/components/schemas/ApiKey"}},"required":["apiKey"]}]}}}}}},"post":{"tags":["Authentication"],"description":"Create or refresh an access token","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/LoginCode"},{"$ref":"#/components/schemas/LoginToken"},{"$ref":"#/components/schemas/LoginEmail"}]}}}},"responses":{"200":{"description":"Email sent","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/LoginCodeToken"},{"$ref":"#/components/schemas/LoginToken"}]}}}},"201":{"description":"Tokens","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthTokens"}}}}}},"delete":{"tags":["Authentication"],"description":"Log out to end an authenticated session","responses":{"200":{"description":"Deleted session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}}}}},"/v5/auth/register":{"post":{"tags":["Authentication"],"description":"Register a new user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Register"}}}},"responses":{"200":{"description":"Email sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"409":{"description":"Account already exists","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v5/billing":{"options":{"tags":["Billing"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Billing"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Billing"],"description":"Create a new subscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrice"}}}},"responses":{"200":{"description":"Created subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedirectResponse"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Billing"],"description":"Update billing plan","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrice"}}}},"responses":{"200":{"description":"Updated billing plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Billing"],"description":"Cancel the organization's subscription","responses":{"200":{"description":"Subscription cancelled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/plans":{"get":{"tags":["Billing"],"description":"List billing plans","parameters":[{"schema":{"type":"string","enum":["month","year"],"description":"Filter prices by recurring interval."},"required":false,"description":"Filter prices by recurring interval.","name":"recurringInterval.equals","in":"query"}],"responses":{"200":{"description":"List of billing plans","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Price"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/subscription":{"post":{"tags":["Billing"],"description":"Create a new subscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}}}},"responses":{"200":{"description":"Created subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Billing"],"description":"Update a subscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscription"}}}},"responses":{"200":{"description":"Updated subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/invoices":{"get":{"tags":["Billing"],"description":"List invoices for the organization","responses":{"200":{"description":"List of invoices","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/next-invoice":{"get":{"tags":["Billing"],"description":"Get the next upcoming invoice for the organization","responses":{"200":{"description":"Next invoice","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/undo-cancel":{"post":{"tags":["Billing"],"description":"Undo the cancelation of the organization's subscription","responses":{"200":{"description":"Cancelation undone successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/portal":{"post":{"tags":["Billing"],"description":"Open the Stripe billing portal","responses":{"200":{"description":"Billing portal URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedirectResponse"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/create-intent":{"post":{"tags":["Billing"],"description":"Create a new setup intent","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrice"}}}},"responses":{"200":{"description":"Setup intent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSecretResponse"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/billing/start-trial":{"post":{"tags":["Billing"],"description":"Start a free trial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrice"}}}},"responses":{"200":{"description":"Trial started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/sessions":{"options":{"tags":["Sessions"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Sessions"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Sessions"],"description":"List sessions","responses":{"200":{"description":"List of sessions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Session"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Sessions"],"description":"Create a new session","responses":{"200":{"description":"Created session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/sessions/{sessionId}":{"options":{"tags":["Sessions"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the session.","example":"ses_example"},"required":true,"description":"ID of the session.","name":"sessionId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Sessions"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the session.","example":"ses_example"},"required":true,"description":"ID of the session.","name":"sessionId","in":"path"}],"responses":{"200":{"description":"Session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Sessions"],"description":"Get a session","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the session.","example":"ses_example"},"required":true,"description":"ID of the session.","name":"sessionId","in":"path"}],"responses":{"200":{"description":"Session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Sessions"],"description":"Replace a session","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the session.","example":"ses_example"},"required":true,"description":"ID of the session.","name":"sessionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionCreate"}}}},"responses":{"200":{"description":"Session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Sessions"],"description":"Update a session","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the session.","example":"ses_example"},"required":true,"description":"ID of the session.","name":"sessionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionUpdate"}}}},"responses":{"200":{"description":"Session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Sessions"],"description":"Delete a session","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the session.","example":"ses_example"},"required":true,"description":"ID of the session.","name":"sessionId","in":"path"}],"responses":{"200":{"description":"Session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/users":{"options":{"tags":["Users"],"description":"Returns allowed HTTP methods in headers","responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Users"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Users"],"description":"List users","responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Users"],"description":"Create a new user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"responses":{"200":{"description":"Created user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/users/{userId}":{"options":{"tags":["Users"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Users"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Users"],"description":"Get a user","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Users"],"description":"Replace a user","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Users"],"description":"Update a user","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdate"}}}},"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Users"],"description":"Delete a user","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/users/{userId}/memberships":{"options":{"tags":["User Memberships"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["User Memberships"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["User Memberships"],"description":"List memberships","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the user.","example":"usr_example"},"required":true,"description":"ID of the user.","name":"userId","in":"path"}],"responses":{"200":{"description":"List of memberships","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Membership"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns":{"options":{"tags":["Campaigns"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Campaigns"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaigns"],"description":"List campaigns","responses":{"200":{"description":"List of campaigns","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Campaigns"],"description":"Create a new campaign","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignCreate"}}}},"responses":{"200":{"description":"Created campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}":{"options":{"tags":["Campaigns"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Campaigns"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaigns"],"description":"Get a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Campaigns"],"description":"Replace a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignCreate"}}}},"responses":{"200":{"description":"campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Campaigns"],"description":"Update a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignUpdate"}}}},"responses":{"200":{"description":"campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Campaigns"],"description":"Delete a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/run":{"post":{"tags":["Campaigns"],"description":"Run a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/sequence":{"post":{"tags":["Campaigns"],"description":"Sequence a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/regenerate":{"post":{"tags":["Campaigns"],"description":"Regenerate all sequences in a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"campaign","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/hard-stop":{"post":{"tags":["Campaigns"],"description":"Hard stop a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"Hard stop a campaign","content":{"application/json":{"schema":{"type":"object","properties":{"sequences":{"type":"number","description":"Number of sequences that were hard stopped."},"draftEmails":{"type":"number","description":"Number of draft emails that were unapproved."},"actions":{"type":"number","description":"Number of actions that were updated."}},"required":["sequences","draftEmails","actions"]}}}}}}},"/v5/campaigns/{campaignId}/properties":{"get":{"tags":["Campaigns"],"description":"Get properties for a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"Properties for a campaign","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Property"}}}}}}}},"/v5/campaigns/{campaignId}/fine-tunings":{"get":{"tags":["Campaigns"],"description":"Get fine-tuning rules for a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"Fine-tuning rules for a campaign","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}}}}}},"/v5/campaigns/{campaignId}/connections":{"options":{"tags":["Campaign Connections"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Campaign Connections"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Connections"],"description":"List campaign connections","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"List of campaign connections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CampaignConnection"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/connections/count":{"get":{"tags":["Campaign Connections"],"description":"Count campaign connections","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"Number of campaign connections","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/connections/{campaignConnectionId}":{"options":{"tags":["Campaign Connections"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign connection.","example":"ccn_example"},"required":true,"description":"ID of the campaign connection.","name":"campaignConnectionId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Campaign Connections"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign connection.","example":"ccn_example"},"required":true,"description":"ID of the campaign connection.","name":"campaignConnectionId","in":"path"}],"responses":{"200":{"description":"campaignConnection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignConnection"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Connections"],"description":"Get a campaign connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign connection.","example":"ccn_example"},"required":true,"description":"ID of the campaign connection.","name":"campaignConnectionId","in":"path"}],"responses":{"200":{"description":"campaignConnection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignConnection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Campaign Connections"],"description":"Replace a campaign connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign connection.","example":"ccn_example"},"required":true,"description":"ID of the campaign connection.","name":"campaignConnectionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignConnectionCreate"}}}},"responses":{"200":{"description":"campaignConnection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignConnection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Campaign Connections"],"description":"Update a campaign connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign connection.","example":"ccn_example"},"required":true,"description":"ID of the campaign connection.","name":"campaignConnectionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignConnectionUpdate"}}}},"responses":{"200":{"description":"campaignConnection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignConnection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Campaign Connections"],"description":"Delete a campaign connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign connection.","example":"ccn_example"},"required":true,"description":"ID of the campaign connection.","name":"campaignConnectionId","in":"path"}],"responses":{"200":{"description":"campaignConnection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignConnection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/memberships":{"options":{"tags":["Campaign Memberships"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Campaign Memberships"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Memberships"],"description":"List campaign memberships","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"List of campaign memberships","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CampaignMembership"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Campaign Memberships"],"description":"Create a campaign membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembershipCreate"}}}},"responses":{"200":{"description":"Created campaign membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/memberships/detailed":{"get":{"tags":["Campaign Memberships"],"description":"List memberships with detailed information","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"List of memberships","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationCampaignMembership"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/memberships/{campaignMembershipId}":{"options":{"tags":["Campaign Memberships"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign membership.","example":"cmp_example"},"required":true,"description":"ID of the campaign membership.","name":"campaignMembershipId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Campaign Memberships"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign membership.","example":"cmp_example"},"required":true,"description":"ID of the campaign membership.","name":"campaignMembershipId","in":"path"}],"responses":{"200":{"description":"campaignMembership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembership"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Memberships"],"description":"Get a campaign membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign membership.","example":"cmp_example"},"required":true,"description":"ID of the campaign membership.","name":"campaignMembershipId","in":"path"}],"responses":{"200":{"description":"campaignMembership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Campaign Memberships"],"description":"Replace a campaign membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign membership.","example":"cmp_example"},"required":true,"description":"ID of the campaign membership.","name":"campaignMembershipId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembershipCreate"}}}},"responses":{"200":{"description":"campaignMembership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Campaign Memberships"],"description":"Update a campaign membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign membership.","example":"cmp_example"},"required":true,"description":"ID of the campaign membership.","name":"campaignMembershipId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembershipUpdate"}}}},"responses":{"200":{"description":"campaignMembership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Campaign Memberships"],"description":"Delete a campaign membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign membership.","example":"cmp_example"},"required":true,"description":"ID of the campaign membership.","name":"campaignMembershipId","in":"path"}],"responses":{"200":{"description":"campaignMembership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMembership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/sequences":{"options":{"tags":["Campaign Sequences"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Campaign Sequences"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Sequences"],"description":"List sequences","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"List of sequences","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Sequence"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Campaign Sequences"],"description":"Create a new sequence","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceCreate"}}}},"responses":{"200":{"description":"Created sequence","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sequence"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/sequences/counts":{"get":{"tags":["Campaign Sequences"],"description":"Get the counts of sequences for a campaign","parameters":[{"schema":{"type":"string","minLength":4,"description":"The ID of the campaign.","example":"cpg_example"},"required":true,"description":"The ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"Counts of sequences per type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceCounts"}}}}}}},"/v5/campaigns/{campaignId}/sequences/{sequenceId}":{"options":{"tags":["Campaign Sequences"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Campaign Sequences"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"}],"responses":{"200":{"description":"sequence","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sequence"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Sequences"],"description":"Get a sequence","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"}],"responses":{"200":{"description":"sequence","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sequence"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Campaign Sequences"],"description":"Replace a sequence","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceCreate"}}}},"responses":{"200":{"description":"sequence","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sequence"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Campaign Sequences"],"description":"Update a sequence","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceUpdate"}}}},"responses":{"200":{"description":"sequence","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sequence"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Campaign Sequences"],"description":"Delete a sequence","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"}],"responses":{"200":{"description":"sequence","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sequence"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/sequences/{sequenceId}/preview":{"get":{"tags":["Campaign Sequences"],"description":"Preview a sequence","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"The ID of the variant."},"required":true,"description":"The ID of the variant.","name":"variantId","in":"query"},{"schema":{"type":"string","minLength":4,"description":"The ID of the membership."},"required":false,"description":"The ID of the membership.","name":"membershipId","in":"query"}],"responses":{"200":{"description":"Preview of the sequence","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceContent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/sequences/{sequenceId}/generate":{"post":{"tags":["Campaign Sequences"],"description":"Generate a sequence","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the sequence.","example":"seq_example"},"required":true,"description":"ID of the sequence.","name":"sequenceId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/teams":{"options":{"tags":["Campaign Teams"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Campaign Teams"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Teams"],"description":"List campaign teams","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"List of campaign teams","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CampaignTeam"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Campaign Teams"],"description":"Create a campaign team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeamCreate"}}}},"responses":{"200":{"description":"Created campaign team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeam"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/teams/{campaignTeamId}":{"options":{"tags":["Campaign Teams"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign team.","example":"cte_example"},"required":true,"description":"ID of the campaign team.","name":"campaignTeamId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Campaign Teams"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign team.","example":"cte_example"},"required":true,"description":"ID of the campaign team.","name":"campaignTeamId","in":"path"}],"responses":{"200":{"description":"campaignTeam","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeam"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Teams"],"description":"Get a campaign team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign team.","example":"cte_example"},"required":true,"description":"ID of the campaign team.","name":"campaignTeamId","in":"path"}],"responses":{"200":{"description":"campaignTeam","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeam"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Campaign Teams"],"description":"Replace a campaign team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign team.","example":"cte_example"},"required":true,"description":"ID of the campaign team.","name":"campaignTeamId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeamCreate"}}}},"responses":{"200":{"description":"campaignTeam","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeam"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Campaign Teams"],"description":"Update a campaign team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign team.","example":"cte_example"},"required":true,"description":"ID of the campaign team.","name":"campaignTeamId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeamUpdate"}}}},"responses":{"200":{"description":"campaignTeam","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeam"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Campaign Teams"],"description":"Delete a campaign team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the campaign team.","example":"cte_example"},"required":true,"description":"ID of the campaign team.","name":"campaignTeamId","in":"path"}],"responses":{"200":{"description":"campaignTeam","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTeam"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/variants":{"options":{"tags":["Campaign Variants"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Campaign Variants"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Variants"],"description":"List variants","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"responses":{"200":{"description":"List of variants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Campaign Variants"],"description":"Create a new variant","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantCreate"}}}},"responses":{"200":{"description":"Created variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/variants/{variantId}":{"options":{"tags":["Campaign Variants"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Campaign Variants"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"responses":{"200":{"description":"variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Variants"],"description":"Get a variant","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"responses":{"200":{"description":"variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Campaign Variants"],"description":"Replace a variant","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantCreate"}}}},"responses":{"200":{"description":"variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Campaign Variants"],"description":"Update a variant","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantUpdate"}}}},"responses":{"200":{"description":"variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Campaign Variants"],"description":"Delete a variant","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"responses":{"200":{"description":"variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/variants/{variantId}/variable":{"patch":{"tags":["Campaign Variants"],"description":"Update a variant's variable","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantVariableUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/variants/{variantId}/steps":{"options":{"tags":["Campaign Steps"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Campaign Steps"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Steps"],"description":"List steps","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"responses":{"200":{"description":"List of steps","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Step"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Campaign Steps"],"description":"Create a new step","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepCreate"}}}},"responses":{"200":{"description":"Created step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/campaigns/{campaignId}/variants/{variantId}/steps/{stepId}":{"options":{"tags":["Campaign Steps"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the step.","example":"stp_example"},"required":true,"description":"ID of the step.","name":"stepId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Campaign Steps"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the step.","example":"stp_example"},"required":true,"description":"ID of the step.","name":"stepId","in":"path"}],"responses":{"200":{"description":"step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Campaign Steps"],"description":"Get a step","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the step.","example":"stp_example"},"required":true,"description":"ID of the step.","name":"stepId","in":"path"}],"responses":{"200":{"description":"step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Campaign Steps"],"description":"Replace a step","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the step.","example":"stp_example"},"required":true,"description":"ID of the step.","name":"stepId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepCreate"}}}},"responses":{"200":{"description":"step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Campaign Steps"],"description":"Update a step","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the step.","example":"stp_example"},"required":true,"description":"ID of the step.","name":"stepId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepUpdate"}}}},"responses":{"200":{"description":"step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Campaign Steps"],"description":"Delete a step","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign.","example":"cpg_example"},"required":true,"description":"ID of the campaign.","name":"campaignId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the variant.","example":"var_example"},"required":true,"description":"ID of the variant.","name":"variantId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the step.","example":"stp_example"},"required":true,"description":"ID of the step.","name":"stepId","in":"path"}],"responses":{"200":{"description":"step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/actions":{"options":{"tags":["Actions"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Actions"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Actions"],"description":"List actions","responses":{"200":{"description":"List of actions","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/Membership"},"sourceActivity":{"$ref":"#/components/schemas/Activity"}},"required":["membership","sourceActivity"]}]}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/actions/count":{"get":{"tags":["Actions"],"description":"Count actions","responses":{"200":{"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"_def":{"unknownKeys":"strip","catchall":{"_def":{"typeName":"ZodNever"},"~standard":{"version":1,"vendor":"zod"}},"typeName":"ZodObject","openapi":{"_internal":{"refId":"MissingScopesError"}}},"~standard":{"version":1,"vendor":"zod"},"_cached":null}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"_def":{"unknownKeys":"strip","catchall":{"_def":{"typeName":"ZodNever"},"~standard":{"version":1,"vendor":"zod"}},"typeName":"ZodObject","openapi":{"_internal":{"refId":"ForbiddenError"}}},"~standard":{"version":1,"vendor":"zod"},"_cached":null}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"_def":{"unknownKeys":"strip","catchall":{"_def":{"typeName":"ZodNever"},"~standard":{"version":1,"vendor":"zod"}},"typeName":"ZodObject","openapi":{"_internal":{"refId":"ResourceNotFoundError"}}},"~standard":{"version":1,"vendor":"zod"},"_cached":null}}}},"description":"Number of actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}}}}}},"/v5/actions/{actionId}":{"options":{"tags":["Actions"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the action.","example":"act_example"},"required":true,"description":"ID of the action.","name":"actionId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Actions"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the action.","example":"act_example"},"required":true,"description":"ID of the action.","name":"actionId","in":"path"}],"responses":{"200":{"description":"action","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Action"},{"allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/Membership"},"sourceActivity":{"$ref":"#/components/schemas/Activity"}},"required":["membership","sourceActivity"]}]}]}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Actions"],"description":"Get an action","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the action.","example":"act_example"},"required":true,"description":"ID of the action.","name":"actionId","in":"path"}],"responses":{"200":{"description":"action","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Action"},{"allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/Membership"},"sourceActivity":{"$ref":"#/components/schemas/Activity"}},"required":["membership","sourceActivity"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Actions"],"description":"Replace an action","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the action.","example":"act_example"},"required":true,"description":"ID of the action.","name":"actionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionUpdate"}}}},"responses":{"200":{"description":"action","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Action"},{"allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/Membership"},"sourceActivity":{"$ref":"#/components/schemas/Activity"}},"required":["membership","sourceActivity"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Actions"],"description":"Update an action","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the action.","example":"act_example"},"required":true,"description":"ID of the action.","name":"actionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionUpdate"}}}},"responses":{"200":{"description":"action","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Action"},{"allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/Membership"},"sourceActivity":{"$ref":"#/components/schemas/Activity"}},"required":["membership","sourceActivity"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Actions"],"description":"Delete an action","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the action.","example":"act_example"},"required":true,"description":"ID of the action.","name":"actionId","in":"path"}],"responses":{"200":{"description":"action","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Action"},{"allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/Membership"},"sourceActivity":{"$ref":"#/components/schemas/Activity"}},"required":["membership","sourceActivity"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/actions/{actionId}/sync":{"post":{"tags":["Actions"],"description":"Sync an action","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the action.","example":"act_example"},"required":true,"description":"ID of the action.","name":"actionId","in":"path"}],"responses":{"200":{"description":"action","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Action"},{"allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/Membership"},"sourceActivity":{"$ref":"#/components/schemas/Activity"}},"required":["membership","sourceActivity"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/calendar-events":{"options":{"tags":["Calendar Events"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Calendar Events"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Calendar Events"],"description":"List calendar events","responses":{"200":{"description":"List of calendar events","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalendarEvent"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/calendar-events/{calendarEventId}":{"options":{"tags":["Calendar Events"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Calendar Events"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"responses":{"200":{"description":"calendarEvent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEvent"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Calendar Events"],"description":"Get a calendar event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"responses":{"200":{"description":"calendarEvent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Calendar Events"],"description":"Replace a calendar event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEventCreate"}}}},"responses":{"200":{"description":"calendarEvent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Calendar Events"],"description":"Update a calendar event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEventUpdate"}}}},"responses":{"200":{"description":"calendarEvent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Calendar Events"],"description":"Delete a calendar event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"responses":{"200":{"description":"calendarEvent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/calendar-events/{calendarEventId}/sync":{"post":{"tags":["Calendar Events"],"description":"Sync a calendar event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/calendar-events/{calendarEventId}/process":{"post":{"tags":["Calendar Events"],"description":"Process a calendar event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the calendar event.","example":"eve_example"},"required":true,"description":"ID of the calendar event.","name":"calendarEventId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/draft-emails":{"options":{"tags":["Draft Emails"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Draft Emails"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Draft Emails"],"description":"List draft emails","responses":{"200":{"description":"List of draft emails","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DraftEmail"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Draft Emails"],"description":"Create a draft email","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmailCreate"}}}},"responses":{"200":{"description":"Created draft email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmail"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/draft-emails/count":{"get":{"tags":["Draft Emails"],"description":"Count draft emails","responses":{"200":{"description":"Count of draft emails","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/draft-emails/compose":{"post":{"tags":["Draft Emails"],"description":"Compose a draft email","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeEmailRequest"}}}},"responses":{"200":{"description":"Generated draft email","content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":10000,"description":"Subject line of the email."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Content of the email."}},"required":["subject","body"]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/draft-emails/{draftEmailId}":{"options":{"tags":["Draft Emails"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Draft Emails"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"responses":{"200":{"description":"draftEmail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmail"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Draft Emails"],"description":"Get a draft email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"responses":{"200":{"description":"draftEmail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmail"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Draft Emails"],"description":"Replace a draft email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmailCreate"}}}},"responses":{"200":{"description":"draftEmail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmail"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Draft Emails"],"description":"Update a draft email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmailUpdate"}}}},"responses":{"200":{"description":"draftEmail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmail"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Draft Emails"],"description":"Delete a draft email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the draft email.","example":"dft_example"},"required":true,"description":"ID of the draft email.","name":"draftEmailId","in":"path"}],"responses":{"200":{"description":"draftEmail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftEmail"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/email-addresses":{"options":{"tags":["Email Addresses"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Email Addresses"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Email Addresses"],"description":"List email addresses","responses":{"200":{"description":"List of email addresses","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Email Addresses"],"description":"Create a new email address","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAddressCreate"}}}},"responses":{"200":{"description":"Created email address","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/email-addresses/{emailAddressId}":{"options":{"tags":["Email Addresses"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email address.","example":"ema_example"},"required":true,"description":"ID of the email address.","name":"emailAddressId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Email Addresses"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email address.","example":"ema_example"},"required":true,"description":"ID of the email address.","name":"emailAddressId","in":"path"}],"responses":{"200":{"description":"emailAddress","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Email Addresses"],"description":"Get an email address","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email address.","example":"ema_example"},"required":true,"description":"ID of the email address.","name":"emailAddressId","in":"path"}],"responses":{"200":{"description":"emailAddress","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Email Addresses"],"description":"Replace an email address","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email address.","example":"ema_example"},"required":true,"description":"ID of the email address.","name":"emailAddressId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAddressCreate"}}}},"responses":{"200":{"description":"emailAddress","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Email Addresses"],"description":"Update an email address","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email address.","example":"ema_example"},"required":true,"description":"ID of the email address.","name":"emailAddressId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAddressUpdate"}}}},"responses":{"200":{"description":"emailAddress","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Email Addresses"],"description":"Delete an email address","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email address.","example":"ema_example"},"required":true,"description":"ID of the email address.","name":"emailAddressId","in":"path"}],"responses":{"200":{"description":"emailAddress","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EmailAddressWithContact"},{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"contact":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"allOf":[{"$ref":"#/components/schemas/ContactWithoutRelations"},{"type":"object","nullable":true,"properties":{"employments":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"description":"Employments of the contact."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Value"},"description":"Properties of the contact."}},"required":["employments","properties"]}],"description":"Contact the email address is associated with."}]}},"required":["contact"]}]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/emails":{"options":{"tags":["Emails"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Emails"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Emails"],"description":"List emails","responses":{"200":{"description":"List of emails","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Email"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/emails/{emailId}":{"options":{"tags":["Emails"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Emails"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"responses":{"200":{"description":"email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Emails"],"description":"Get an email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"responses":{"200":{"description":"email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Emails"],"description":"Replace an email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailCreate"}}}},"responses":{"200":{"description":"email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Emails"],"description":"Update an email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailUpdate"}}}},"responses":{"200":{"description":"email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Emails"],"description":"Delete an email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"responses":{"200":{"description":"email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/emails/{emailId}/sync":{"post":{"tags":["Emails"],"description":"Sync an email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/emails/{emailId}/process":{"post":{"tags":["Emails"],"description":"Process an email","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the email.","example":"eml_example"},"required":true,"description":"ID of the email.","name":"emailId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/notes":{"options":{"tags":["Notes"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Notes"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Notes"],"description":"List notes","responses":{"200":{"description":"List of notes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Note"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Notes"],"description":"Create a new note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCreate"}}}},"responses":{"200":{"description":"Created note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/notes/{noteId}":{"options":{"tags":["Notes"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the note.","example":"not_example"},"required":true,"description":"ID of the note.","name":"noteId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Notes"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the note.","example":"not_example"},"required":true,"description":"ID of the note.","name":"noteId","in":"path"}],"responses":{"200":{"description":"note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Notes"],"description":"Get a note","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the note.","example":"not_example"},"required":true,"description":"ID of the note.","name":"noteId","in":"path"}],"responses":{"200":{"description":"note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Notes"],"description":"Replace a note","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the note.","example":"not_example"},"required":true,"description":"ID of the note.","name":"noteId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCreate"}}}},"responses":{"200":{"description":"note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Notes"],"description":"Update a note","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the note.","example":"not_example"},"required":true,"description":"ID of the note.","name":"noteId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteUpdate"}}}},"responses":{"200":{"description":"note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Notes"],"description":"Delete a note","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the note.","example":"not_example"},"required":true,"description":"ID of the note.","name":"noteId","in":"path"}],"responses":{"200":{"description":"note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/tasks":{"options":{"tags":["Tasks"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Tasks"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Tasks"],"description":"List tasks","responses":{"200":{"description":"List of tasks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/tasks/{taskId}":{"options":{"tags":["Tasks"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the task.","example":"tsk_example"},"required":true,"description":"ID of the task.","name":"taskId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Tasks"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the task.","example":"tsk_example"},"required":true,"description":"ID of the task.","name":"taskId","in":"path"}],"responses":{"200":{"description":"task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Tasks"],"description":"Get a task","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the task.","example":"tsk_example"},"required":true,"description":"ID of the task.","name":"taskId","in":"path"}],"responses":{"200":{"description":"task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Tasks"],"description":"Replace a task","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the task.","example":"tsk_example"},"required":true,"description":"ID of the task.","name":"taskId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdate"}}}},"responses":{"200":{"description":"task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Tasks"],"description":"Update a task","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the task.","example":"tsk_example"},"required":true,"description":"ID of the task.","name":"taskId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdate"}}}},"responses":{"200":{"description":"task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Tasks"],"description":"Delete a task","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the task.","example":"tsk_example"},"required":true,"description":"ID of the task.","name":"taskId","in":"path"}],"responses":{"200":{"description":"task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/activities":{"options":{"tags":["Activities"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Activities"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Activities"],"description":"List activities","parameters":[{"schema":{"type":"string","minLength":4},"required":false,"name":"dealId.equals","in":"query"},{"schema":{"type":"string","minLength":4},"required":false,"name":"companyId.equals","in":"query"}],"responses":{"200":{"description":"List of activities","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/activities/{activityId}":{"options":{"tags":["Activities"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Activities"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"responses":{"200":{"description":"activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Activities"],"description":"Get an activity","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"responses":{"200":{"description":"activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Activities"],"description":"Replace an activity","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityCreate"}}}},"responses":{"200":{"description":"activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Activities"],"description":"Update an activity","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityUpdate"}}}},"responses":{"200":{"description":"activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Activities"],"description":"Delete an activity","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"responses":{"200":{"description":"activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/activities/{activityId}/process":{"post":{"tags":["Activities"],"description":"Process an activity","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/activities/{activityId}/regenerate":{"post":{"tags":["Activities"],"description":"Regenerate an activity","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the activity.","example":"atv_example"},"required":true,"description":"ID of the activity.","name":"activityId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityRegenerate"}}}},"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/QueueEvent"},{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/analytics":{"options":{"tags":["Analytics"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Analytics"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/analytics/deals":{"get":{"tags":["Analytics"],"description":"Aggregate analytics for deals","parameters":[{"schema":{"type":"string","minLength":4},"required":false,"name":"pipelineId.equals","in":"query"},{"schema":{"type":"string","minLength":4},"required":false,"name":"campaignId.equals","in":"query"}],"responses":{"200":{"description":"List of analytics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealAnalytics"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/analytics/campaigns":{"get":{"tags":["Analytics"],"description":"Aggregate analytics for campaigns","parameters":[{"schema":{"type":"string","minLength":4},"required":false,"name":"pipelineId.equals","in":"query"},{"schema":{"type":"string","minLength":4},"required":false,"name":"campaignId.equals","in":"query"}],"responses":{"200":{"description":"List of analytics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAnalytics"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/companies":{"options":{"tags":["Companies"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Companies"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Companies"],"description":"List companies","responses":{"200":{"description":"List of companies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Company"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Companies"],"description":"Create a new company","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCreate"}}}},"responses":{"200":{"description":"Created company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/companies/count":{"get":{"tags":["Companies"],"description":"Count companies","responses":{"200":{"description":"Number of companies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/companies/{companyId}":{"options":{"tags":["Companies"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Companies"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"responses":{"200":{"description":"company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Companies"],"description":"Get a company","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"responses":{"200":{"description":"company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Companies"],"description":"Replace a company","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCreate"}}}},"responses":{"200":{"description":"company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Companies"],"description":"Update a company","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyUpdate"}}}},"responses":{"200":{"description":"company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Companies"],"description":"Delete a company","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"responses":{"200":{"description":"company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/companies/{companyId}/employees":{"get":{"tags":["Employees"],"description":"List employees","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"responses":{"200":{"description":"List of employees","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Employment"},{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/ContactWithoutRelations"}},"required":["contact"]}]}}}}}}}},"/v5/companies/{companyId}/enrich":{"post":{"tags":["Companies"],"description":"Enrich a company","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/companies/{companyId}/merge":{"post":{"tags":["Companies"],"description":"Merge a company","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the company.","example":"com_example"},"required":true,"description":"ID of the company.","name":"companyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyMerge"}}}},"responses":{"200":{"description":"company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts":{"options":{"tags":["Contacts"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Contacts"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Contacts"],"description":"List contacts","responses":{"200":{"description":"List of contacts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Contacts"],"description":"Create a new contact","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ContactCreate"},{"type":"object","properties":{"shouldProcess":{"type":"boolean"}}}]}}}},"responses":{"200":{"description":"Created contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/count":{"get":{"tags":["Contacts"],"description":"Count contacts","responses":{"200":{"description":"Number of contacts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/export":{"post":{"tags":["Contacts"],"description":"Export contacts","responses":{"200":{"description":"Exported contacts","content":{"text/csv":{"schema":{"type":"string"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}":{"options":{"tags":["Contacts"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Contacts"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Contacts"],"description":"Get a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Contacts"],"description":"Replace a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCreate"}}}},"responses":{"200":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Contacts"],"description":"Update a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactUpdate"}}}},"responses":{"200":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Contacts"],"description":"Delete a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/enrich":{"post":{"tags":["Contacts"],"description":"Enrich a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/sync":{"post":{"tags":["Contacts"],"description":"Sync a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/sync-email-addresses":{"post":{"tags":["Contacts"],"description":"Sync email addresses for a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/merge":{"post":{"tags":["Contacts"],"description":"Merge a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactMerge"}}}},"responses":{"200":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/process":{"post":{"tags":["Contacts"],"description":"Process a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"},{"schema":{"type":"string"},"required":false,"name":"force","in":"query"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/follow-ups":{"post":{"tags":["Contacts"],"description":"Create follow-ups for a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/related-contacts":{"get":{"tags":["Contacts"],"description":"Get related contacts","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"List of related contacts","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Contact"},{"type":"object","properties":{"relatedReasoning":{"type":"string"}},"required":["relatedReasoning"]}]}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/archive":{"post":{"tags":["Contacts"],"description":"Archive a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/recommend-mailbox":{"get":{"tags":["Contacts"],"description":"Recommend a mailbox for a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"Recommended mailbox","content":{"application/json":{"schema":{"type":"object","properties":{"fromConnectionId":{"type":"string"},"toId":{"type":"string"},"fromEmail":{"type":"string","nullable":true},"toEmail":{"type":"string","nullable":true}},"required":["fromConnectionId","toId","fromEmail","toEmail"]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/summarize":{"post":{"tags":["Contacts"],"description":"Summarize a contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/employments":{"options":{"tags":["Employments"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Employments"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Employments"],"description":"List employments","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"responses":{"200":{"description":"List of employments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Employment"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Employments"],"description":"Create a new employment","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmploymentCreate"}}}},"responses":{"200":{"description":"Created employment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/contacts/{contactId}/employments/{employmentId}":{"options":{"tags":["Employments"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the employment.","example":"emp_example"},"required":true,"description":"ID of the employment.","name":"employmentId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Employments"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the employment.","example":"emp_example"},"required":true,"description":"ID of the employment.","name":"employmentId","in":"path"}],"responses":{"200":{"description":"employment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Employments"],"description":"Get a employment","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the employment.","example":"emp_example"},"required":true,"description":"ID of the employment.","name":"employmentId","in":"path"}],"responses":{"200":{"description":"employment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Employments"],"description":"Replace a employment","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the employment.","example":"emp_example"},"required":true,"description":"ID of the employment.","name":"employmentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmploymentCreate"}}}},"responses":{"200":{"description":"employment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Employments"],"description":"Update a employment","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the employment.","example":"emp_example"},"required":true,"description":"ID of the employment.","name":"employmentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmploymentUpdate"}}}},"responses":{"200":{"description":"employment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Employments"],"description":"Delete a employment","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the contact.","example":"con_example"},"required":true,"description":"ID of the contact.","name":"contactId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the employment.","example":"emp_example"},"required":true,"description":"ID of the employment.","name":"employmentId","in":"path"}],"responses":{"200":{"description":"employment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/deleted-contacts":{"options":{"tags":["Deleted Contacts"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Deleted Contacts"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Deleted Contacts"],"description":"List deletedContacts","responses":{"200":{"description":"List of deletedContacts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeletedContact"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Deleted Contacts"],"description":"Create a new deleted contact","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContactCreate"}}}},"responses":{"200":{"description":"Created deleted contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/deleted-contacts/{deletedContactId}":{"options":{"tags":["Deleted Contacts"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deleted contact.","example":"del_example"},"required":true,"description":"ID of the deleted contact.","name":"deletedContactId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Deleted Contacts"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deleted contact.","example":"del_example"},"required":true,"description":"ID of the deleted contact.","name":"deletedContactId","in":"path"}],"responses":{"200":{"description":"deletedContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContact"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Deleted Contacts"],"description":"Get a deleted contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deleted contact.","example":"del_example"},"required":true,"description":"ID of the deleted contact.","name":"deletedContactId","in":"path"}],"responses":{"200":{"description":"deletedContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Deleted Contacts"],"description":"Replace a deleted contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deleted contact.","example":"del_example"},"required":true,"description":"ID of the deleted contact.","name":"deletedContactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContactCreate"}}}},"responses":{"200":{"description":"deletedContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Deleted Contacts"],"description":"Update a deleted contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deleted contact.","example":"del_example"},"required":true,"description":"ID of the deleted contact.","name":"deletedContactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContactUpdate"}}}},"responses":{"200":{"description":"deletedContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Deleted Contacts"],"description":"Delete a deleted contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deleted contact.","example":"del_example"},"required":true,"description":"ID of the deleted contact.","name":"deletedContactId","in":"path"}],"responses":{"200":{"description":"deletedContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/domains":{"options":{"tags":["Domains"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Domains"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Domains"],"description":"List domains","responses":{"200":{"description":"List of domains","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Domains"],"description":"Create a new domain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainCreate"}}}},"responses":{"200":{"description":"Created domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/domains/{domainId}":{"options":{"tags":["Domains"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the domain.","example":"dom_example"},"required":true,"description":"ID of the domain.","name":"domainId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Domains"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the domain.","example":"dom_example"},"required":true,"description":"ID of the domain.","name":"domainId","in":"path"}],"responses":{"200":{"description":"domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Domains"],"description":"Get a domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the domain.","example":"dom_example"},"required":true,"description":"ID of the domain.","name":"domainId","in":"path"}],"responses":{"200":{"description":"domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Domains"],"description":"Replace a domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the domain.","example":"dom_example"},"required":true,"description":"ID of the domain.","name":"domainId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainCreate"}}}},"responses":{"200":{"description":"domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Domains"],"description":"Update a domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the domain.","example":"dom_example"},"required":true,"description":"ID of the domain.","name":"domainId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainUpdate"}}}},"responses":{"200":{"description":"domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Domains"],"description":"Delete a domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the domain.","example":"dom_example"},"required":true,"description":"ID of the domain.","name":"domainId","in":"path"}],"responses":{"200":{"description":"domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/properties":{"options":{"tags":["Properties"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Properties"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Properties"],"description":"List properties","responses":{"200":{"description":"List of properties","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Property"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Properties"],"description":"Create a new property","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCreate"}}}},"responses":{"200":{"description":"Created property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/properties/{propertyId}":{"options":{"tags":["Properties"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the property.","example":"pro_example"},"required":true,"description":"ID of the property.","name":"propertyId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Properties"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the property.","example":"pro_example"},"required":true,"description":"ID of the property.","name":"propertyId","in":"path"}],"responses":{"200":{"description":"property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Properties"],"description":"Get a property","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the property.","example":"pro_example"},"required":true,"description":"ID of the property.","name":"propertyId","in":"path"}],"responses":{"200":{"description":"property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Properties"],"description":"Replace a property","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the property.","example":"pro_example"},"required":true,"description":"ID of the property.","name":"propertyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCreate"}}}},"responses":{"200":{"description":"property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Properties"],"description":"Update a property","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the property.","example":"pro_example"},"required":true,"description":"ID of the property.","name":"propertyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdate"}}}},"responses":{"200":{"description":"property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Properties"],"description":"Delete a property","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the property.","example":"pro_example"},"required":true,"description":"ID of the property.","name":"propertyId","in":"path"}],"responses":{"200":{"description":"property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/suppression-lists":{"options":{"tags":["Suppression Lists"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Suppression Lists"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Suppression Lists"],"description":"List suppression lists","responses":{"200":{"description":"List of suppression lists","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuppressionList"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Suppression Lists"],"description":"Create a new suppression list","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionListCreate"}}}},"responses":{"200":{"description":"Created suppression list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionList"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/suppression-lists/{suppressionListId}":{"options":{"tags":["Suppression Lists"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Suppression Lists"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"responses":{"200":{"description":"suppressionList","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionList"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Suppression Lists"],"description":"Get a suppression list","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"responses":{"200":{"description":"suppressionList","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionList"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Suppression Lists"],"description":"Replace a suppression list","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionListCreate"}}}},"responses":{"200":{"description":"suppressionList","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionList"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Suppression Lists"],"description":"Update a suppression list","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionListUpdate"}}}},"responses":{"200":{"description":"suppressionList","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionList"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Suppression Lists"],"description":"Delete a suppression list","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"responses":{"200":{"description":"suppressionList","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionList"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/suppression-lists/{suppressionListId}/suppressions":{"options":{"tags":["Suppressions"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Suppressions"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Suppressions"],"description":"List suppressions","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"responses":{"200":{"description":"List of suppressions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Suppressions"],"description":"Create a new suppression","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionCreate"}}}},"responses":{"200":{"description":"Created suppression","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/suppression-lists/{suppressionListId}/suppressions/{suppressionId}":{"options":{"tags":["Suppressions"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the suppression.","example":"sup_example"},"required":true,"description":"ID of the suppression.","name":"suppressionId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Suppressions"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the suppression.","example":"sup_example"},"required":true,"description":"ID of the suppression.","name":"suppressionId","in":"path"}],"responses":{"200":{"description":"suppression","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Suppressions"],"description":"Get a suppression","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the suppression.","example":"sup_example"},"required":true,"description":"ID of the suppression.","name":"suppressionId","in":"path"}],"responses":{"200":{"description":"suppression","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Suppressions"],"description":"Replace a suppression","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the suppression.","example":"sup_example"},"required":true,"description":"ID of the suppression.","name":"suppressionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionCreate"}}}},"responses":{"200":{"description":"suppression","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Suppressions"],"description":"Update a suppression","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the suppression.","example":"sup_example"},"required":true,"description":"ID of the suppression.","name":"suppressionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionUpdate"}}}},"responses":{"200":{"description":"suppression","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Suppressions"],"description":"Delete a suppression","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the suppression list.","example":"sul_example"},"required":true,"description":"ID of the suppression list.","name":"suppressionListId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the suppression.","example":"sup_example"},"required":true,"description":"ID of the suppression.","name":"suppressionId","in":"path"}],"responses":{"200":{"description":"suppression","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/values":{"options":{"tags":["Values"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Values"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Values"],"description":"List values","responses":{"200":{"description":"List of values","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Value"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Values"],"description":"Create a new value","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueCreate"}}}},"responses":{"200":{"description":"Created value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Value"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/values/{valueId}":{"options":{"tags":["Values"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the value.","example":"val_example"},"required":true,"description":"ID of the value.","name":"valueId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Values"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the value.","example":"val_example"},"required":true,"description":"ID of the value.","name":"valueId","in":"path"}],"responses":{"200":{"description":"value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Value"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Values"],"description":"Get a value","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the value.","example":"val_example"},"required":true,"description":"ID of the value.","name":"valueId","in":"path"}],"responses":{"200":{"description":"value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Value"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Values"],"description":"Replace a value","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the value.","example":"val_example"},"required":true,"description":"ID of the value.","name":"valueId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueCreate"}}}},"responses":{"200":{"description":"value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Value"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Values"],"description":"Update a value","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the value.","example":"val_example"},"required":true,"description":"ID of the value.","name":"valueId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueUpdate"}}}},"responses":{"200":{"description":"value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Value"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Values"],"description":"Delete a value","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the value.","example":"val_example"},"required":true,"description":"ID of the value.","name":"valueId","in":"path"}],"responses":{"200":{"description":"value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Value"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/views":{"options":{"tags":["Views"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Views"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Views"],"description":"List views","responses":{"200":{"description":"List of views","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/View"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Views"],"description":"Create a new view","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewCreate"}}}},"responses":{"200":{"description":"Created view","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/views/count":{"get":{"tags":["Views"],"description":"Count contacts in a view","parameters":[{"schema":{"anyOf":[{"type":"array","items":{"type":"string","minLength":4},"default":[]},{"type":"string","minLength":4}]},"required":false,"name":"viewId[]","in":"query"}],"responses":{"200":{"description":"Number of contacts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/views/recommend-name":{"post":{"tags":["Views"],"description":"Generate a name for a view","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/ViewFilters"}},"required":["filters"]}}}},"responses":{"200":{"description":"Generated view name","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"required":["name","description"]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/views/{viewId}":{"options":{"tags":["Views"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the view.","example":"vie_example"},"required":true,"description":"ID of the view.","name":"viewId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Views"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the view.","example":"vie_example"},"required":true,"description":"ID of the view.","name":"viewId","in":"path"}],"responses":{"200":{"description":"view","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Views"],"description":"Get a view","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the view.","example":"vie_example"},"required":true,"description":"ID of the view.","name":"viewId","in":"path"}],"responses":{"200":{"description":"view","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Views"],"description":"Replace a view","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the view.","example":"vie_example"},"required":true,"description":"ID of the view.","name":"viewId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewCreate"}}}},"responses":{"200":{"description":"view","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Views"],"description":"Update a view","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the view.","example":"vie_example"},"required":true,"description":"ID of the view.","name":"viewId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewUpdate"}}}},"responses":{"200":{"description":"view","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Views"],"description":"Delete a view","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the view.","example":"vie_example"},"required":true,"description":"ID of the view.","name":"viewId","in":"path"}],"responses":{"200":{"description":"view","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/deals":{"options":{"tags":["Deals"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Deals"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Deals"],"description":"List deals","responses":{"200":{"description":"List of deals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Deal"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Deals"],"description":"Create a new deal","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealCreate"}}}},"responses":{"200":{"description":"Created deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/deals/{dealId}":{"options":{"tags":["Deals"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Deals"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Deals"],"description":"Get a deal","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Deals"],"description":"Replace a deal","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealCreate"}}}},"responses":{"200":{"description":"deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Deals"],"description":"Update a deal","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealUpdate"}}}},"responses":{"200":{"description":"deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Deals"],"description":"Delete a deal","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/deals/{dealId}/sync":{"post":{"tags":["Deals"],"description":"Sync a deal","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/deals/{dealId}/connection-map-items":{"get":{"tags":["Deals"],"description":"Get a deal's connection map items","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"Connection map items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"connection":{"$ref":"#/components/schemas/Connection"},"value":{"type":"string"}},"required":["connection","value"]}}}}}}}},"/v5/deals/{dealId}/contacts":{"get":{"tags":["Deals"],"description":"Get a deal's contacts","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"Deal's contacts","content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"$ref":"#/components/schemas/Membership"},"contacts":{"type":"array","items":{"type":"object","properties":{"pointOfContactId":{"type":"string","minLength":4},"employmentId":{"type":"string","minLength":4},"contact":{"$ref":"#/components/schemas/ContactWithoutRelations"}},"required":["pointOfContactId","employmentId","contact"]}}},"required":["owner","contacts"]}}}}}}},"/v5/deals/{dealId}/points-of-contact":{"options":{"tags":["Points of Contact"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Points of Contact"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Points of Contact"],"description":"List points of contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"responses":{"200":{"description":"List of points of contact","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PointOfContact"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Points of Contact"],"description":"Create a new point of contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContactCreate"}}}},"responses":{"200":{"description":"Created point of contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/deals/{dealId}/points-of-contact/{pointOfContactId}":{"options":{"tags":["Points of Contact"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the point of contact.","example":"poc_example"},"required":true,"description":"ID of the point of contact.","name":"pointOfContactId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Points of Contact"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the point of contact.","example":"poc_example"},"required":true,"description":"ID of the point of contact.","name":"pointOfContactId","in":"path"}],"responses":{"200":{"description":"pointOfContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContact"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Points of Contact"],"description":"Get a point of contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the point of contact.","example":"poc_example"},"required":true,"description":"ID of the point of contact.","name":"pointOfContactId","in":"path"}],"responses":{"200":{"description":"pointOfContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Points of Contact"],"description":"Replace a point of contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the point of contact.","example":"poc_example"},"required":true,"description":"ID of the point of contact.","name":"pointOfContactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContactCreate"}}}},"responses":{"200":{"description":"pointOfContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Points of Contact"],"description":"Update a point of contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the point of contact.","example":"poc_example"},"required":true,"description":"ID of the point of contact.","name":"pointOfContactId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContactUpdate"}}}},"responses":{"200":{"description":"pointOfContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Points of Contact"],"description":"Delete a point of contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the deal.","example":"dea_example"},"required":true,"description":"ID of the deal.","name":"dealId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the point of contact.","example":"poc_example"},"required":true,"description":"ID of the point of contact.","name":"pointOfContactId","in":"path"}],"responses":{"200":{"description":"pointOfContact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointOfContact"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/pipelines":{"options":{"tags":["Pipelines"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Pipelines"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Pipelines"],"description":"List pipelines","responses":{"200":{"description":"List of pipelines","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Pipelines"],"description":"Create a new pipeline","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCreate"}}}},"responses":{"200":{"description":"Created pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/pipelines/autocomplete-description":{"post":{"tags":["Pipelines"],"description":"Recommend a description for a pipeline","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineUpdate"}}}},"responses":{"200":{"description":"Recommended description","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"}}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/pipelines/{pipelineId}":{"options":{"tags":["Pipelines"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Pipelines"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"200":{"description":"pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Pipelines"],"description":"Get a pipeline","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"200":{"description":"pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Pipelines"],"description":"Replace a pipeline","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCreate"}}}},"responses":{"200":{"description":"pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Pipelines"],"description":"Update a pipeline","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineUpdate"}}}},"responses":{"200":{"description":"pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Pipelines"],"description":"Delete a pipeline","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"200":{"description":"pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/pipelines/{pipelineId}/connection-map-items":{"get":{"tags":["Pipelines"],"description":"Get a pipeline's connection map items","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"200":{"description":"Connection map items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"connection":{"$ref":"#/components/schemas/Connection"},"value":{"type":"string"}},"required":["connection","value"]}}}}}}}},"/v5/pipelines/{pipelineId}/recalculate-weight":{"post":{"tags":["Pipelines"],"description":"Recalculate the weight of a pipeline","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/pipelines/{pipelineId}/stages":{"options":{"tags":["Pipeline Stages"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Pipeline Stages"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Pipeline Stages"],"description":"List stages","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"responses":{"200":{"description":"List of stages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Pipeline Stages"],"description":"Create a new stage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StageCreate"}}}},"responses":{"200":{"description":"Created stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/pipelines/{pipelineId}/stages/{stageId}":{"options":{"tags":["Pipeline Stages"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the stage.","example":"stg_example"},"required":true,"description":"ID of the stage.","name":"stageId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Pipeline Stages"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the stage.","example":"stg_example"},"required":true,"description":"ID of the stage.","name":"stageId","in":"path"}],"responses":{"200":{"description":"stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Pipeline Stages"],"description":"Get a stage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the stage.","example":"stg_example"},"required":true,"description":"ID of the stage.","name":"stageId","in":"path"}],"responses":{"200":{"description":"stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Pipeline Stages"],"description":"Replace a stage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the stage.","example":"stg_example"},"required":true,"description":"ID of the stage.","name":"stageId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StageCreate"}}}},"responses":{"200":{"description":"stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Pipeline Stages"],"description":"Update a stage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the stage.","example":"stg_example"},"required":true,"description":"ID of the stage.","name":"stageId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StageUpdate"}}}},"responses":{"200":{"description":"stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Pipeline Stages"],"description":"Delete a stage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the stage.","example":"stg_example"},"required":true,"description":"ID of the stage.","name":"stageId","in":"path"}],"responses":{"200":{"description":"stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/pipelines/{pipelineId}/stages/{stageId}/reorder":{"post":{"tags":["Pipeline Stages"],"description":"Reorder a stage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the pipeline.","example":"pip_example"},"required":true,"description":"ID of the pipeline.","name":"pipelineId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the stage.","example":"stg_example"},"required":true,"description":"ID of the stage.","name":"stageId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StageReorder"}}}},"responses":{"200":{"description":"stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/files":{"options":{"tags":["Import Files"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Import Files"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Import Files"],"description":"List files","responses":{"200":{"description":"List of files","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Import Files"],"description":"Create a new file","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileCreate"}}}},"responses":{"200":{"description":"Created file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/files/{fileId}":{"options":{"tags":["Import Files"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the file.","example":"fil_example"},"required":true,"description":"ID of the file.","name":"fileId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Import Files"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the file.","example":"fil_example"},"required":true,"description":"ID of the file.","name":"fileId","in":"path"}],"responses":{"200":{"description":"file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Import Files"],"description":"Get a file","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the file.","example":"fil_example"},"required":true,"description":"ID of the file.","name":"fileId","in":"path"}],"responses":{"200":{"description":"file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Import Files"],"description":"Replace a file","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the file.","example":"fil_example"},"required":true,"description":"ID of the file.","name":"fileId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileCreate"}}}},"responses":{"200":{"description":"file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Import Files"],"description":"Update a file","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the file.","example":"fil_example"},"required":true,"description":"ID of the file.","name":"fileId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUpdate"}}}},"responses":{"200":{"description":"file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Import Files"],"description":"Delete a file","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the file.","example":"fil_example"},"required":true,"description":"ID of the file.","name":"fileId","in":"path"}],"responses":{"200":{"description":"file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports":{"options":{"tags":["Imports"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Imports"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Imports"],"description":"List imports","responses":{"200":{"description":"List of imports","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Import"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Imports"],"description":"Create a new import","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportCreate"}}}},"responses":{"200":{"description":"Created import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}":{"options":{"tags":["Imports"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Imports"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Imports"],"description":"Get an import","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Imports"],"description":"Replace an import","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportCreate"}}}},"responses":{"200":{"description":"import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Imports"],"description":"Update an import","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportUpdate"}}}},"responses":{"200":{"description":"import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Imports"],"description":"Delete an import","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/run":{"post":{"tags":["Imports"],"description":"Run an import","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/trigger/{hash}":{"options":{"tags":["Imports"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","description":"Hash of the webhook.","example":"fqw_1uXtZuqflcQJHdbEtCgt9w1d1a9a9ab"},"required":true,"description":"Hash of the webhook.","name":"hash","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Imports"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","description":"Hash of the webhook.","example":"fqw_1uXtZuqflcQJHdbEtCgt9w1d1a9a9ab"},"required":true,"description":"Hash of the webhook.","name":"hash","in":"path"}],"responses":{"200":{"description":"Created row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Imports"],"description":"Checks if a webhook is valid","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","description":"Hash of the webhook.","example":"fqw_1uXtZuqflcQJHdbEtCgt9w1d1a9a9ab"},"required":true,"description":"Hash of the webhook.","name":"hash","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Imports"],"description":"Trigger a webhook import","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","description":"Hash of the webhook.","example":"fqw_1uXtZuqflcQJHdbEtCgt9w1d1a9a9ab"},"required":true,"description":"Hash of the webhook.","name":"hash","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"nullable":true}}}},"responses":{"200":{"description":"Created row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/trigger/{hash}/note":{"post":{"tags":["Imports"],"description":"Create a note for a row or contact","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","description":"Hash of the webhook.","example":"fqw_1uXtZuqflcQJHdbEtCgt9w1d1a9a9ab"},"required":true,"description":"Hash of the webhook.","name":"hash","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailNoteRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}}}},"/v5/imports/{importId}/qualifying-questions":{"options":{"tags":["Qualifying Questions"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Qualifying Questions"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Qualifying Questions"],"description":"List qualifying questions","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"List of qualifying questions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QualifyingQuestion"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Qualifying Questions"],"description":"Create a new qualifying question","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestionCreate"}}}},"responses":{"200":{"description":"Created qualifying question","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestion"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/qualifying-questions/counts":{"get":{"tags":["Qualifying Questions"],"description":"Count qualifying questions","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"Number of qualifying questions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestionCounts"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/qualifying-questions/{qualifyingQuestionId}":{"options":{"tags":["Qualifying Questions"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the qualifyingQuestion.","example":"quq_example"},"required":true,"description":"ID of the qualifyingQuestion.","name":"qualifyingQuestionId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Qualifying Questions"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the qualifyingQuestion.","example":"quq_example"},"required":true,"description":"ID of the qualifyingQuestion.","name":"qualifyingQuestionId","in":"path"}],"responses":{"200":{"description":"qualifyingQuestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestion"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Qualifying Questions"],"description":"Get a qualifying question","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the qualifyingQuestion.","example":"quq_example"},"required":true,"description":"ID of the qualifyingQuestion.","name":"qualifyingQuestionId","in":"path"}],"responses":{"200":{"description":"qualifyingQuestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestion"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Qualifying Questions"],"description":"Replace a qualifying question","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the qualifyingQuestion.","example":"quq_example"},"required":true,"description":"ID of the qualifyingQuestion.","name":"qualifyingQuestionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestionCreate"}}}},"responses":{"200":{"description":"qualifyingQuestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestion"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Qualifying Questions"],"description":"Update a qualifying question","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the qualifyingQuestion.","example":"quq_example"},"required":true,"description":"ID of the qualifyingQuestion.","name":"qualifyingQuestionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestionUpdate"}}}},"responses":{"200":{"description":"qualifyingQuestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestion"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Qualifying Questions"],"description":"Delete a qualifying question","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the qualifyingQuestion.","example":"quq_example"},"required":true,"description":"ID of the qualifyingQuestion.","name":"qualifyingQuestionId","in":"path"}],"responses":{"200":{"description":"qualifyingQuestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualifyingQuestion"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/rows":{"options":{"tags":["Import Rows"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"204":{"description":"No content"}}},"head":{"tags":["Import Rows"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Import Rows"],"description":"List rows","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"List of rows","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Row"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Import Rows"],"description":"Create a new row","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowCreate"}}}},"responses":{"200":{"description":"Created row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/rows/counts":{"get":{"tags":["Import Rows"],"description":"Get the counts of rows for an import","parameters":[{"schema":{"type":"string","minLength":4,"description":"The ID of the import.","example":"imp_example"},"required":true,"description":"The ID of the import.","name":"importId","in":"path"}],"responses":{"200":{"description":"Counts of rows per type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowCounts"}}}}}}},"/v5/imports/{importId}/rows/{rowId}":{"options":{"tags":["Import Rows"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the row.","example":"row_example"},"required":true,"description":"ID of the row.","name":"rowId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Import Rows"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the row.","example":"row_example"},"required":true,"description":"ID of the row.","name":"rowId","in":"path"}],"responses":{"200":{"description":"row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Import Rows"],"description":"Get a row","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the row.","example":"row_example"},"required":true,"description":"ID of the row.","name":"rowId","in":"path"}],"responses":{"200":{"description":"row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Import Rows"],"description":"Replace a row","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the row.","example":"row_example"},"required":true,"description":"ID of the row.","name":"rowId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowCreate"}}}},"responses":{"200":{"description":"row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Import Rows"],"description":"Update a row","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the row.","example":"row_example"},"required":true,"description":"ID of the row.","name":"rowId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowUpdate"}}}},"responses":{"200":{"description":"row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Import Rows"],"description":"Delete a row","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the row.","example":"row_example"},"required":true,"description":"ID of the row.","name":"rowId","in":"path"}],"responses":{"200":{"description":"row","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Row"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/imports/{importId}/rows/{rowId}/qualify":{"post":{"tags":["Import Rows"],"description":"Qualify a row","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the import.","example":"imp_example"},"required":true,"description":"ID of the import.","name":"importId","in":"path"},{"schema":{"type":"string","minLength":4,"description":"ID of the row.","example":"row_example"},"required":true,"description":"ID of the row.","name":"rowId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/connections":{"options":{"tags":["Connections"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Connections"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Connections"],"description":"List connections","responses":{"200":{"description":"List of connections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Connections"],"description":"Create a new connections","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionCreateOAuth"}}}},"responses":{"200":{"description":"Created connection","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Connection"},{"type":"object","properties":{"redirectUrl":{"type":"string","format":"uri"}},"required":["redirectUrl"]}]}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/connections/{connectionId}":{"options":{"tags":["Connections"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Connections"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Connections"],"description":"Get a connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Connections"],"description":"Replace a connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionCreate"}}}},"responses":{"200":{"description":"connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Connections"],"description":"Update a connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionUpdate"}}}},"responses":{"200":{"description":"connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Connections"],"description":"Delete a connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/connections/{connectionId}/sync":{"post":{"tags":["Connections"],"parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/connections/{connectionId}/crm/hubspot":{"get":{"tags":["Connections"],"description":"Get HubSpot connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"HubSpot connection","content":{"application/json":{"schema":{"nullable":true}}}}}},"patch":{"tags":["Connections"],"description":"Update a HubSpot connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubSpotData"}}}},"responses":{"200":{"description":"connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/connections/{connectionId}/crm/hubspot/pipelines":{"get":{"tags":["Connections"],"description":"List pipelines for a HubSpot connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"HubSpot pipelines","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HubSpotPipelineResponse"}}}}}}}},"/v5/connections/{connectionId}/crm/hubspot/pipelines/:pipelineId":{"get":{"tags":["Connections"],"description":"Get a HubSpot pipeline","parameters":[{"schema":{"type":"string","minLength":4},"required":true,"name":"connectionId","in":"path"},{"schema":{"type":"string"},"required":true,"name":"pipelineId","in":"path"}],"responses":{"200":{"description":"HubSpot pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubSpotPipelineResponse"}}}}}}},"/v5/connections/{connectionId}/crm/hubspot/deals":{"get":{"tags":["Connections"],"description":"List deals for a HubSpot connection","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the connection.","example":"cxn_example"},"required":true,"description":"ID of the connection.","name":"connectionId","in":"path"}],"responses":{"200":{"description":"HubSpot deals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HubSpotDealResponse"}}}}}}}},"/v5/connections/{connectionId}/crm/hubspot/deals/:dealId":{"get":{"tags":["Connections"],"description":"Get a HubSpot deal","parameters":[{"schema":{"type":"string","minLength":4},"required":true,"name":"connectionId","in":"path"},{"schema":{"type":"string"},"required":true,"name":"dealId","in":"path"}],"responses":{"200":{"description":"HubSpot deal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubSpotDealResponse"}}}}}}},"/v5/connections/{connectionId}/crm/hubspot/synced-deals":{"get":{"tags":["Connections"],"description":"Get all synced HubSpot deals","parameters":[{"schema":{"type":"string","minLength":4},"required":true,"name":"connectionId","in":"path"}],"responses":{"200":{"description":"HubSpot synced deals map","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"pipelineId":{"type":"string"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/HubSpotDealResponse"}}},"required":["pipelineId","deals"]}}}}}}}},"/v5/connections/{connectionId}/crm/hubspot/imports/contacts":{"post":{"tags":["Connections"],"description":"Create an import of all HubSpot contacts","parameters":[{"schema":{"type":"string","minLength":4},"required":true,"name":"connectionId","in":"path"}],"responses":{"200":{"description":"HubSpot synced contacts map","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}}}}}},"/v5/tracking-domains":{"options":{"tags":["Tracking Domains"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Tracking Domains"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Tracking Domains"],"description":"List tracking domains","responses":{"200":{"description":"List of tracking domains","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TrackingDomain"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Tracking Domains"],"description":"Create a new tracking domain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomainCreate"}}}},"responses":{"200":{"description":"Created tracking domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/tracking-domains/{trackingDomainId}":{"options":{"tags":["Tracking Domains"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the tracking-domain.","example":"trd_example"},"required":true,"description":"ID of the tracking-domain.","name":"trackingDomainId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Tracking Domains"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the tracking-domain.","example":"trd_example"},"required":true,"description":"ID of the tracking-domain.","name":"trackingDomainId","in":"path"}],"responses":{"200":{"description":"trackingDomain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomain"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Tracking Domains"],"description":"Get a tracking domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the tracking-domain.","example":"trd_example"},"required":true,"description":"ID of the tracking-domain.","name":"trackingDomainId","in":"path"}],"responses":{"200":{"description":"trackingDomain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Tracking Domains"],"description":"Replace a tracking domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the tracking-domain.","example":"trd_example"},"required":true,"description":"ID of the tracking-domain.","name":"trackingDomainId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomainCreate"}}}},"responses":{"200":{"description":"trackingDomain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Tracking Domains"],"description":"Update a tracking domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the tracking-domain.","example":"trd_example"},"required":true,"description":"ID of the tracking-domain.","name":"trackingDomainId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomainUpdate"}}}},"responses":{"200":{"description":"trackingDomain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Tracking Domains"],"description":"Delete a tracking domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the tracking-domain.","example":"trd_example"},"required":true,"description":"ID of the tracking-domain.","name":"trackingDomainId","in":"path"}],"responses":{"200":{"description":"trackingDomain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDomain"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/tracking-domains/{trackingDomainId}/verify":{"post":{"tags":["Tracking Domains"],"description":"Verify a tracking domain","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the tracking-domain.","example":"trd_example"},"required":true,"description":"ID of the tracking-domain.","name":"trackingDomainId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/events":{"options":{"tags":["Events"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Events"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Events"],"description":"List events","responses":{"200":{"description":"List of events","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/events/{eventId}":{"options":{"tags":["Events"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the event.","example":"evt_example"},"required":true,"description":"ID of the event.","name":"eventId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Events"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the event.","example":"evt_example"},"required":true,"description":"ID of the event.","name":"eventId","in":"path"}],"responses":{"200":{"description":"event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Events"],"description":"Get a event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the event.","example":"evt_example"},"required":true,"description":"ID of the event.","name":"eventId","in":"path"}],"responses":{"200":{"description":"event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Events"],"description":"Delete an event","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the event.","example":"evt_example"},"required":true,"description":"ID of the event.","name":"eventId","in":"path"}],"responses":{"200":{"description":"event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/memberships":{"options":{"tags":["Memberships"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Memberships"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Memberships"],"description":"List memberships","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the campaign to select memberships for. If this value is provided, the campaign details and relevant connections will be included too.","example":"cpg_example"},"required":false,"description":"ID of the campaign to select memberships for. If this value is provided, the campaign details and relevant connections will be included too.","name":"campaignId.equals","in":"query"}],"responses":{"200":{"description":"List of memberships","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Membership"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Memberships"],"description":"Create a new membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipCreate"}}}},"responses":{"200":{"description":"Created membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/memberships/{membershipId}":{"options":{"tags":["Memberships"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the membership.","example":"mem_example"},"required":true,"description":"ID of the membership.","name":"membershipId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Memberships"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the membership.","example":"mem_example"},"required":true,"description":"ID of the membership.","name":"membershipId","in":"path"}],"responses":{"200":{"description":"membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Memberships"],"description":"Get a membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the membership.","example":"mem_example"},"required":true,"description":"ID of the membership.","name":"membershipId","in":"path"}],"responses":{"200":{"description":"membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Memberships"],"description":"Replace a membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the membership.","example":"mem_example"},"required":true,"description":"ID of the membership.","name":"membershipId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipCreate"}}}},"responses":{"200":{"description":"membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Memberships"],"description":"Update a membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the membership.","example":"mem_example"},"required":true,"description":"ID of the membership.","name":"membershipId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipUpdate"}}}},"responses":{"200":{"description":"membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Memberships"],"description":"Delete a membership","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the membership.","example":"mem_example"},"required":true,"description":"ID of the membership.","name":"membershipId","in":"path"}],"responses":{"200":{"description":"membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/organizations":{"options":{"tags":["Organizations"],"description":"Returns allowed HTTP methods in headers","responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Organizations"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Organizations"],"description":"List organizations","responses":{"200":{"description":"List of organizations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Organizations"],"description":"Create a new organization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreate"}}}},"responses":{"200":{"description":"Created organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/organizations/slug/:slug":{"get":{"tags":["Organizations"],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^[a-z0-9-]+$","description":"Slug of the organization.","example":"example"},"required":true,"description":"Slug of the organization.","name":"slug","in":"path"}],"responses":{"200":{"description":"Get an organization by slug","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}}}}},"/v5/organizations/{organizationId}":{"options":{"tags":["Organizations"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Organizations"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"responses":{"200":{"description":"Organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Organizations"],"description":"Get a organization","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"responses":{"200":{"description":"Organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Organizations"],"description":"Replace a organization","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreate"}}}},"responses":{"200":{"description":"Organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Organizations"],"description":"Update a organization","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUpdate"}}}},"responses":{"200":{"description":"Organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Organizations"],"description":"Delete a organization","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"responses":{"200":{"description":"Organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/organizations/{organizationId}/restore":{"post":{"tags":["Organizations"],"description":"Restore a deleted organization","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"responses":{"200":{"description":"Organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/organizations/{organizationId}/clear":{"post":{"tags":["Organizations"],"description":"Clear a organization","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the organization.","example":"org_example"},"required":true,"description":"ID of the organization.","name":"organizationId","in":"path"}],"responses":{"200":{"description":"Queue event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueEvent"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/fine-tunings":{"options":{"tags":["Fine-tunings"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Fine-tunings"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Fine-tunings"],"description":"List fine-tunings","responses":{"200":{"description":"List of fine-tunings","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Fine-tunings"],"description":"Create a new fine-tuning","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningCreate"}}}},"responses":{"200":{"description":"Created fine-tuning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/fine-tunings/reset":{"post":{"tags":["Fine-tunings"],"description":"Reset default fine-tunings","responses":{"200":{"description":"Created fine-tunings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/fine-tunings/autocomplete-description":{"post":{"tags":["Fine-tunings"],"description":"Recommend a description for a fine-tuning","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningUpdate"}}}},"responses":{"200":{"description":"Recommended description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescriptionRecommendation"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/fine-tunings/preview-count":{"post":{"tags":["Fine-tunings"],"description":"Preview a fine-tuning","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningCreate"}}}},"responses":{"200":{"description":"Number of contacts that will be nurtured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}}}}}},"/v5/fine-tunings/{fineTuningId}":{"options":{"tags":["Fine-tunings"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the fine-tuning.","example":"fin_example"},"required":true,"description":"ID of the fine-tuning.","name":"fineTuningId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Fine-tunings"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the fine-tuning.","example":"fin_example"},"required":true,"description":"ID of the fine-tuning.","name":"fineTuningId","in":"path"}],"responses":{"200":{"description":"fineTuning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Fine-tunings"],"description":"Get a fine-tuning","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the fine-tuning.","example":"fin_example"},"required":true,"description":"ID of the fine-tuning.","name":"fineTuningId","in":"path"}],"responses":{"200":{"description":"fineTuning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Fine-tunings"],"description":"Replace a fine-tuning","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the fine-tuning.","example":"fin_example"},"required":true,"description":"ID of the fine-tuning.","name":"fineTuningId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningCreate"}}}},"responses":{"200":{"description":"fineTuning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Fine-tunings"],"description":"Update a fine-tuning","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the fine-tuning.","example":"fin_example"},"required":true,"description":"ID of the fine-tuning.","name":"fineTuningId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningUpdate"}}}},"responses":{"200":{"description":"fineTuning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Fine-tunings"],"description":"Delete a fine-tuning","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the fine-tuning.","example":"fin_example"},"required":true,"description":"ID of the fine-tuning.","name":"fineTuningId","in":"path"}],"responses":{"200":{"description":"fineTuning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/fine-tunings/{fineTuningId}/activity":{"post":{"tags":["Fine-tunings"],"description":"Create an activity for a fine-tuning","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the fine-tuning.","example":"fin_example"},"required":true,"description":"ID of the fine-tuning.","name":"fineTuningId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningActivityCreate"}}}},"responses":{"200":{"description":"fineTuning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningWithRelations"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/teams":{"options":{"tags":["Teams"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Teams"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Teams"],"description":"List teams","responses":{"200":{"description":"List of teams","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"post":{"tags":["Teams"],"description":"Create a new team","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamCreate"}}}},"responses":{"200":{"description":"Created team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/teams/{teamId}":{"options":{"tags":["Teams"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the team.","example":"tea_example"},"required":true,"description":"ID of the team.","name":"teamId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Teams"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the team.","example":"tea_example"},"required":true,"description":"ID of the team.","name":"teamId","in":"path"}],"responses":{"200":{"description":"team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Teams"],"description":"Get a team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the team.","example":"tea_example"},"required":true,"description":"ID of the team.","name":"teamId","in":"path"}],"responses":{"200":{"description":"team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"put":{"tags":["Teams"],"description":"Replace a team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the team.","example":"tea_example"},"required":true,"description":"ID of the team.","name":"teamId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamCreate"}}}},"responses":{"200":{"description":"team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"patch":{"tags":["Teams"],"description":"Update a team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the team.","example":"tea_example"},"required":true,"description":"ID of the team.","name":"teamId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamUpdate"}}}},"responses":{"200":{"description":"team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Teams"],"description":"Delete a team","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the team.","example":"tea_example"},"required":true,"description":"ID of the team.","name":"teamId","in":"path"}],"responses":{"200":{"description":"team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/usage":{"options":{"tags":["Usage"],"description":"Returns allowed HTTP methods in headers","responses":{"204":{"description":"No content"}}},"head":{"tags":["Usage"],"description":"Returns headers without body","responses":{"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Usage"],"description":"List usages","responses":{"200":{"description":"List of usages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Usage"}}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/usage/counts":{"get":{"tags":["Usage"],"description":"List usages","responses":{"200":{"description":"List of usages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageCounts"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}},"/v5/usage/{usageId}":{"options":{"tags":["Usage"],"description":"Returns allowed HTTP methods in headers","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the usage.","example":"usg_example"},"required":true,"description":"ID of the usage.","name":"usageId","in":"path"}],"responses":{"200":{"description":"Allowed HTTP methods in headers"}}},"head":{"tags":["Usage"],"description":"Returns headers without body","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the usage.","example":"usg_example"},"required":true,"description":"ID of the usage.","name":"usageId","in":"path"}],"responses":{"200":{"description":"usage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}}},"204":{"description":"No content"},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"get":{"tags":["Usage"],"description":"Get a usage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the usage.","example":"usg_example"},"required":true,"description":"ID of the usage.","name":"usageId","in":"path"}],"responses":{"200":{"description":"usage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}},"delete":{"tags":["Usage"],"description":"Delete an usage","parameters":[{"schema":{"type":"string","minLength":4,"description":"ID of the usage.","example":"usg_example"},"required":true,"description":"ID of the usage.","name":"usageId","in":"path"}],"responses":{"200":{"description":"usage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}}},"401":{"description":"Missing or invalid authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingScopesError"}}}},"403":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundError"}}}}}}}}}