{"openapi":"3.0.0","info":{"title":"Magileads API","description":"Welcome to Magileads API Documentation. All times are on GMT","version":"2.0.0"},"servers":[{"url":"https:\/\/app.api-magileads.net","description":"API"}],"paths":{"\/api":{"get":{"tags":["API"],"summary":"Api information","description":"Retrieve the api information","operationId":"API","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["api"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"api":{"$ref":"#\/components\/schemas\/ApiInfo"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}}}},"\/api\/{saas_domain}":{"get":{"tags":["API"],"summary":"Api information","description":"Retrieve the api information for a specified saas domain","operationId":"APISaas","parameters":[{"name":"saas_domain","in":"path","description":"URL of the SAAS","required":true,"allowEmptyValue":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["api"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"api":{"$ref":"#\/components\/schemas\/ApiInfo"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyDomainSaasException"}]}}}}}}},"\/api-keys":{"get":{"tags":["API Keys"],"summary":"Fetch list","description":"Retrieve the list of your API Keys","operationId":"APIKeysFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["api_keys_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"api_keys_list":{"description":"Displays the list of your API Keys","type":"array","items":{"$ref":"#\/components\/schemas\/APIKeyResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["API Keys"],"summary":"Generate an API Key (token)","description":"Generate an API Key (token)","operationId":"APIKeysGenerate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"API Key name","type":"string","example":"My API Key"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["api_key_id","name","token"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"api_key_id":{"description":"Display the API Key ID","type":"integer","example":1},"name":{"description":"Display the API Key name","type":"string","example":"My API Key"},"token":{"description":"Display the Token","type":"string","example":"abcdefghijklmnopqrstuvwxyz"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/api-keys\/{api_key_id}":{"get":{"tags":["API Keys"],"summary":"Find profile","description":"Retrieve the profile of a API Key","operationId":"APIKeyFindProfileById","parameters":[{"name":"api_key_id","in":"path","description":"ID of API Key to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["apikey_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"apikey_profile":{"$ref":"#\/components\/schemas\/APIKeyItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyApiKeyIdException"},{"$ref":"#\/components\/schemas\/ApiKeyDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["API Keys"],"summary":"Update profile","description":"Update a API Key profile","operationId":"APIKeysUpdateProfileById","parameters":[{"name":"api_key_id","in":"path","description":"ID of API Key to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/APIKeyUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyApiKeyIdException"},{"$ref":"#\/components\/schemas\/ApiKeyDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["API Keys"],"summary":"Delete an API Key","description":"Delete an API Key","operationId":"APIKeysDelete","parameters":[{"name":"api_key_id","in":"path","description":"ID of API Key to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/api-keys\/{api_key_id}\/regenerate":{"put":{"tags":["API Keys"],"summary":"Regenerate an API Key (token)","description":"Regenerate an API Key (token)","operationId":"APIKeysRegenerate","parameters":[{"name":"api_key_id","in":"path","description":"ID of API Key to regenerate","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/affiliation\/users":{"get":{"tags":["Affiliation"],"summary":"Fetch users list","description":"Retrieve the list of my affiliated users","operationId":"AffiliatesFetchUsersList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["users_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"users_list":{"description":"Displays the list of my affiliated users","type":"array","items":{"$ref":"#\/components\/schemas\/UserProfileAffiliate"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ai-agents":{"get":{"tags":["AiAgents"],"summary":"Fetch AI agents","description":"Retrieve the list of AI agents, including those shared to you","operationId":"AiAgentsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/AgentListResponse"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["AiAgents"],"summary":"Create AI agent","description":"Create a new AI agent. A name is required: either provide name directly, or provide first_name\/last_name so the name can be derived from them. The request is rejected if none are provided.","operationId":"AiAgentsCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AgentCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/AgentResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/AiAgents.InvalidActionTypeException"},{"$ref":"#\/components\/schemas\/AiAgents.InvalidAiAgentCloneIdentityException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ai-agents\/{uniqid}":{"get":{"tags":["AiAgents"],"summary":"Find AI agent by uniqid","description":"Retrieve an AI agent by uniqid","operationId":"AiAgentsFindByUniqid","parameters":[{"name":"uniqid","in":"path","required":true,"schema":{"type":"string","pattern":"[A-Za-z0-9_-]+"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/AgentResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyUniqIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["AiAgents"],"summary":"Update AI agent","description":"Update an AI agent","operationId":"AiAgentsUpdateByUniqid","parameters":[{"name":"uniqid","in":"path","required":true,"schema":{"type":"string","pattern":"[A-Za-z0-9_-]+"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AgentUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/AgentResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyUniqIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/AiAgents.InvalidActionTypeException"},{"$ref":"#\/components\/schemas\/AiAgents.InvalidAiAgentCloneIdentityException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["AiAgents"],"summary":"Delete AI agent","description":"Delete an AI agent","operationId":"AiAgentsDeleteByUniqid","parameters":[{"name":"uniqid","in":"path","required":true,"schema":{"type":"string","pattern":"[A-Za-z0-9_-]+"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyUniqIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ai-agents\/generate-brief":{"post":{"tags":["AiAgents"],"summary":"Generate AI agent brief without an existing agent","description":"Generate a brief from an activity description, a company website URL, or both, without creating or updating an AI agent. At least one source is required.","operationId":"AiAgentsGenerateBrief","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AgentGenerateBrief"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["brief"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"brief":{"$ref":"#\/components\/schemas\/AgentGenerateBriefResponse"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/AiAgents.InvalidAiAgentGeneratedBriefException"},{"$ref":"#\/components\/schemas\/AiAgents.MissingBriefGenerationSourceException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ai-agents\/{uniqid}\/generate-brief":{"post":{"tags":["AiAgents"],"summary":"Generate AI agent brief","description":"Generate a brief for an existing AI agent, using the provided sources or the activity description and website URL already stored on the agent. When generation succeeds, the generated brief values are applied to the agent according to the current update behavior.","operationId":"AiAgentsGenerateBriefByUniqid","parameters":[{"name":"uniqid","in":"path","required":true,"schema":{"type":"string","pattern":"[A-Za-z0-9_-]+"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AgentGenerateBrief"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["brief"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"brief":{"$ref":"#\/components\/schemas\/AgentGenerateBriefResponse"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyUniqIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/AiAgents.InvalidAiAgentGeneratedBriefException"},{"$ref":"#\/components\/schemas\/AiAgents.MissingBriefGenerationSourceException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists":{"get":{"tags":["Blacklists"],"summary":"Fetch list","description":"Retrieve the list of blacklists, including those shared to you","operationId":"BlacklistsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["blacklists_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"blacklists_list":{"description":"Displays the list of your blacklists","type":"array","items":{"$ref":"#\/components\/schemas\/BlacklistResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Blacklists"],"summary":"Create a blacklist","description":"Create a blacklist","operationId":"BlacklistsCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BlacklistCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["blacklist_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"blacklist_id":{"description":"Display the blacklist ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists\/{blacklist_id}":{"get":{"tags":["Blacklists"],"summary":"Find profile","description":"Retrieve the profile of a blacklist","operationId":"BlacklistsFindProfileById","parameters":[{"name":"blacklist_id","in":"path","description":"ID of blacklist to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["blacklist_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"blacklist_profile":{"$ref":"#\/components\/schemas\/BlacklistItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Blacklists"],"summary":"Update profile","description":"Update a blacklist profile","operationId":"BlacklistsUpdateProfileById","parameters":[{"name":"blacklist_id","in":"path","description":"ID of blacklist to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BlacklistUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Blacklists"],"summary":"Delete a blacklist","description":"Delete a blacklist","operationId":"BlacklistsDelete","parameters":[{"name":"blacklist_id","in":"path","description":"ID of blacklist to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/CannotDeleteAutomaticBlacklistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists\/{blacklist_id}\/data":{"get":{"tags":["Blacklists"],"summary":"Fetch data","description":"Retrieve the data of a blacklist.<br><br>Limitation : Limited to 100 results per page.<br>Allowed field_name for filter\/sort: id (data id), all data fields ids","operationId":"BlacklistsFetchData","parameters":[{"name":"blacklist_id","in":"path","description":"ID of blacklist to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"id"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)"},"results":{"description":"Displays the data of your blacklist","type":"array","items":{"$ref":"#\/components\/schemas\/BlacklistData"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Blacklists"],"summary":"Import data","description":"Import data into a blacklist.<br><br>\n        Limitation : Data import is limited to 100000 data per API call.","operationId":"BlacklistsImportData","parameters":[{"name":"blacklist_id","in":"path","description":"ID of the blacklist where to import the data","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"description":"Data to import","type":"array","items":{"$ref":"#\/components\/schemas\/BlacklistDataToImport"}},"ignore_errors":{"description":"Ignore data with errors instead of stopping the import","type":"boolean","default":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/ImportBlacklistDataResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyDataException"},{"$ref":"#\/components\/schemas\/ImportLimitExceededException"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists\/{blacklist_id}\/data\/{data_id}":{"delete":{"tags":["Blacklists"],"summary":"Delete Data","description":"Delete a data of a blacklist","operationId":"BlacklistsDeleteData","parameters":[{"name":"blacklist_id","in":"path","description":"ID of the blacklist where to delete the data","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"data_id","in":"path","description":"ID of data to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/QueryTooShortException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/EmptyDataIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists\/datas":{"delete":{"tags":["Blacklists"],"summary":"Delete Datas","description":"Delete multiple datas","operationId":"BlacklistsDeleteDatas","requestBody":{"content":{"application\/json":{"schema":{"required":["data_ids"],"properties":{"data_ids":{"description":"IDs of the datas to be deleted","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyBlacklistIdsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists\/data\/search":{"post":{"tags":["Blacklists"],"summary":"Search data in all blacklist","description":"Search data in all blacklist.<br><br>Limitation : Limited to 100 results per page.<br>Allowed field_name for filter\/sort: id (data id), all data fields ids","operationId":"BlacklistsSearchDataInAllBlacklist","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"id"}},"type":"object"}},"type":"object"}]}}}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["query"],"properties":{"query":{"description":"Value of your search","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)"},"results":{"description":"Displays the data of your blacklist","type":"array","items":{"$ref":"#\/components\/schemas\/BlacklistDataExtra"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/SearchIdNotExistingException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists\/{blacklist_id}\/data\/search":{"post":{"tags":["Blacklists"],"summary":"Search data in specific blacklist","description":"Search data in specific blacklist.<br><br>Limitation : Limited to 100 results per page.<br>Allowed field_name for filter\/sort: id (data id), all data fields ids","operationId":"BlacklistsSearchDataInSpecificBlacklist","parameters":[{"name":"blacklist_id","in":"path","description":"ID of blacklist to search","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"id"}},"type":"object"}},"type":"object"}]}}}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["query"],"properties":{"query":{"description":"Value of your search","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)"},"results":{"description":"Displays the data of your blacklist","type":"array","items":{"$ref":"#\/components\/schemas\/BlacklistData"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/QueryTooShortException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/SearchIdNotExistingException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/blacklists\/{blacklist_id}\/download\/{file_type}":{"get":{"tags":["Blacklists"],"summary":"Download the blacklist","description":"Download the blacklist data","operationId":"BlacklistsDownload","parameters":[{"name":"blacklist_id","in":"path","description":"ID of the blacklist to download","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"},{"$ref":"#\/components\/schemas\/BlacklistEmptyData"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Blacklists"],"summary":"Download the blacklist using a filter","description":"Download the blacklist data","operationId":"BlacklistsDownloadFilter","parameters":[{"name":"blacklist_id","in":"path","description":"ID of the blacklist to download","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Blacklists.DatasSelection"}}}},"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"},{"$ref":"#\/components\/schemas\/BlacklistEmptyData"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists":{"get":{"tags":["Contact Lists"],"summary":"Fetch all lists","description":"Retrieve the list of all contact lists, including those shared to you","operationId":"ContactListsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_lists"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_lists":{"description":"Displays the list of your contact lists","type":"array","items":{"$ref":"#\/components\/schemas\/ContactListResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Contact Lists"],"summary":"Create a contact list","description":"Create a contact list","operationId":"ContactListsCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Contact list name","type":"string","example":"My contact list"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1},"language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}":{"get":{"tags":["Contact Lists"],"summary":"Find profile","description":"Retrieve the profile of a contact list","operationId":"ContactListsFindProfileById","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_profile":{"$ref":"#\/components\/schemas\/ContactListItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Contact Lists"],"summary":"Update profile","description":"Update a contact list profile","operationId":"ContactListsUpdateProfileById","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Contact list name","type":"string","example":"My contact list","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true},"language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"pin":{"type":"boolean","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Contact Lists"],"summary":"Delete a contact list","description":"Delete a contact list","operationId":"ContactListsDelete","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists-paginated":{"get":{"tags":["Contact Lists"],"summary":"Fetch paginated list","description":"Fetch paginated contact lists.\n        <br>Default order: pin DESC, then id DESC.\n        <br>Allowed field_name for filter: id, name, folder_id. Allowed field_name for sort: id, name.\n        <br><br>Limited to 100 results per page.","operationId":"ContactListsFetchListPaginated","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"id"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 15 results per page)","example":15},"results":{"description":"Displays the list of your contact lists","type":"array","items":{"$ref":"#\/components\/schemas\/ContactListResultItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/names":{"get":{"tags":["Contact Lists"],"summary":"Fetch contact list IDs and names","description":"Retrieve the list of contact list IDs and names","operationId":"ContactListsFetchNames","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_lists"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_lists":{"description":"Displays the IDs and names of your contact lists","type":"array","items":{"$ref":"#\/components\/schemas\/ContactListNameResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts":{"get":{"tags":["Contact Lists"],"summary":"Fetch contacts","description":"Retrieve the contacts of a contact list<br>Allowed field_name for filter\/sort: id (contact id), all data fields ids, any_datafield (to search on all datafields, can't be used on sort),\n        created_on (contact creation date), bounced (use only does exist and does not exists, can't be used on sort)","operationId":"ContactListsFetchContacts","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"3"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResultsContacts"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 200 results per page)","example":100},"results":{"description":"Displays the contacts of your contact list","type":"array","items":{"$ref":"#\/components\/schemas\/Contact"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Contact Lists"],"summary":"Import contacts","description":"Import contacts into a contact list. If the contact email or linkedin url already exist on a contact,\n the existing one will be updated.<br><br>Limitation :The import of contacts is limited to 1000000 contacts per API call.","operationId":"ContactListsImportContacts","parameters":[{"name":"contact_list_id","in":"path","description":"ID of the contact list where to import contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"required":["contacts"],"properties":{"contacts":{"description":"Contacts to import in the form of a JSON file, containing an array of ContactImport objects","type":"string","format":"binary"},"ignore_errors":{"description":"Ignore data with errors instead of stopping the import","type":"boolean","default":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/ImportLimitExceededException"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/MultipleContactInfoAlreadyExistException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Contact Lists"],"summary":"Delete contacts from a contact list","description":"Delete contacts from a contact list","operationId":"ContactListsDeleteContactsFromContactList","parameters":[{"name":"contact_list_id","in":"path","description":"Contact list id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts\/blacklist\/{blacklist_id}":{"delete":{"tags":["Contact Lists"],"summary":"Delete contacts from a contact list found in a blacklist","description":"Delete contacts from a contact list found in a blacklist","operationId":"ContactListsDeleteContactsFromContactListFromBlacklist","parameters":[{"name":"contact_list_id","in":"path","description":"Contact list id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"blacklist_id","in":"path","description":"Blacklist id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts\/unsubscribers\/{organization_id}":{"delete":{"tags":["Contact Lists"],"summary":"Delete contacts from a contact list found in unsubscribers from an organization","description":"Delete contacts from a contact list found in unsubscribers from an organization","operationId":"ContactListsDeleteContactsFromContactListFromUnsubscribersOrganization","parameters":[{"name":"contact_list_id","in":"path","description":"Contact list id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"organization_id","in":"path","description":"Organization id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts\/unsubscribers":{"delete":{"tags":["Contact Lists"],"summary":"Delete contacts from a contact list found in unsubscribers","description":"Delete contacts from a contact list found in unsubscribers","operationId":"ContactListsDeleteContactsFromContactListFromUnsubscribers","parameters":[{"name":"contact_list_id","in":"path","description":"Contact list id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts\/{contact_id}":{"get":{"tags":["Contact Lists"],"summary":"Find contact profile","description":"Retrieve a contact profile","operationId":"FindContactProfileById","parameters":[{"name":"contact_list_id","in":"path","description":"ID of the contact list where to contact profile to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of contact profile to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_profile":{"$ref":"#\/components\/schemas\/Contact"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListEmptyContactIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Contact Lists"],"summary":"Update contact","description":"Update a contact of a contact list. Set the value of a property to an empty string to remove the property. Removing all properties will remove the contact.","operationId":"ContactListsUpdateContact","parameters":[{"name":"contact_list_id","in":"path","description":"ID of the contact list where to update contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of contact to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["properties"],"properties":{"properties":{"description":"Properties to update","type":"array","items":{"$ref":"#\/components\/schemas\/ContactProperty"}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/ImportContactsResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListEmptyContactIdException"},{"$ref":"#\/components\/schemas\/EmptyPropertiesException"},{"$ref":"#\/components\/schemas\/ContactInfoAlreadyExistException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/CantDeleteAllFields"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Contact Lists"],"summary":"Delete Contact","description":"Delete a contact of a contact list","operationId":"ContactListsDeleteContact","parameters":[{"name":"contact_list_id","in":"path","description":"ID of the contact list where to delete contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of contact to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListEmptyContactIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/contacts\/search":{"post":{"tags":["Contact Lists"],"summary":"Search contacts in all contact list","description":"Search contacts in all contact list<br>Allowed field_name for filter\/sort: id (contact id), all data fields ids, any_datafield (to search on all datafields, can't be used on sort),\n        created_on (contact creation date), bounced (use only does exist and does not exists, can't be used on sort), contact_list_id (can't be used on sort)","operationId":"ContactListsSearchContactsInAllContactList","requestBody":{"content":{"application\/json":{"schema":{"required":["options"],"properties":{"options":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"3"}},"type":"object"}},"type":"object"}]}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 200 results per page)","example":100},"results":{"description":"Displays the contacts of your contact list","type":"array","items":{"$ref":"#\/components\/schemas\/ContactExtra"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/SearchIdNotExistingException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/download\/{file_type}":{"post":{"tags":["Contact Lists"],"summary":"Download the list of contacts from all contacts lists","description":"Download the list of contacts from all contacts lists","operationId":"ContactListsDownloadFromAllFilter","parameters":[{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/contacts\/copy\/{contact_list_id_destination}":{"post":{"tags":["Contact Lists"],"summary":"Copy contacts from all contact lists to a contact list","description":"Copy contacts from all contact lists to a contact list","operationId":"ContactListsCopyFromAll","parameters":[{"name":"contact_list_id_destination","in":"path","description":"ID of destination contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["contacts_selection"],"properties":{"contacts_selection":{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts\/search":{"post":{"tags":["Contact Lists"],"summary":"Search contacts in specific contact list","description":"Search contacts in specific contact list<br>Allowed field_name for filter\/sort: id (contact id), all data fields ids, any_datafield (to search on all datafields, can't be used on sort),\n        created_on (contact creation date), bounced (use only does exist and does not exists, can't be used on sort)","operationId":"ContactListsSearchContactsInSpecificContactList","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to search","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"3"}},"type":"object"}},"type":"object"}]}}}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["query"],"properties":{"query":{"description":"Value of your search","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 200 results per page)","example":100},"results":{"description":"Displays the contacts of your contact list","type":"array","items":{"$ref":"#\/components\/schemas\/Contact"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/QueryTooShortException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/SearchIdNotExistingException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/copy":{"post":{"tags":["Contact Lists"],"summary":"Copy a contact list","description":"Copy a contact list","operationId":"ContactListsCopy","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true},"contact_list_id_destination":{"description":"Destination contact list id. Put null to create a new contact list","type":"integer","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/copy\/to\/{user_id}":{"post":{"tags":["Contact Lists"],"summary":"Copy a contact list to user ID","description":"Copy a contact list to user ID","operationId":"ContactListsCopyTo","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of the user to copy the contact list to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/copy\/blacklist\/{blacklist_id}":{"post":{"tags":["Contact Lists"],"summary":"Copy a contact list to a blacklist","description":"Copy a contact list to a blacklist","operationId":"ContactListsCopyToBlacklist","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"blacklist_id","in":"path","description":"ID of the blacklist to copy the contact list to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true},"datafield_ids":{"type":"array","items":{"type":"integer"},"nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/copy\/unsubscribers":{"post":{"tags":["Contact Lists"],"summary":"Copy a contact list to unsubscribers","description":"Copy a contact list to unsubscribers","operationId":"ContactListsCopyToUnsubscribers","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true},"datafield_ids":{"type":"array","items":{"type":"integer"},"nullable":false},"organization_id":{"type":"integer","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/split":{"post":{"tags":["Contact Lists"],"summary":"Split a contact list","description":"Split a contact list","operationId":"ContactListsSplit","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to split","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["number_lists"],"properties":{"number_lists":{"description":"How many lists would you like to split your list into (maximum 100)?","type":"integer","example":3}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_lists"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_lists":{"description":"Displays the list of your new contact lists","type":"array","items":{"$ref":"#\/components\/schemas\/ContactListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNumberListsException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/NumberListExceededException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/download\/{file_type}":{"get":{"tags":["Contact Lists"],"summary":"Download the list of contacts","description":"Download the list of contacts in CSV format","operationId":"ContactListsDownload","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to download","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Contact Lists"],"summary":"Download the list of contacts using a filter","description":"Download the list of contacts in CSV format","operationId":"ContactListsDownloadFilter","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to download","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/contacts":{"delete":{"tags":["Contact Lists"],"summary":"Delete Contacts","description":"Delete contacts","operationId":"ContactListsDeleteContacts","requestBody":{"content":{"application\/json":{"schema":{"required":["contact_ids"],"properties":{"contact_ids":{"description":"IDs of the contacts to be deleted","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactIdsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/contacts\/selection":{"delete":{"tags":["Contact Lists"],"summary":"Delete Contacts from a selection","description":"Delete contacts from a selection","operationId":"ContactListsDeleteContactsSelection","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/contacts\/copy\/prm":{"post":{"tags":["Contact Lists"],"summary":"Copy contacts to my prm","description":"Copy contacts to my prm","operationId":"ContactListsCopyContactsToMyPrm","requestBody":{"content":{"application\/json":{"schema":{"required":["contact_ids","status"],"properties":{"contact_ids":{"description":"IDs of the contacts to be copied","type":"array","items":{"type":"integer","example":1}},"status":{"$ref":"#\/components\/schemas\/PRMContactStatus"},"custom_status":{"type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/PRMImportContactsResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactIdsException"},{"$ref":"#\/components\/schemas\/PRMIncorrectStatus"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/contacts\/copy\/to\/{contact_list_id_destination}":{"post":{"tags":["Contact Lists"],"summary":"Copy contacts from one list to another","description":"Copy contacts from one list to another","operationId":"ContactListsCopyContactsTo","parameters":[{"name":"contact_list_id_destination","in":"path","description":"ID of the destination contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["contact_ids"],"properties":{"contact_ids":{"description":"IDs of the contacts to copy","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/CopyContactsResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdDestinationException"},{"$ref":"#\/components\/schemas\/DestinationContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyContactIdsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedDestinationContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DestinationContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/merge":{"post":{"tags":["Contact Lists"],"summary":"Merge contact lists","description":"Merge contact lists","operationId":"ContactListsMerge","requestBody":{"content":{"application\/json":{"schema":{"required":["name","contact_list_ids"],"properties":{"name":{"description":"Contact list name","type":"string","example":"My contact list"},"contact_list_ids":{"description":"Contact lists ids","type":"array","items":{"type":"integer","example":1}},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1},"language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ContactList.EmptyContactListIdsException"},{"$ref":"#\/components\/schemas\/InvalidContactListIdException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/copy\/prm":{"post":{"tags":["Contact Lists"],"summary":"Copy contact list to my prm","description":"Copy contact list to my prm","operationId":"ContactListsCopyContactListToMyPrm","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["status"],"properties":{"status":{"$ref":"#\/components\/schemas\/PRMContactStatus"},"custom_status":{"type":"integer"},"contacts_selection":{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/PRMIncorrectStatus"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedCopyingToPrmException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/enrich":{"post":{"tags":["Contact Lists"],"summary":"Enrich a contact list","description":"Enrich a contact list","operationId":"ContactListsEnrich","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be enrich","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"required":["generate_email"],"properties":{"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false}},"type":"object"},{"allOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"},{"required":["generate_email"],"properties":{"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false}},"type":"object"}]}]}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/MaxEmailsGeneratedPerMonthReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/enrich\/external\/{enrich_external_api}\/{external_api_key_id}":{"post":{"tags":["Contact Lists"],"summary":"Enrich a contact list using an external api","description":"Enrich a contact list using an external api. Available enrichments :\n- Kaspr : Using contact LinkedIn url and name, get a phone number\n- Dropcontact : Using contact name and company, or LinkedIn url, get an email address and phone number\n- ContactOut : Using contact LinkedIn url, get an email address","operationId":"ContactListsEnrichExternalApi","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be enrich","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"enrich_external_api","in":"path","description":"Type of enrichment","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/contactlists.enrichexternalapi"}},{"name":"external_api_key_id","in":"path","description":"ID of external api key","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"filter":{"$ref":"#\/components\/schemas\/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/InvalidApiKeyException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/email-verifier":{"post":{"tags":["Contact Lists"],"summary":"Verify emails in a contact list","description":"Verify emails in a contact list","operationId":"ContactListsEmailVerifier","parameters":[{"name":"contact_list_id","in":"path","description":"ID of the contact list to be verified","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailVerifierException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/convert\/linkedin\/links":{"post":{"tags":["Contact Lists"],"summary":"Convert LinkedIn AC links to IN","description":"Convert LinkedIn AC links to IN","operationId":"ContactListsConvertLinkedin","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be convert LinkedIn AC links to IN","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_account_id"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/icebreaker":{"post":{"tags":["Contact Lists"],"summary":"Generate an Ice Breaker of list contacts","description":"Generate an Ice Breaker of list contacts","operationId":"ContactListsIceBreaker","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to generate Ice Breaker","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"subject":{"description":"Subject to be used to generate the Ice Breaker","type":"string"},"language":{"description":"Ice Breaker language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"version":{"description":"Generator version (3.5 or 4.0)","type":"string","example":"3.5"},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectVersionException"},{"$ref":"#\/components\/schemas\/EmptyIceBreakerSubjectException"},{"$ref":"#\/components\/schemas\/InvalidModelTypeException"},{"$ref":"#\/components\/schemas\/UnauthorizedGenerateIceBreakerException"},{"$ref":"#\/components\/schemas\/UnauthorizedIceBreakerVersionException"},{"$ref":"#\/components\/schemas\/MaxIceBreakerPerMonthReachedException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/translate":{"post":{"tags":["Contact Lists"],"summary":"Translate a contact list","description":"Translate a contact list","operationId":"ContactListsTranslate","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be translate","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["language"],"properties":{"language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/delete\/company\/{keep_contacts}":{"delete":{"tags":["Contact Lists"],"summary":"Delete contacts on a contact list to keep only a certain amount of contacts by company","description":"Delete contacts on a contact list to keep only a certain amount of contacts by company","operationId":"ContactListsDeleteContactsByCompanyByCount","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"keep_contacts","in":"path","description":"Number of contacts to keep by company","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["number_deleted"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"number_deleted":{"type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/datafield-ai\/{datafield_id}":{"post":{"tags":["Contact Lists"],"summary":"Generate dynamic content using AI from a contact list datafield","description":"Generate dynamic content using AI from a contact list datafield","operationId":"ContactListsDatafieldAI","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"datafield_id","in":"path","description":"ID of datafield (this can only be used on manually created datafields)","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["prompt","language"],"properties":{"prompt":{"description":"Prompt to generate datafield content using AI. You need to use one or more datafield variables to optimize your prompt.","type":"string","example":"The contact's function is \"%job_title%\", can you tell me which function group it belongs to: marketing, communication or sales?"},"language":{"description":"Datafield content language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0},"external_api_key_id":{"description":"Your external API key ID (type OpenAi only)","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/EmptyDatafieldAiPromptException"},{"$ref":"#\/components\/schemas\/EmptyDatafieldInPromptException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"},{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/MissingDatafieldValuesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedDataFieldException"},{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/UnauthorizedGenerateDatafieldAiException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"},{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/datafield-enrich\/{datafield_id}":{"post":{"tags":["Contact Lists"],"summary":"Filling the datafield with AI","description":"Filling the datafield with AI","operationId":"ContactListsDatafieldEnrich","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"datafield_id","in":"path","description":"ID of datafield (Can only be used on the following datafields: Activity \/ Company size \/ Email \/ Phone \/ Website).\n                <br>Note: \"Email\" and \"Phone\" can only be used if the necessary permissions are granted.","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["language"],"properties":{"language":{"description":"Datafield content language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"},{"$ref":"#\/components\/schemas\/MaxDatafieldAiPerMonthReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedDataFieldException"},{"$ref":"#\/components\/schemas\/UnauthorizedGenerateDatafieldAiException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/enrich\/linkedin\/url":{"post":{"tags":["Contact Lists"],"summary":"Enrich LinkedIn URLs","description":"Enrich LinkedIn URLs of the contact list","operationId":"ContactListsEnrichLinkedInURL","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be enriched","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/enrich\/phone\/mobile":{"post":{"tags":["Contact Lists"],"summary":"Enrich the phone number of multiple contacts","description":"Enrich the phone number of multiple contacts","operationId":"ContactListsEnrichMobilePhoneSelection","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be enriched","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"},{"$ref":"#\/components\/schemas\/MaxMobilePhonesGeneratedPerMonthReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts\/{contact_id}\/enrich\/phone\/mobile":{"post":{"tags":["Contact Lists"],"summary":"Enrich a contact phone number","description":"Enrich a contact phone number","operationId":"ContactListsEnrichMobilePhone","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be enriched","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"Contact ID to enrich","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"mobile_phone":{"description":"Displays mobile phone number if found","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/MaxMobilePhonesGeneratedPerMonthReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contact":{"post":{"tags":["Contact Lists"],"summary":"Import contact","description":"Import a contact of a contact list.","operationId":"ContactListsImportContact","parameters":[{"name":"contact_list_id","in":"path","description":"ID of the contact list where to import contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["properties"],"properties":{"properties":{"description":"Properties to import","type":"array","items":{"$ref":"#\/components\/schemas\/ContactProperty"}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/ImportContactsResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/EmptyPropertiesException"},{"$ref":"#\/components\/schemas\/ContactInfoAlreadyExistException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/CantDeleteAllFields"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/enrich\/linkedin":{"post":{"tags":["Contact Lists"],"summary":"Enrich a contact list with LinkedIn data","description":"Enrich a contact list by retrieving information from contacts with a LinkedIn link","operationId":"ContactListsEnrichLinkedIn","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list to be enriched","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_account_id"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/NoLinkedInContactsException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/datafields\/{datafield_id}\/values":{"get":{"tags":["Contact Lists"],"summary":"Get unique values from a datafield","description":"List unique values for a specific datafield in a contact list","operationId":"ContactListsDatafieldUniqueValues","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"datafield_id","in":"path","description":"ID of datafield to extract unique values from (Can only be used on the following datafields: Activity \/ Company size \/ Naf Code \/ Legal Nature \/ Legal Form)","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"results":{"type":"array","items":{"type":"string"},"nullable":true}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedDataFieldException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contacts\/enrich\/phone\/mobile":{"post":{"tags":["Contact Lists"],"summary":"Enrich a contact mobile phone from LinkedIn URL","description":"Enrich a mobile phone number using a LinkedIn URL","operationId":"ContactsEnrichMobilePhoneByLinkedinUrl","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["linkedin_url"],"properties":{"linkedin_url":{"description":"Public LinkedIn profile URL","type":"string","format":"uri"},"company":{"description":"Company name if known","type":"string","nullable":true},"full_name":{"description":"Full name if known","type":"string","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"mobile_phone":{"description":"Displays mobile phone number if found","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/MaxMobilePhonesGeneratedPerMonthReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contacts\/enrich\/email":{"post":{"tags":["Contact Lists"],"summary":"Enrich a contact email from company and optional names","description":"Enrich an email address using company and name information","operationId":"ContactsEnrichEmailByCompany","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["company"],"properties":{"company":{"description":"Company name","type":"string"},"last_name":{"description":"Last name if known","type":"string","nullable":true},"first_name":{"description":"First name if known","type":"string","nullable":true},"full_name":{"description":"Full name if known","type":"string","nullable":true},"company_linkedin_url":{"description":"LinkedIn Company Slug URL","type":"string","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email":{"description":"Displays email if found","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/MaxEmailsGeneratedPerMonthReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/datafields\/{datafield_id}\/bulk-set":{"put":{"tags":["Contact Lists"],"summary":"Bulk set datafield value","description":"Set the same value for a datafield across contacts of a list.","operationId":"ContactListsBulkSetDatafield","parameters":[{"name":"contact_list_id","in":"path","description":"ID of contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"datafield_id","in":"path","description":"Target datafield id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["value"],"properties":{"value":{"description":"Value to set","type":"string","nullable":false},"overwrite":{"description":"Whether to overwrite existing values. Default is false","type":"boolean","nullable":false,"default":false},"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/ImportContactsResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/DataValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/contact-lists\/{contact_list_id}\/contacts\/contact-list\/{source_contact_list_id}":{"delete":{"tags":["Contact Lists"],"summary":"Delete contacts from a contact list found in another contact list","description":"Delete contacts from a contact list found in another contact list","operationId":"ContactListsDeleteContactsFromContactListFromContactList","parameters":[{"name":"contact_list_id","in":"path","description":"Contact list id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"source_contact_list_id","in":"path","description":"Source contact list id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/crons":{"get":{"tags":["Crons"],"summary":"Fetch list","description":"Retrieve the list of crons","operationId":"CronsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["crons_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"crons_list":{"description":"Displays the list of your crons","type":"array","items":{"$ref":"#\/components\/schemas\/CronResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Crons"],"summary":"Create a cron","description":"Create a cron","operationId":"CronsCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name","arguments","frequency"],"properties":{"name":{"description":"Name of the cron","type":"string"},"frequency":{"$ref":"#\/components\/schemas\/crons.frequency"},"arguments":{"$ref":"#\/components\/schemas\/cron_arguments"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["cron_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"cron_id":{"description":"Display the cron ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidFrequencyException"},{"$ref":"#\/components\/schemas\/crons_invalid_type"},{"$ref":"#\/components\/schemas\/EmptyCronNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/crons\/{cron_id}":{"get":{"tags":["Crons"],"summary":"Find profile","description":"Retrieve the profile of a cron","operationId":"CronsFindProfileById","parameters":[{"name":"cron_id","in":"path","description":"ID of cron to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["cron_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"cron_profile":{"$ref":"#\/components\/schemas\/CronItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyCronIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedCronException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/CronDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Crons"],"summary":"Update a cron profile","description":"Update a cron profile. You cannot change the cron type","operationId":"CronsUpdateProfileById","parameters":[{"name":"cron_id","in":"path","description":"ID of cron to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Name of the cron","type":"string","nullable":true},"frequency":{"oneOf":[{"$ref":"#\/components\/schemas\/crons.frequency"}],"nullable":true},"arguments":{"$ref":"#\/components\/schemas\/cron_arguments"},"enabled":{"type":"boolean","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidFrequencyException"},{"$ref":"#\/components\/schemas\/crons_invalid_type"},{"$ref":"#\/components\/schemas\/cannot_change_cron_type"},{"$ref":"#\/components\/schemas\/EmptyCronNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedCronException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Crons"],"summary":"Delete a cron","description":"Delete a cron","operationId":"CronsDelete","parameters":[{"name":"cron_id","in":"path","description":"ID of cron to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyCronIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedCronException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/CronDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/crons\/{cron_id}\/execute":{"post":{"tags":["Crons"],"summary":"Manually execute a cron","description":"Manually execute a cron. You can optionnaly provide an arguments option to change the parameters for this execution","operationId":"CronsExecute","parameters":[{"name":"cron_id","in":"path","description":"ID of cron to execute","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"arguments":{"$ref":"#\/components\/schemas\/cron_arguments"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyCronIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedCronException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/CronDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/crons\/{cron_id}\/test":{"post":{"tags":["Crons"],"summary":"Test a cron with dummy data","description":"Test a cron with dummy data. Only prm_synchronise_with_make is supported","operationId":"CronsTest","parameters":[{"name":"cron_id","in":"path","description":"ID of cron to test","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyCronIdException"},{"$ref":"#\/components\/schemas\/ThisCronDoesNotSupportTestException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedCronException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/CronDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/data-fields":{"get":{"tags":["Data Fields"],"summary":"Fetch list","description":"Retrieve the list of data fields, including those shared to you","operationId":"DataFieldsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["data_fields_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"data_fields_list":{"description":"Displays the list of your data fields","type":"array","items":{"$ref":"#\/components\/schemas\/DataFieldResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Data Fields"],"summary":"Create a data field","description":"Create a data field","operationId":"DataFieldsCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Data field name","type":"string","example":"My data field"},"identifier":{"description":"Data field identifier to be used on template using %. If not provided or null, the name will be used.","type":"string","example":"my_data_field"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"possible_values":{"description":"The list of possible values if you want to limit them. Maximum 50 values of length 1000 each","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["data_field_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"data_field_id":{"description":"Display the data field ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidIdentifierException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/data-fields\/{data_field_id}":{"get":{"tags":["Data Fields"],"summary":"Find profile","description":"Retrieve the profile of a data field","operationId":"DataFieldsFindProfileById","parameters":[{"name":"data_field_id","in":"path","description":"ID of data field to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["data_field_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"data_field_profile":{"$ref":"#\/components\/schemas\/DataFieldItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyDataFieldIdException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedDataFieldException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Data Fields"],"summary":"Update profile","description":"Update a data field profile","operationId":"DataFieldsUpdateProfileById","parameters":[{"name":"data_field_id","in":"path","description":"ID of data field to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Data field name","type":"string","example":"My data field","nullable":true},"identifier":{"description":"Data field identifier to be used on template using %","type":"string","example":"my_data_field","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"possible_values":{"description":"The list of possible values if you want to limit them. Maximum 50 values of length 1000 each","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyDataFieldIdException"},{"$ref":"#\/components\/schemas\/InvalidIdentifierException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedDataFieldException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Data Fields"],"summary":"Delete a data field","description":"Delete a data field","operationId":"DataFieldsDelete","parameters":[{"name":"data_field_id","in":"path","description":"ID of data field to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyDataFieldIdException"},{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedDataFieldException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/email-signatures":{"get":{"tags":["Email Signatures"],"summary":"Fetch list","description":"Retrieve the list of email signatures, including those shared to you","operationId":"EmailSignaturesFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_signatures_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_signatures_list":{"description":"Displays the list of your email signatures","type":"array","items":{"$ref":"#\/components\/schemas\/EmailSignatureResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Email Signatures"],"summary":"Create an email signature","description":"Create an email signature","operationId":"EmailSignaturesCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Email signature name","type":"string","example":"My email signature"},"html":{"description":"HTML version of the email signature (Required, if the TEXT version is not filled in)","type":"string","example":"<strong>Hello world<\/strong>"},"text":{"description":"TEXT version of the email signature (Required, if the HTML version is not filled in)","type":"string","example":"Hello world"},"json_template":{"description":"If you use a template editor, you can save its JSON configuration here","type":"string","example":"[]"},"is_template":{"description":"Is designed on the template editor ?","type":"boolean","example":false,"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_signature_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_signature_id":{"description":"Display the email signature ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyHtmlTextException"},{"$ref":"#\/components\/schemas\/EmailSignatures.InvalidJsonTemplateException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/email-signatures\/{email_signature_id}":{"get":{"tags":["Email Signatures"],"summary":"Find profile","description":"Retrieve the profile of an email signature","operationId":"EmailSignaturesFindProfileById","parameters":[{"name":"email_signature_id","in":"path","description":"ID of email signature to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_signature_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_signature_profile":{"$ref":"#\/components\/schemas\/EmailSignatureItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyEmailSignatureIdException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Email Signatures"],"summary":"Update profile","description":"Update an email signature profile","operationId":"EmailSignaturesUpdateProfileById","parameters":[{"name":"email_signature_id","in":"path","description":"ID of email signature to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Email signature name","type":"string","example":"My email signature"},"html":{"description":"HTML version of the email signature","type":"string","example":"<strong>Hello world<\/strong>"},"text":{"description":"TEXT version of the email signature","type":"string","example":"Hello world"},"json_template":{"description":"If you use a template editor, you can save its JSON configuration here","type":"string","example":"[]"},"is_template":{"description":"Is designed on the template editor ?","type":"boolean","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"pin":{"type":"boolean","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyHtmlTextException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmailSignatures.InvalidJsonTemplateException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Email Signatures"],"summary":"Delete an email signature","description":"Delete an email signature","operationId":"EmailSignaturesDelete","parameters":[{"name":"email_signature_id","in":"path","description":"ID of email signature to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyEmailSignatureIdException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/email-signatures\/{email_signature_id}\/copy":{"post":{"tags":["Email Signatures"],"summary":"Copy an email signature","description":"Copy an email signature","operationId":"EmailSignaturesCopy","parameters":[{"name":"email_signature_id","in":"path","description":"ID of email signature to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_signature_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_signature_id":{"description":"Display the email signature ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyEmailSignatureIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/enrich":{"post":{"tags":["Enrich"],"summary":"Create an enrich batch","operationId":"EnrichBatchCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EnrichBatchCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["batch_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"batch_id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EnrichBatchTooManyContactsException"},{"$ref":"#\/components\/schemas\/EnrichBatchEmptyContactsException"},{"$ref":"#\/components\/schemas\/MaxEmailsGeneratedPerMonthReachedException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/enrich\/{batch_id}":{"get":{"tags":["Enrich"],"summary":"Get enrich batch results","operationId":"EnrichBatchGet","parameters":[{"name":"batch_id","in":"path","description":"Batch UUID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["batch_id","job_status","percent","errors","contacts"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"batch_id":{"type":"string","format":"uuid"},"job_status":{"type":"string","example":"Completed"},"percent":{"type":"number","format":"float","example":42.5},"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/EnrichBatchPublicError"}},"contacts":{"type":"array","items":{"required":["id","status","enrichment_status","input_data","output_data","errors"],"properties":{"id":{"type":"integer"},"status":{"type":"string","enum":["pending","done","error"]},"enrichment_status":{"type":"string","enum":["pending","enriched","not_enriched","error"]},"input_data":[],"output_data":{"nullable":true},"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/EnrichBatchPublicError"}}},"type":"object"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EnrichBatchNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/enrich\/usage":{"post":{"tags":["Enrich"],"summary":"Get enrich usage statistics","operationId":"EnrichUsage","requestBody":{"content":{"application\/json":{"schema":{"required":["date_range"],"properties":{"date_range":{"$ref":"#\/components\/schemas\/statistics.date_range"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/AdminUsageStatistics"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPermissionException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/external-api-keys":{"get":{"tags":["External API keys"],"summary":"Fetch list","description":"Retrieve your list of external API keys","operationId":"ExternalApiKeysFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["external_api_keys_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"external_api_keys_list":{"description":"Displays a list of your external API keys","type":"array","items":{"$ref":"#\/components\/schemas\/ExternalApiKeyResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["External API keys"],"summary":"Add profile","description":"Add an external API key","operationId":"ExternalApiKeysAdd","requestBody":{"content":{"application\/json":{"schema":{"required":["name","api_key","type"],"properties":{"name":{"description":"Name of your external API key","type":"string","example":"My external API Key"},"api_key":{"description":"Your external API\/Application key","type":"string","example":"abcdefghijklmnopqrstuvwxyz"},"api_secret":{"description":"Your external Application secret","type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"consumer_key":{"description":"Your external Consumer key","type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"type":{"$ref":"#\/components\/schemas\/externalapikeys.type"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"id":{"description":"Your external API key ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyExternalApiKeyNameException"},{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/external_api_keys.invalid_type_key"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/external-api-keys\/{external_api_key_id}":{"get":{"tags":["External API keys"],"summary":"Find profile","description":"Retrieve an external API key profile","operationId":"ExternalApiKeyFindProfileById","parameters":[{"name":"external_api_key_id","in":"path","description":"ID of the external API key to retrieve","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["external_api_key_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"external_api_key_profile":{"$ref":"#\/components\/schemas\/ExternalApiKeyItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyExternalAPiKeyIdException"},{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["External API keys"],"summary":"Update profile","description":"Update external API key profile","operationId":"ExternalApiKeysUpdateProfileById","parameters":[{"name":"external_api_key_id","in":"path","description":"ID of the external API key to be updated","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ExternalApiKeyUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyExternalAPiKeyIdException"},{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyExternalApiKeyNameException"},{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["External API keys"],"summary":"Delete profile","description":"Delete an external API key","operationId":"ExternalApiKeysDelete","parameters":[{"name":"external_api_key_id","in":"path","description":"ID of the external API key to be deleted","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/files":{"get":{"tags":["Files"],"summary":"Fetch list","description":"Retrieve the list of files, including those shared to you","operationId":"FilesFetchList","parameters":[{"name":"only_shared_with_reseller_customers","in":"query","description":"If true, only items shared with reseller customers will be shown, if null all items are returned","required":false,"schema":{"type":"boolean","nullable":true,"default":null}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["files_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"files_list":{"description":"Displays the list of your Files","type":"array","items":{"$ref":"#\/components\/schemas\/FileResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Files"],"summary":"Upload a file","description":"Upload a file. Maximum 50MB","operationId":"FilesUpload","requestBody":{"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"name":{"description":"If you want to give a specific name to the file (without the extension).","type":"string","example":"My file"},"file":{"description":"The file to upload. Authorized file format : JPG \/ JPEG \/ PNG \/ GIF \/ PDF \/ POT \/ POTX \/ PPT \/ PPTX \/ XLS \/ XLSX \/ DOC \/ DOCX \/ MP3 \/ WAV","type":"string","format":"binary"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"folder_id":{"description":"Folder id","type":"integer","example":1}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/FileCreated"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyFileException"},{"$ref":"#\/components\/schemas\/FileSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedFileFormatException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/files\/{file_id}":{"get":{"tags":["Files"],"summary":"Find profile","description":"Retrieve the profile of a file","operationId":"FilesFindProfileById","parameters":[{"name":"file_id","in":"path","description":"ID of file to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["file_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"file_profile":{"$ref":"#\/components\/schemas\/FileItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyFileIdException"},{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Files"],"summary":"Update profile","description":"Update a file profile","operationId":"FilesUpdateProfileById","parameters":[{"name":"file_id","in":"path","description":"ID of file to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"properties":{"name":{"description":"If you want to give a specific name to the file (without the extension).","type":"string","example":"My file","nullable":true},"file":{"description":"The file to upload. Authorized file format : JPG \/ JPEG \/ PNG \/ GIF \/ PDF \/ POT \/ POTX \/ PPT \/ PPTX \/ XLS \/ XLSX \/ DOC \/ DOCX","type":"string","format":"binary","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/FileSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedFileFormatException"},{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFileException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Files"],"summary":"Delete a file","description":"Delete a file","operationId":"FilesDelete","parameters":[{"name":"file_id","in":"path","description":"ID of file to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyFileIdException"},{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/files\/search":{"post":{"tags":["Files"],"summary":"Search files","description":"Search files<br>Allowed field_name for filter\/sort: name","operationId":"FilesSearch","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"name"}},"type":"object"}},"type":"object"}]}}}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["query"],"properties":{"query":{"description":"Value of your search","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)"},"results":{"description":"Displays the list of your files","type":"array","items":{"$ref":"#\/components\/schemas\/FileSearchItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/QueryTooShortException"},{"$ref":"#\/components\/schemas\/SearchIdNotExistingException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/folders":{"get":{"tags":["Folders"],"summary":"Fetch list","description":"Retrieve the list of folders","operationId":"FoldersFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["folders"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"folders":{"description":"Displays the list of your folders","type":"array","items":{"$ref":"#\/components\/schemas\/FolderResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Folders"],"summary":"Create a folder","description":"Create a folder","operationId":"FoldersCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name","type"],"properties":{"name":{"description":"Folder name","type":"string","example":"My folder"},"type":{"$ref":"#\/components\/schemas\/FolderType"},"parent_id":{"type":"integer","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"folder_id":{"description":"Display folder ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/folders\/{folder_id}":{"get":{"tags":["Folders"],"summary":"Find profile","description":"Retrieve the profile of a folder","operationId":"FoldersFindProfileById","parameters":[{"name":"folder_id","in":"path","description":"ID of folder to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["folder_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"folder_profile":{"$ref":"#\/components\/schemas\/FolderProfile"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyFolderIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Folders"],"summary":"Update profile","description":"Update a folder profile","operationId":"FoldersUpdateProfileById","parameters":[{"name":"folder_id","in":"path","description":"ID of folder to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Folder name","type":"string","example":"My folder","nullable":true},"parent_id":{"description":"Put 0 to remove parent","type":"integer","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyFolderIdException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Folders"],"summary":"Delete a folder","description":"Delete a folder","operationId":"FoldersDelete","parameters":[{"name":"folder_id","in":"path","description":"ID of folder to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyFolderIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/forms":{"get":{"tags":["Forms"],"summary":"Fetch list","description":"Retrieve the list of forms","operationId":"FormsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["forms_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"forms_list":{"description":"Displays the list of your forms","type":"array","items":{"$ref":"#\/components\/schemas\/FormResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Forms"],"summary":"Create a form","description":"Create a form","operationId":"FormsCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Name of the form","type":"string"},"domain":{"description":"Form access domain. Underscores not allowed","type":"string","example":"http:\/\/form.example.org","nullable":true},"html":{"description":"Form in HTML format","type":"string","nullable":true},"contact_list_id":{"description":"ID of the contact list to which the form data is to be injected","type":"integer","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["form_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"form_id":{"description":"Display the form ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyFormNameException"},{"$ref":"#\/components\/schemas\/EmptyFormContactListIdException"},{"$ref":"#\/components\/schemas\/EmptyFormHTMLException"},{"$ref":"#\/components\/schemas\/IngressesEmptyDomain"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/IngressesIncorrectDomain"},{"$ref":"#\/components\/schemas\/IngressesDomainAlreadyExists"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/MissingFormTagException"},{"$ref":"#\/components\/schemas\/InvalidIdentifiersFoundException"},{"$ref":"#\/components\/schemas\/MissingFormFieldsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/forms\/{form_id}\/copy":{"post":{"tags":["Forms"],"summary":"Copy a form","description":"Copy a form","operationId":"FormsCopy","parameters":[{"name":"form_id","in":"path","description":"ID of form to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["form_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"form_id":{"description":"Display the form ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyFormNameException"},{"$ref":"#\/components\/schemas\/EmptyFormContactListIdException"},{"$ref":"#\/components\/schemas\/EmptyFormHTMLException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/MissingFormTagException"},{"$ref":"#\/components\/schemas\/InvalidIdentifiersFoundException"},{"$ref":"#\/components\/schemas\/MissingFormFieldsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFormException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/FormDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/forms\/{form_id}":{"get":{"tags":["Forms"],"summary":"Find profile","description":"Retrieve the profile of a form","operationId":"FormsFindProfileById","parameters":[{"name":"form_id","in":"path","description":"ID of form to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["form_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"form_profile":{"$ref":"#\/components\/schemas\/FormItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyFormIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFormException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/FormDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Forms"],"summary":"Update a form profile","description":"Update a form profile","operationId":"FormsUpdateProfileById","parameters":[{"name":"form_id","in":"path","description":"ID of form to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Name of the form","type":"string","nullable":true},"domain":{"description":"Form access domain. Underscores not allowed","type":"string","example":"http:\/\/form.example.org","nullable":true},"html":{"description":"Form in HTML format","type":"string","nullable":true},"contact_list_id":{"description":"ID of the contact list to which the form data is to be injected","type":"integer","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyFormNameException"},{"$ref":"#\/components\/schemas\/EmptyFormHTMLException"},{"$ref":"#\/components\/schemas\/IngressesEmptyDomain"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/IngressesIncorrectDomain"},{"$ref":"#\/components\/schemas\/IngressesDomainAlreadyExists"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/MissingFormTagException"},{"$ref":"#\/components\/schemas\/InvalidIdentifiersFoundException"},{"$ref":"#\/components\/schemas\/MissingFormFieldsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFormException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/FormDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Forms"],"summary":"Delete a form","description":"Delete a form","operationId":"FormsDelete","parameters":[{"name":"form_id","in":"path","description":"ID of form to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyFormIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedFormException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/FormDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email":{"get":{"tags":["Integrations - Email"],"summary":"Fetch list","description":"Retrieve the list of email accounts, including those shared to you","operationId":"IntegrationsEmailFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_accounts_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_accounts_list":{"description":"Displays the list of your email accounts","type":"array","items":{"$ref":"#\/components\/schemas\/IntegrationsEmailResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/mass-mailing":{"post":{"tags":["Integrations - Email"],"summary":"Add an email account for mass mailing","description":"Add an email account for mass mailing.<br \/>Once the account is added,\n you will receive an email asking you to validate your email address. This allows us to confirm that this email address belongs to you.","operationId":"IntegrationsEmailAddMassMailing","requestBody":{"content":{"application\/json":{"schema":{"required":["name","email"],"properties":{"name":{"description":"Email account name","type":"string","example":"My email"},"email":{"description":"Email address","type":"string","example":"me@example.com"},"sender":{"description":"Sender name","type":"string","example":"My email sender"},"reply_to":{"description":"List of the email addresses of the recipients whom you wish to receive replies","type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1}},"validated_url":{"description":"The url to redirect user when he has validated his email. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/validated\/%id%","nullable":true},"not_validated_url":{"description":"The url to redirect user when he has failed validation of his email. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/not-validated\/%id%","nullable":true},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":"1"},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","default":false}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_account_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_account_id":{"description":"Display the email account ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyEmailException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/InvalidValidatedUrlException"},{"$ref":"#\/components\/schemas\/InvalidNotValidatedUrlException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmailAlreadyExistsOnThisAccountException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.NumberMassMailingAccountsReachedException"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/smtp":{"post":{"tags":["Integrations - Email"],"summary":"Add a SMTP email account","description":"Add a SMTP email account","operationId":"IntegrationsEmailAddSmtp","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailSmtpAdd"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_account_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_account_id":{"description":"Display the email account ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyEmailException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmptySmtpUsernameException"},{"$ref":"#\/components\/schemas\/EmptySmtpPasswordException"},{"$ref":"#\/components\/schemas\/EmptySmtpHostException"},{"$ref":"#\/components\/schemas\/EmptySmtpPortException"},{"$ref":"#\/components\/schemas\/EmptySmtpSecureException"},{"$ref":"#\/components\/schemas\/BadSmtpSecureException"},{"$ref":"#\/components\/schemas\/EmptyImapUsernameException"},{"$ref":"#\/components\/schemas\/EmptyImapPasswordException"},{"$ref":"#\/components\/schemas\/EmptyImapHostException"},{"$ref":"#\/components\/schemas\/EmptyImapPortException"},{"$ref":"#\/components\/schemas\/EmptyImapSecureException"},{"$ref":"#\/components\/schemas\/BadImapSecureException"},{"$ref":"#\/components\/schemas\/BadImapCredentialsException"},{"$ref":"#\/components\/schemas\/BadSmtpCredentialsException"},{"$ref":"#\/components\/schemas\/EmptyMailgunDomainException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunDomainException"},{"$ref":"#\/components\/schemas\/EmptyMailgunRegionException"},{"$ref":"#\/components\/schemas\/EmptyMailgunApiKeyException"},{"$ref":"#\/components\/schemas\/EmptyMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/MailgunFromDomainMismatchException"},{"$ref":"#\/components\/schemas\/EmptyMailgunWebhookSigningKeyException"},{"$ref":"#\/components\/schemas\/BadMailgunCredentialsException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmailAlreadyExistsOnThisAccountException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.NumberSMTPAccountsReachedException"},{"$ref":"#\/components\/schemas\/IncorrectCustomTrackingDomainException"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/gmail":{"post":{"tags":["Integrations - Email"],"summary":"Add a Gmail email account","description":"Add a Gmail email account","operationId":"IntegrationsEmailAddGmail","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailGmailAdd"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_account"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_account":{"$ref":"#\/components\/schemas\/AddGmailReturn"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.NumberSMTPAccountsReachedException"},{"$ref":"#\/components\/schemas\/IncorrectCustomTrackingDomainException"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/outlook":{"post":{"tags":["Integrations - Email"],"summary":"Add a Outlook email account","description":"Add a Outlook email account","operationId":"IntegrationsEmailAddOutlook","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailOutlookAdd"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_account"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_account":{"$ref":"#\/components\/schemas\/AddOutlookReturn"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.NumberSMTPAccountsReachedException"},{"$ref":"#\/components\/schemas\/IncorrectCustomTrackingDomainException"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/{email_account_id}":{"get":{"tags":["Integrations - Email"],"summary":"Find profile","description":"Retrieve the profile of an email account","operationId":"IntegrationsEmailFindProfileById","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_account_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_account_profile":{"description":"Displays the email account profile detail","type":"object","oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmailMassMailingItem"},{"$ref":"#\/components\/schemas\/IntegrationsEmailSmtpItem"},{"$ref":"#\/components\/schemas\/IntegrationsEmailOutlookItem"},{"$ref":"#\/components\/schemas\/IntegrationsEmailGmailItem"}]}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Integrations - Email"],"summary":"Delete an email account","description":"Delete an email account","operationId":"IntegrationsEmailDelete","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/mass-mailing\/{email_account_id}":{"put":{"tags":["Integrations - Email"],"summary":"Update an email account for mass mailing","description":"Update an email account for mass mailing.<br \/>If you change your email address,\n you will receive an email asking you to validate your email address. This allows us to confirm that this email address belongs to you.","operationId":"IntegrationsEmailUpdateProfileByIdMassMailing","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Email account name","type":"string","nullable":true},"email":{"description":"Email address","type":"string","nullable":true},"reply_to":{"description":"List of the email addresses of the recipients whom you wish to receive replies","type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"validated_url":{"description":"The url to redirect user when he has validated his email. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/validated\/%id%","nullable":true},"not_validated_url":{"description":"The url to redirect user when he has failed validation of his email. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/not-validated\/%id%","nullable":true},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":"1","nullable":true},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","nullable":true,"default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","nullable":true,"default":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/InvalidValidatedUrlException"},{"$ref":"#\/components\/schemas\/InvalidNotValidatedUrlException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/smtp\/{email_account_id}":{"put":{"tags":["Integrations - Email"],"summary":"Update a SMTP email account","description":"Update a SMTP email account","operationId":"IntegrationsEmailUpdateProfileByIdSmtp","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailSmtpUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyEmailException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmptySmtpUsernameException"},{"$ref":"#\/components\/schemas\/EmptySmtpPasswordException"},{"$ref":"#\/components\/schemas\/EmptySmtpHostException"},{"$ref":"#\/components\/schemas\/EmptySmtpPortException"},{"$ref":"#\/components\/schemas\/EmptySmtpSecureException"},{"$ref":"#\/components\/schemas\/BadSmtpSecureException"},{"$ref":"#\/components\/schemas\/EmptyImapUsernameException"},{"$ref":"#\/components\/schemas\/EmptyImapPasswordException"},{"$ref":"#\/components\/schemas\/EmptyImapHostException"},{"$ref":"#\/components\/schemas\/EmptyImapPortException"},{"$ref":"#\/components\/schemas\/EmptyImapSecureException"},{"$ref":"#\/components\/schemas\/BadImapSecureException"},{"$ref":"#\/components\/schemas\/BadImapCredentialsException"},{"$ref":"#\/components\/schemas\/BadSmtpCredentialsException"},{"$ref":"#\/components\/schemas\/EmptyMailgunDomainException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunDomainException"},{"$ref":"#\/components\/schemas\/EmptyMailgunRegionException"},{"$ref":"#\/components\/schemas\/EmptyMailgunApiKeyException"},{"$ref":"#\/components\/schemas\/EmptyMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/MailgunFromDomainMismatchException"},{"$ref":"#\/components\/schemas\/EmptyMailgunWebhookSigningKeyException"},{"$ref":"#\/components\/schemas\/BadMailgunCredentialsException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/IncorrectCustomTrackingDomainException"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/gmail\/{email_account_id}":{"put":{"tags":["Integrations - Email"],"summary":"Update a Gmail email account","description":"Update a Gmail email account","operationId":"IntegrationsEmailUpdateProfileByIdGmail","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailGmailUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/EmptySmtpUsernameException"},{"$ref":"#\/components\/schemas\/EmptySmtpPasswordException"},{"$ref":"#\/components\/schemas\/EmptySmtpHostException"},{"$ref":"#\/components\/schemas\/EmptySmtpPortException"},{"$ref":"#\/components\/schemas\/EmptySmtpSecureException"},{"$ref":"#\/components\/schemas\/BadSmtpSecureException"},{"$ref":"#\/components\/schemas\/BadSmtpCredentialsException"},{"$ref":"#\/components\/schemas\/EmptyMailgunDomainException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunDomainException"},{"$ref":"#\/components\/schemas\/EmptyMailgunRegionException"},{"$ref":"#\/components\/schemas\/EmptyMailgunApiKeyException"},{"$ref":"#\/components\/schemas\/EmptyMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/MailgunFromDomainMismatchException"},{"$ref":"#\/components\/schemas\/EmptyMailgunWebhookSigningKeyException"},{"$ref":"#\/components\/schemas\/BadMailgunCredentialsException"},{"$ref":"#\/components\/schemas\/IncorrectCustomTrackingDomainException"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/outlook\/{email_account_id}":{"put":{"tags":["Integrations - Email"],"summary":"Update a Outlook email account","description":"Update a Outlook email account","operationId":"IntegrationsEmailUpdateProfileByIdOutlook","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailOutlookUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyFinalRedirectUrlException"},{"$ref":"#\/components\/schemas\/EmptySmtpUsernameException"},{"$ref":"#\/components\/schemas\/EmptySmtpPasswordException"},{"$ref":"#\/components\/schemas\/EmptySmtpHostException"},{"$ref":"#\/components\/schemas\/EmptySmtpPortException"},{"$ref":"#\/components\/schemas\/EmptySmtpSecureException"},{"$ref":"#\/components\/schemas\/BadSmtpSecureException"},{"$ref":"#\/components\/schemas\/BadSmtpCredentialsException"},{"$ref":"#\/components\/schemas\/EmptyMailgunDomainException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunDomainException"},{"$ref":"#\/components\/schemas\/EmptyMailgunRegionException"},{"$ref":"#\/components\/schemas\/EmptyMailgunApiKeyException"},{"$ref":"#\/components\/schemas\/EmptyMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/IncorrectMailgunFromEmailException"},{"$ref":"#\/components\/schemas\/MailgunFromDomainMismatchException"},{"$ref":"#\/components\/schemas\/EmptyMailgunWebhookSigningKeyException"},{"$ref":"#\/components\/schemas\/BadMailgunCredentialsException"},{"$ref":"#\/components\/schemas\/IncorrectCustomTrackingDomainException"},{"$ref":"#\/components\/schemas\/IngressesDomainInUse"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationEmailSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/mass-mailing\/{email_account_id}\/force\/validate":{"put":{"tags":["Integrations - Email"],"summary":"Force Mass Mailing email validation","description":"Force Mass Mailing email validation","operationId":"integrationsEmailMassMailingForceValidate","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to force validation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/smtp\/validity\/test":{"put":{"tags":["Integrations - Email"],"summary":"SMTP email accounts validity test","description":"SMTP email accounts validity test","operationId":"IntegrationsEmailSmtpAccountsValidityTest","requestBody":{"content":{"application\/json":{"schema":{"required":["email_account_ids"],"properties":{"email_account_ids":{"description":"IDs of the SMTP email account to validity test","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/IntegrationsEmailSmtpValidityTestResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyEmailAccountIdsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/discover\/{email}":{"get":{"tags":["Integrations - Email"],"summary":"Discover email server settings using Autodiscover","description":"Retrieves SMTP and IMAP settings for a given email address using Autodiscover service","operationId":"IntegrationsEmailDiscoverSettings","parameters":[{"name":"email","in":"path","description":"Email address to discover settings for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["email_server_settings"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"email_server_settings":{"$ref":"#\/components\/schemas\/DiscoverSettings"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.InvalidAutodiscoverResponseException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.AutodiscoverServiceException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.AutodiscoverNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/smtp\/{email_account_id}\/warmup":{"get":{"tags":["Integrations - Email"],"summary":"Retrieve warmup settings for an SMTP email account","description":"Retrieve warmup settings for an SMTP email account","operationId":"IntegrationsEmailGetWarmupSettingsById","parameters":[{"name":"email_account_id","in":"path","description":"ID of the email account to fetch warmup settings","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["warmup_settings"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"warmup_settings":{"$ref":"#\/components\/schemas\/WarmupSettings"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Integrations - Email"],"summary":"Update warmup settings for an SMTP email account","description":"Update warmup settings for an SMTP email account","operationId":"IntegrationsEmailUpdateWarmupSettingsByIdSmtp","parameters":[{"name":"email_account_id","in":"path","description":"ID of email account to update warmup settings","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"warmup_enabled":{"description":"Enable or disable warmup","type":"boolean","example":true,"nullable":true},"total_warmup_per_day":{"description":"Total number of warmup emails per day (max 50)","type":"integer","example":35,"nullable":true,"maximum":50,"minimum":1},"daily_rampup":{"description":"Daily increase in the number of warmup emails (max 20, min 5)","type":"integer","example":5,"nullable":true,"maximum":20,"minimum":5},"reply_rate_percentage":{"description":"Target reply rate percentage (Between 20 and 50)","type":"integer","example":30,"nullable":true,"maximum":50,"minimum":20},"keyword":{"description":"This text will be injected into the body of the warmup. It will be two 5 letter words e.g apple-juice.","type":"string","example":"apple-juice","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.WarmupValueOutOfRangeException"},{"$ref":"#\/components\/schemas\/SmtpImapUsernameMismatchException"},{"$ref":"#\/components\/schemas\/SmtpImapPasswordMismatchException"},{"$ref":"#\/components\/schemas\/EmptyImapPortException"},{"$ref":"#\/components\/schemas\/EmptyImapHostException"},{"$ref":"#\/components\/schemas\/EmptyImapPasswordException"},{"$ref":"#\/components\/schemas\/EmptyImapUsernameException"},{"$ref":"#\/components\/schemas\/EmptySmtpPortException"},{"$ref":"#\/components\/schemas\/EmptySmtpHostException"},{"$ref":"#\/components\/schemas\/EmptySmtpPasswordException"},{"$ref":"#\/components\/schemas\/EmptySmtpUsernameException"},{"$ref":"#\/components\/schemas\/EmptySenderNameException"},{"$ref":"#\/components\/schemas\/IncorrectKeywordException"},{"$ref":"#\/components\/schemas\/warmup_account_verification_failed"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedWarmupException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/smtp\/{email_account_id}\/warmup\/stats":{"get":{"tags":["Integrations - Email"],"summary":"Retrieve warmup statistics for an SMTP email account.","description":"Retrieves the warmup statistics for an SMTP email account, specifically covering the last 7 days.","operationId":"IntegrationsEmailGetWarmupStatsById","parameters":[{"name":"email_account_id","in":"path","description":"ID of the email account to fetch warmup stats","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["warmup_stats"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"warmup_stats":{"$ref":"#\/components\/schemas\/WarmupStats"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/protections":{"get":{"tags":["Integrations - Email"],"summary":"List the anti spam protections you have received by email","description":"List the anti spam protections you have received by email","operationId":"IntegrationsEmailGetProtections","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["protections"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"protections":{"description":"Displays the protections","type":"array","items":{"$ref":"#\/components\/schemas\/Protection"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/email\/protection\/{protection_id}":{"put":{"tags":["Integrations - Email"],"summary":"Set a protection as handled","description":"Set a protection as handled","operationId":"IntegrationsEmailUpdateProtection","parameters":[{"name":"protection_id","in":"path","description":"ID of protection to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["handled"],"properties":{"handled":{"type":"boolean"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedProtectionException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ProtectionDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/linkedin":{"get":{"tags":["Integrations - LinkedIn"],"summary":"Fetch list","description":"Retrieve the list of LinkedIn accounts, including those shared to you","operationId":"IntegrationsLinkedInFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["linkedin_accounts_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"linkedin_accounts_list":{"description":"Displays the list of your LinkedIn accounts","type":"array","items":{"$ref":"#\/components\/schemas\/IntegrationsLinkedinResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Integrations - LinkedIn"],"summary":"Add a LinkedIn account","description":"Add a LinkedIn account. You must provider either username + password, or a session_cookie. If provided the username + password, you will need to send a validation code (checkpoint)","operationId":"IntegrationsLinkedInAdd","requestBody":{"content":{"application\/json":{"schema":{"required":["name","session_cookie"],"properties":{"name":{"description":"LinkedIn account name","type":"string","example":"My LinkedIn account"},"session_cookie":{"description":"LinkedIn session cookie (li_at)","type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"session_cookie_sn":{"description":"LinkedIn session cookie Sales Navigator (li_a)","type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"username":{"description":"LinkedIn username","type":"string","example":"username@example.org","nullable":true},"password":{"description":"LinkedIn password","type":"string","example":"WqdIAGvQq0bXBiBmTVh8","nullable":true},"is_sales_navigator_account":{"description":"Is a Sales Navigator account ?","type":"boolean","example":false,"nullable":true},"signature":{"description":"Your signature","type":"string","example":"Jean dupont"},"max_conversations_messages_extractor":{"description":"Number of LinkedIn conversations to extract (default 100, max 200)","type":"integer","example":100,"nullable":true},"accept_received_invitations":{"description":"Automatically accept LinkedIn invitations","type":"boolean","example":false,"nullable":true},"accept_received_invitations_message":{"description":"Message to be sent when invitations are accepted","type":"string","nullable":true},"withdraw_pending_invitations":{"description":"Withdraw LinkedIn invitations weekly","type":"boolean","example":false,"nullable":true},"withdraw_pending_invitations_number":{"description":"Withdraw how many LinkedIn invites (default 100, max 1000)","type":"integer","example":100,"nullable":true},"withdraw_pending_invitations_oldest":{"description":"Start with the oldest LinkedIn invitations","type":"boolean","example":true,"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1}},"user_agent":{"description":"The user agent to use. It must be the same than the one used when logging in to linkedin. Put null to use the one used when requesting the api","type":"string","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["linkedin_account_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"linkedin_account_id":{"description":"Display the LinkedIn account ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptySessionCookieException"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.NumberLinkedinAccountsReachedException"},{"$ref":"#\/components\/schemas\/PoolTypeNotLinkedinException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationLinkedinSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/linkedin\/{linkedin_account_id}":{"get":{"tags":["Integrations - LinkedIn"],"summary":"Find profile","description":"Retrieve the profile of a LinkedIn account","operationId":"IntegrationsLinkedInFindProfileById","parameters":[{"name":"linkedin_account_id","in":"path","description":"ID of LinkedIn account to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["linkedin_account_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"linkedin_account_profile":{"$ref":"#\/components\/schemas\/IntegrationsLinkedinItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Integrations - LinkedIn"],"summary":"Update a LinkedIn account","description":"Update a LinkedIn account","operationId":"IntegrationsLinkedInUpdateProfileById","parameters":[{"name":"linkedin_account_id","in":"path","description":"ID of LinkedIn account to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"LinkedIn account name","type":"string","nullable":true},"session_cookie":{"description":"LinkedIn session cookie (li_at)","type":"string","nullable":true},"session_cookie_sn":{"description":"LinkedIn session cookie Sales Navigator (li_a)","type":"string","nullable":true},"username":{"description":"LinkedIn username","type":"string","nullable":true},"password":{"description":"LinkedIn password","type":"string","nullable":true},"is_sales_navigator_account":{"description":"Is a Sales Navigator account ?","type":"boolean","nullable":true},"signature":{"description":"Your signature","type":"string","nullable":true},"max_conversations_messages_extractor":{"description":"Number of LinkedIn conversations to extract (default 100, max 200)","type":"integer","nullable":true},"accept_received_invitations":{"description":"Automatically accept LinkedIn invitations","type":"boolean","nullable":true},"accept_received_invitations_message":{"description":"Message to be sent when invitations are accepted","type":"string","nullable":true},"withdraw_pending_invitations":{"description":"Withdraw LinkedIn invitations weekly","type":"boolean","nullable":true},"withdraw_pending_invitations_number":{"description":"Withdraw how many LinkedIn invites (default 100, max 1000)","type":"integer","nullable":true},"withdraw_pending_invitations_oldest":{"description":"Start with the oldest LinkedIn invitations","type":"boolean","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"user_agent":{"description":"The user agent to use. It must be the same than the one used when logging in to linkedin. Put null to use the one used when requesting the api","type":"string","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptySessionCookieException"},{"$ref":"#\/components\/schemas\/PoolTypeNotLinkedinException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedIntegrationLinkedinSharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Integrations - LinkedIn"],"summary":"Delete a LinkedIn account","description":"Delete a LinkedIn account","operationId":"IntegrationsLinkedInDelete","parameters":[{"name":"linkedin_account_id","in":"path","description":"ID of LinkedIn account to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/integrations\/linkedin\/{linkedin_account_id}\/checkpoint":{"post":{"tags":["Integrations - LinkedIn"],"summary":"Solve an authentication checkpoint using a code that you received. If the checkpoint is via the app, you can enter any code you want once validated","description":"Solve an authentication checkpoint using a code that you received","operationId":"IntegrationsLinkedInCheckpoint","parameters":[{"name":"linkedin_account_id","in":"path","description":"ID of LinkedIn account","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["code"],"properties":{"code":{"description":"Checkpoint code","type":"string","example":"123456"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.InvalidCheckpoint"},{"$ref":"#\/components\/schemas\/ApiLinkedin.AlreadyMappedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/jobs\/{job_uniqid}":{"delete":{"tags":["Jobs"],"summary":"Stop a job","description":"Stop a job","operationId":"JobsStop","parameters":[{"name":"job_uniqid","in":"path","description":"Uniqid of job","required":true,"allowEmptyValue":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/JobAlreadyStoppedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedJobException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/JobNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/jobs\/prm\/{target_id}":{"get":{"tags":["Jobs"],"summary":"List prm jobs","description":"List prm jobs of a specified user id","operationId":"JobsList","parameters":[{"name":"target_id","in":"path","description":"Id of target","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["jobs"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"jobs":{"description":"Displays the list of jobs","type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/jobs\/failed\/{job_uniqid}":{"delete":{"tags":["Jobs"],"summary":"Delete failed job result","description":"Delete a failed job result by uniqid","operationId":"JobsDeleteFailed","parameters":[{"name":"job_uniqid","in":"path","description":"Uniqid of job","required":true,"allowEmptyValue":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/JobNotFailedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedJobException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/JobNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email":{"get":{"tags":["Models - Email"],"summary":"Fetch list","description":"Retrieve the list of email models, including those shared to you","operationId":"ModelsEmailFetchList","parameters":[{"name":"only_shared_with_reseller_customers","in":"query","description":"If true, only items shared with reseller customers will be shown, if null all items are returned","required":false,"schema":{"type":"boolean","nullable":true,"default":null}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["models_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"models_list":{"description":"Displays the list of your email models","type":"array","items":{"$ref":"#\/components\/schemas\/ModelsEmailResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Models - Email"],"summary":"Create an email model","description":"Create an email model","operationId":"ModelsEmailCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Email model name","type":"string","example":"My email model"},"subject":{"description":"Email subject","type":"string","example":"My email subject","nullable":true},"text":{"description":"Text content of your email","type":"string","example":"Example of the text content of my email","nullable":true},"html":{"description":"HTML content of your email","type":"string","example":"Example of the HTML content of my email","nullable":true},"json_template":{"description":"If you use a template editor, you can save its JSON configuration here","type":"string","example":"[]"},"is_template":{"description":"Is designed on the template editor ?","type":"boolean","example":false,"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1},"is_ai":{"description":"Is content generated by AI based on contacts ?","type":"boolean","example":false,"nullable":true},"ai_prompt":{"description":"Prompt used to generate the model (max 10000 characters)","type":"string","example":"My prompt"},"ai_number_paragraphs":{"description":"How many paragraphs should the AI generate for the content of your email ? (max 4)","type":"integer","example":1},"ai_language":{"description":"Code of the language in which model email must be written by AI - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"ai_temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the email model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptySubjectException"},{"$ref":"#\/components\/schemas\/EmptyHTMLException"},{"$ref":"#\/components\/schemas\/InvalidJsonTemplateException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptyAiLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectAiLanguageException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/{model_id}":{"get":{"tags":["Models - Email"],"summary":"Find profile","description":"Retrieve the profile of an email model","operationId":"ModelsEmailFindProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of email model to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsEmailItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Models - Email"],"summary":"Update an email model","description":"Update an email model","operationId":"ModelsEmailUpdateProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of email model to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Email model name","type":"string","example":"My email model","nullable":true},"subject":{"description":"Email subject","type":"string","example":"My email subject","nullable":true},"text":{"description":"Text content of your email","type":"string","example":"Example of the text content of my email","nullable":true},"html":{"description":"HTML content of your email","type":"string","example":"Example of the HTML content of my email","nullable":true},"json_template":{"description":"If you use a template editor, you can save its JSON configuration here","type":"string","example":"[]"},"is_template":{"description":"Is designed on the template editor ?","type":"boolean","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true},"is_ai":{"description":"Is content generated by AI based on contacts ?","type":"boolean","example":false,"nullable":true},"ai_prompt":{"description":"Prompt used to generate the model (max 10000 characters)","type":"string","example":"My prompt","nullable":true},"ai_number_paragraphs":{"description":"How many paragraphs should the AI generate for the content of your email ? (max 4)","type":"integer","example":1,"nullable":true},"ai_language":{"description":"Code of the language in which model email must be written by AI - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"ai_temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0},"pin":{"type":"boolean","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptySubjectException"},{"$ref":"#\/components\/schemas\/EmptyHTMLException"},{"$ref":"#\/components\/schemas\/InvalidJsonTemplateException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptyAiLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectAiLanguageException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Models - Email"],"summary":"Delete an email model","description":"Delete an email model","operationId":"ModelsEmailDelete","parameters":[{"name":"model_id","in":"path","description":"ID of email model to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/{model_id}\/{contact_id}":{"get":{"tags":["Models - Email"],"summary":"Find AI model profile and generate content","description":"Retrieve the profile of an email model and generate content from a contact profile if it is an AI model","operationId":"ModelsEmailFindProfileByIdAndGenerateContent","parameters":[{"name":"model_id","in":"path","description":"ID of email model to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of the contact (from a contact list) to generate email model content from, if it is an AI model","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsEmailItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/NotAiModelException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/{model_id}\/{contact_id}\/regenerate":{"get":{"tags":["Models - Email"],"summary":"Find AI model profile and regenerate content","description":"Retrieve the profile of an email model and regenerate content from a contact profile if it is an AI model","operationId":"ModelsEmailFindProfileByIdAndRegenerateContent","parameters":[{"name":"model_id","in":"path","description":"ID of email model to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of the contact (from a contact list) to generate email model content from, if it is an AI model","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsEmailItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/NotAiModelException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/{model_id}\/copy":{"post":{"tags":["Models - Email"],"summary":"Copy an email model","description":"Copy an email model","operationId":"ModelsEmailCopy","parameters":[{"name":"model_id","in":"path","description":"ID of email model to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the email model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/{model_id}\/copy\/to\/{user_id}":{"post":{"tags":["Models - Email"],"summary":"Copy an email model to user ID","description":"Copy an email model to user ID","operationId":"ModelsEmailCopyTo","parameters":[{"name":"model_id","in":"path","description":"ID of email model to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of the user to copy the email model to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the email model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/{model_id}\/send\/test":{"post":{"tags":["Models - Email"],"summary":"Send an email campaign on your test emails","description":"Send an email campaign on your test emails","operationId":"ModelsEmailSendTest","parameters":[{"name":"model_id","in":"path","description":"ID of email model to send test","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["emails"],"properties":{"sender":{"description":"Email sender","type":"string","example":"My sender"},"emails":{"description":"List of the email addresses of the recipients whom you wish to send the test mail","type":"array","items":{"type":"string","example":"jean.dupont@example.com"}},"contact_list_id":{"description":"ID of contact list to use (Limited to the first 5 emails)","type":"integer","nullable":true},"email_signature_id":{"description":"ID of email signature to use","type":"integer","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/EmptyEmailsException"},{"$ref":"#\/components\/schemas\/IncorrectEmailsException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/SendTestEmailRestrictedException"},{"$ref":"#\/components\/schemas\/SendingAiModelTestNotAllowedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/send\/test":{"post":{"tags":["Models - Email"],"summary":"Send an email campaign on your test emails without creating a model","description":"Send an email campaign on your test emails without creating a model","operationId":"ModelsEmailSendTestWithoutModel","requestBody":{"content":{"application\/json":{"schema":{"properties":{"subject":{"description":"Email subject","type":"string","example":"My email subject"},"text":{"description":"Text content of your email","type":"string","example":"Example of the text content of my email"},"html":{"description":"HTML content of your email","type":"string","example":"Example of the HTML content of my email"},"sender":{"description":"Email sender","type":"string","example":"My sender"},"emails":{"description":"List of the email addresses of the recipients whom you wish to send the test mail","type":"array","items":{"type":"string","example":"jean.dupont@example.com"}},"contact_list_id":{"description":"ID of contact list to use (Limited to the first 5 emails)","type":"integer","nullable":true},"email_signature_id":{"description":"ID of email signature to use","type":"integer","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptySubjectException"},{"$ref":"#\/components\/schemas\/EmptyHTMLException"},{"$ref":"#\/components\/schemas\/EmptyEmailsException"},{"$ref":"#\/components\/schemas\/IncorrectEmailsException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/get\/html\/from\/url":{"post":{"tags":["Models - Email"],"summary":"Get HTML from URL","description":"Get HTML from URL","operationId":"ModelsEmailGetHtmlFromUrl","requestBody":{"content":{"application\/json":{"schema":{"properties":{"url":{"description":"URL of HTML file to be imported","type":"string","example":"https:\/\/example.org\/my_html_file.html"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["html"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"html":{"description":"Display the HTML","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelsEmailEmptyUrlException"},{"$ref":"#\/components\/schemas\/IncorrectUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/generate":{"post":{"tags":["Models - Email"],"summary":"Generate an email model using AI","description":"Generate an email model using AI","operationId":"ModelsEmailGenerate","requestBody":{"content":{"application\/json":{"schema":{"required":["name","prompt","language"],"properties":{"name":{"description":"Email model name","type":"string","example":"My email model"},"prompt":{"description":"Prompt to be used to generate the email model (max 10000 characters)","type":"string","example":"My prompt"},"language":{"description":"Email model language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"number_paragraphs":{"description":"Number of paragraphs (max 4)","type":"integer","example":1},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1},"model_id":{"description":"If you want to generate a reminder, enter the model id of the previous email","type":"integer","example":1,"nullable":true},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the email model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptySubjectException"},{"$ref":"#\/components\/schemas\/EmptyHTMLException"},{"$ref":"#\/components\/schemas\/InvalidJsonTemplateException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/AiModelsAreNotAllowedException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/{model_id}\/regenerate":{"post":{"tags":["Models - Email"],"summary":"Regenerate an email model using AI","description":"Regenerate an email model using AI","operationId":"ModelsEmailRegenerate","parameters":[{"name":"model_id","in":"path","description":"ID of email model to regenerate","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["prompt","language","number_paragraphs"],"properties":{"prompt":{"description":"Prompt to be used to regenerate the email model (max 10000 characters)","type":"string","example":"My prompt"},"language":{"description":"Email model language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"number_paragraphs":{"description":"Number of paragraphs (max 4)","type":"integer","example":1},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptySubjectException"},{"$ref":"#\/components\/schemas\/EmptyHTMLException"},{"$ref":"#\/components\/schemas\/InvalidJsonTemplateException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/NotGeneratedModelException"},{"$ref":"#\/components\/schemas\/AiModelsAreNotAllowedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/email\/generate\/html":{"post":{"tags":["Models - Email"],"summary":"Generate HTML email using AI","description":"Generate HTML email using AI","operationId":"ModelsEmailGenerateHTML","requestBody":{"content":{"application\/json":{"schema":{"required":["prompt","language","number_paragraphs"],"properties":{"prompt":{"description":"Prompt to be used to generate the email model (max 10000 characters)","type":"string","example":"My prompt"},"language":{"description":"Email model language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"number_paragraphs":{"description":"Number of paragraphs (max 4)","type":"integer","example":1},"model_id":{"description":"If you want to generate a reminder, enter the model id of the previous email","type":"integer","example":1,"nullable":true},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["html"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"html":{"description":"Display the HTML","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/AiModelsAreNotAllowedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/invitation":{"get":{"tags":["Models - LinkedIn Invitation"],"summary":"Fetch list","description":"Retrieve the list of LinkedIn invitations, including those shared to you","operationId":"ModelsLinkedinInvitationFetchList","parameters":[{"name":"only_shared_with_reseller_customers","in":"query","description":"If true, only items shared with reseller customers will be shown, if null all items are returned","required":false,"schema":{"type":"boolean","nullable":true,"default":null}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["models_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"models_list":{"description":"Displays the list of your LinkedIn invitations","type":"array","items":{"$ref":"#\/components\/schemas\/ModelsLinkedinInvitationResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Models - LinkedIn Invitation"],"summary":"Create a LinkedIn invitation","description":"Create a LinkedIn invitation","operationId":"ModelsLinkedinInvitationCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"LinkedIn invitation name","type":"string","example":"My LinkedIn invitation"},"text":{"description":"Content of your LinkedIn Invitation. Required for static models. A LinkedIn Invitation is limited to 300 characters.","type":"string","example":"Example of the content of my LinkedIn Invitation","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1},"is_ai":{"description":"When true, create a contact-personalized AI LinkedIn invitation model.","type":"boolean","example":true},"ai_prompt":{"description":"AI generation prompt. Required when is_ai is true.","type":"string","example":"Write a concise personalized LinkedIn invitation for this B2B contact.","nullable":true},"ai_language":{"description":"AI output language code. Required when is_ai is true.","type":"string","example":"ENG","nullable":true},"ai_temperature":{"description":"AI generation temperature between 0 and 1.","type":"number","format":"float","example":0.2,"nullable":true},"ai_max_characters":{"description":"AI invitation maximum character count. Clamped between 1 and 300.","type":"integer","example":170,"nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the LinkedIn invitation ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/Models.EmptyTextException"},{"$ref":"#\/components\/schemas\/InvalidTextException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsLinkedinInvitationException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/invitation\/{model_id}":{"get":{"tags":["Models - LinkedIn Invitation"],"summary":"Find profile","description":"Retrieve the profile of a LinkedIn invitation","operationId":"ModelsLinkedinInvitationFindProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn invitation to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsLinkedinInvitationItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Models - LinkedIn Invitation"],"summary":"Update a LinkedIn invitation","description":"Update a LinkedIn invitation","operationId":"ModelsLinkedinInvitationUpdateProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn invitation to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"LinkedIn invitation name","type":"string","example":"My linkedin invitation","nullable":true},"text":{"description":"Content of your LinkedIn Invitation.<br>A LinkedIn Invitation is limited to 300 characters.","type":"string","example":"Example of the content of my LinkedIn Invitation","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true},"pin":{"type":"boolean","nullable":true},"is_ai":{"description":"When true, the model generates a personalized LinkedIn invitation per contact.","type":"boolean","example":true,"nullable":true},"ai_prompt":{"description":"AI generation prompt. Required after merge when is_ai is true.","type":"string","example":"Write a concise personalized LinkedIn invitation for this B2B contact.","nullable":true},"ai_language":{"description":"AI output language code. Required after merge when is_ai is true.","type":"string","example":"ENG","nullable":true},"ai_temperature":{"description":"AI generation temperature between 0 and 1.","type":"number","format":"float","example":0.2,"nullable":true},"ai_max_characters":{"description":"AI invitation maximum character count. Clamped between 1 and 300.","type":"integer","example":170,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/Models.EmptyTextException"},{"$ref":"#\/components\/schemas\/InvalidTextException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Models - LinkedIn Invitation"],"summary":"Delete a LinkedIn invitation","description":"Delete a LinkedIn invitation","operationId":"ModelsLinkedinInvitationDelete","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn invitation to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/invitation\/{model_id}\/{contact_id}":{"get":{"tags":["Models - LinkedIn Invitation"],"summary":"Find AI model profile and generate content","description":"Retrieve the profile of a LinkedIn invitation model and generate content from a contact profile if it is an AI model","operationId":"ModelsLinkedinInvitationFindProfileByIdAndGenerateContent","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn invitation to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of the contact (from a contact list) to generate LinkedIn invitation content from, if it is an AI model","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsLinkedinInvitationItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/invitation\/{model_id}\/{contact_id}\/regenerate":{"get":{"tags":["Models - LinkedIn Invitation"],"summary":"Find AI model profile and regenerate content","description":"Retrieve the profile of a LinkedIn invitation model and regenerate content from a contact profile if it is an AI model","operationId":"ModelsLinkedinInvitationFindProfileByIdAndRegenerateContent","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn invitation to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of the contact (from a contact list) to regenerate LinkedIn invitation content from, if it is an AI model","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsLinkedinInvitationItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/invitation\/{model_id}\/copy":{"post":{"tags":["Models - LinkedIn Invitation"],"summary":"Copy a LinkedIn invitation","description":"Copy a LinkedIn invitation","operationId":"ModelsLinkedinInvitationCopy","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn invitation to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the LinkedIn invitation ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsLinkedinInvitationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/invitation\/{model_id}\/copy\/to\/{user_id}":{"post":{"tags":["Models - LinkedIn Invitation"],"summary":"Copy a LinkedIn invitation to user ID","description":"Copy a LinkedIn invitation to user ID","operationId":"ModelsLinkedinInvitationCopyTo","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn invitation to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of the user to copy the LinkedIn invitation to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the LinkedIn invitation ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsLinkedinInvitationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/invitation\/generate\/content":{"post":{"tags":["Models - LinkedIn Invitation"],"summary":"Generate LinkedIn invitation content using AI","description":"Generate LinkedIn invitation content using AI","operationId":"ModelsLinkedinInvitationGenerateContent","requestBody":{"content":{"application\/json":{"schema":{"required":["prompt","language","is_sales_navigator_account"],"properties":{"prompt":{"description":"Prompt to be used to generate the LinkedIn invitation model (max 10000 characters)","type":"string","example":"My prompt"},"language":{"description":"LinkedIn invitation model language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"is_sales_navigator_account":{"description":"Is a Sales Navigator account ?","type":"boolean","example":true},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["content"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"content":{"description":"Display the content","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/message":{"get":{"tags":["Models - LinkedIn Message"],"summary":"Fetch list","description":"Retrieve the list of LinkedIn messages, including those shared to you","operationId":"ModelsLinkedinMessageFetchList","parameters":[{"name":"only_shared_with_reseller_customers","in":"query","description":"If true, only items shared with reseller customers will be shown, if null all items are returned","required":false,"schema":{"type":"boolean","nullable":true,"default":null}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["models_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"models_list":{"description":"Displays the list of your LinkedIn messages","type":"array","items":{"$ref":"#\/components\/schemas\/ModelsLinkedinMessageResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Models - LinkedIn Message"],"summary":"Create a LinkedIn message","description":"Create a LinkedIn message","operationId":"ModelsLinkedinMessageCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"LinkedIn message name","type":"string","example":"My LinkedIn message"},"text":{"description":"Content of your LinkedIn Message. Can be empty or null if a file is attached.","type":"string","example":"Example of the content of my LinkedIn Message","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1},"file_id":{"description":"File id","type":"integer","example":1},"is_ai":{"description":"When true, create a contact-personalized AI LinkedIn message model.","type":"boolean","example":true},"ai_prompt":{"description":"AI generation prompt. Required when is_ai is true.","type":"string","example":"Write a short personalized LinkedIn follow-up for this B2B contact.","nullable":true},"ai_language":{"description":"AI output language code. Required when is_ai is true.","type":"string","example":"ENG","nullable":true},"ai_temperature":{"description":"AI generation temperature between 0 and 1.","type":"number","format":"float","example":0.2,"nullable":true},"ai_number_paragraphs":{"description":"AI LinkedIn message paragraph count. Clamped between 1 and 4.","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the LinkedIn message ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/Models.EmptyTextException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsLinkedinMessageException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/UnauthorizedFileException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/message\/{model_id}":{"get":{"tags":["Models - LinkedIn Message"],"summary":"Find profile","description":"Retrieve the profile of a LinkedIn message","operationId":"ModelsLinkedinMessageFindProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn message to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsLinkedinMessageItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Models - LinkedIn Message"],"summary":"Update a LinkedIn message","description":"Update a LinkedIn message","operationId":"ModelsLinkedinMessageUpdateProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn message to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"LinkedIn message name","type":"string","example":"My linkedin message","nullable":true},"text":{"description":"Content of your LinkedIn Message. Can be empty or null if a file is attached.","type":"string","example":"Example of the content of my LinkedIn Message","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true},"pin":{"type":"boolean","nullable":true},"file_id":{"type":"integer","nullable":true},"is_ai":{"description":"When true, the model generates a personalized LinkedIn message per contact.","type":"boolean","example":true,"nullable":true},"ai_prompt":{"description":"AI generation prompt. Required after merge when is_ai is true.","type":"string","example":"Write a short personalized LinkedIn follow-up for this B2B contact.","nullable":true},"ai_language":{"description":"AI output language code. Required after merge when is_ai is true.","type":"string","example":"ENG","nullable":true},"ai_temperature":{"description":"AI generation temperature between 0 and 1.","type":"number","format":"float","example":0.2,"nullable":true},"ai_number_paragraphs":{"description":"AI LinkedIn message paragraph count. Clamped between 1 and 4.","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/Models.EmptyTextException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Models - LinkedIn Message"],"summary":"Delete a LinkedIn message","description":"Delete a LinkedIn message","operationId":"ModelsLinkedinMessageDelete","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn message to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/message\/{model_id}\/{contact_id}":{"get":{"tags":["Models - LinkedIn Message"],"summary":"Find AI model profile and generate content","description":"Retrieve the profile of a LinkedIn message model and generate content from a contact profile if it is an AI model","operationId":"ModelsLinkedinMessageFindProfileByIdAndGenerateContent","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn message to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of the contact (from a contact list) to generate LinkedIn message content from, if it is an AI model","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsLinkedinMessageItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/message\/{model_id}\/{contact_id}\/regenerate":{"get":{"tags":["Models - LinkedIn Message"],"summary":"Find AI model profile and regenerate content","description":"Retrieve the profile of a LinkedIn message model and regenerate content from a contact profile if it is an AI model","operationId":"ModelsLinkedinMessageFindProfileByIdAndRegenerateContent","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn message to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_id","in":"path","description":"ID of the contact (from a contact list) to regenerate LinkedIn message content from, if it is an AI model","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsLinkedinMessageItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/message\/{model_id}\/copy":{"post":{"tags":["Models - LinkedIn Message"],"summary":"Copy a LinkedIn message","description":"Copy a LinkedIn message","operationId":"ModelsLinkedinMessageCopy","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn message to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the LinkedIn message ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsLinkedinMessageException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/message\/{model_id}\/copy\/to\/{user_id}":{"post":{"tags":["Models - LinkedIn Message"],"summary":"Copy a LinkedIn message to user ID","description":"Copy a LinkedIn message to user ID","operationId":"ModelsLinkedinMessageCopyTo","parameters":[{"name":"model_id","in":"path","description":"ID of LinkedIn message to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of the user to copy the LinkedIn message to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the LinkedIn message ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsLinkedinMessageException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/linkedin\/message\/generate\/content":{"post":{"tags":["Models - LinkedIn Message"],"summary":"Generate LinkedIn message content using AI","description":"Generate LinkedIn message content using AI","operationId":"ModelsLinkedinMessageGenerateContent","requestBody":{"content":{"application\/json":{"schema":{"required":["prompt","language","number_paragraphs"],"properties":{"prompt":{"description":"Prompt to be used to generate the LinkedIn message model (max 10000 characters)","type":"string","example":"My prompt"},"language":{"description":"LinkedIn message model language code - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"number_paragraphs":{"description":"Number of paragraphs (max 4)","type":"integer","example":1},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["content"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"content":{"description":"Display the content","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/sms":{"get":{"tags":["Models - SMS"],"summary":"Fetch list","description":"Retrieve the list of SMS models, including those shared to you","operationId":"ModelsSMSFetchList","parameters":[{"name":"only_shared_with_reseller_customers","in":"query","description":"If true, only items shared with reseller customers will be shown, if null all items are returned","required":false,"schema":{"type":"boolean","nullable":true,"default":null}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["models_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"models_list":{"description":"Displays the list of your SMS models","type":"array","items":{"$ref":"#\/components\/schemas\/ModelsSmsResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Models - SMS"],"summary":"Create a SMS model","description":"Create a SMS model","operationId":"ModelsSMSCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name","text"],"properties":{"name":{"description":"SMS model name","type":"string","example":"My SMS model"},"sender":{"description":"Sender name. Leave empty, null or omit to send without sender.<br>When provided:<br>\u2022 Between 4 and 11 characters.<br>\u2022 Numbers between 0 and 9.<br>\u2022 Only numbers\/letters without accent.<br>\u2022 No special characters.<br>\u2022 Not only numbers.","type":"string","example":"MySender","nullable":true},"text":{"description":"Content of your SMS.<br>\u2022 A SMS is limited to 136 characters, if you exceed this limit, \n                        the number of credits spent will be equivalent to the number of SMS sent.<br>\u2022 Emoji are strongly discouraged","type":"string","example":"Example of the content of my SMS"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the SMS model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidSenderException"},{"$ref":"#\/components\/schemas\/Models.EmptyTextException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsSmsException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/sms\/{model_id}":{"get":{"tags":["Models - SMS"],"summary":"Find profile","description":"Retrieve the profile of a SMS model","operationId":"ModelsSMSFindProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of SMS model to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsSmsItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Models - SMS"],"summary":"Update a SMS model","description":"Update a SMS model","operationId":"ModelsSMSUpdateProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of SMS model to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"SMS model name","type":"string","nullable":true},"sender":{"description":"Sender name. Omit or set null to keep the current sender, set empty string to send without sender.<br>When provided:<br>\u2022 Between 4 and 11 characters.<br>\u2022 Numbers between 0 and 9.<br>\u2022 Only numbers\/letters without accent.<br>\u2022 No special characters.<br>\u2022 Not only numbers.","type":"string","example":"MySender","nullable":true},"text":{"description":"Content of your SMS.<br>\u2022 A SMS is limited to 136 characters, if you exceed this limit, \n                        the number of credits spent will be equivalent to the number of SMS sent.<br>\u2022 Emoji are strongly discouraged","type":"string","example":"Example of the content of my SMS"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true},"pin":{"type":"boolean","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidSenderException"},{"$ref":"#\/components\/schemas\/Models.EmptyTextException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Models - SMS"],"summary":"Delete a SMS model","description":"Delete a SMS model","operationId":"ModelsSMSDelete","parameters":[{"name":"model_id","in":"path","description":"ID of SMS model to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/sms\/{model_id}\/copy":{"post":{"tags":["Models - SMS"],"summary":"Copy a SMS model","description":"Copy a SMS model","operationId":"ModelsSMSCopy","parameters":[{"name":"model_id","in":"path","description":"ID of SMS model to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the SMS model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsSmsException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/sms\/{model_id}\/copy\/to\/{user_id}":{"post":{"tags":["Models - SMS"],"summary":"Copy a SMS model to user ID","description":"Copy a SMS model to user ID","operationId":"ModelsSMSCopyTo","parameters":[{"name":"model_id","in":"path","description":"ID of SMS model to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of the user to copy the SMS model to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the SMS model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedCreateModelsSmsException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/smv":{"get":{"tags":["Models - SMV"],"summary":"Fetch list","description":"Retrieve the list of SMV models, including those shared to you","operationId":"ModelsSMVFetchList","parameters":[{"name":"only_shared_with_reseller_customers","in":"query","description":"If true, only items shared with reseller customers will be shown, if null all items are returned","required":false,"schema":{"type":"boolean","nullable":true,"default":null}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["models_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"models_list":{"description":"Displays the list of your SMV models","type":"array","items":{"$ref":"#\/components\/schemas\/ModelsSmvResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Models - SMV"],"summary":"Create a SMV model","description":"Create a SMV model","operationId":"ModelsSMVCreate","requestBody":{"content":{"multipart\/form-data":{"schema":{"required":["name","voice_file"],"properties":{"name":{"description":"SMV model name","type":"string","example":"My SMV model"},"voice_file":{"description":"The voice file must be in .WAV format and have a duration between 20 and 50 seconds.","type":"string","format":"binary"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1}},"folder_id":{"description":"Folder id","type":"integer","example":1}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the SMV model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyVoiceFileException"},{"$ref":"#\/components\/schemas\/InvalidVoiceFileException"},{"$ref":"#\/components\/schemas\/VoiceFileIncorrectLengthException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/smv\/{model_id}":{"get":{"tags":["Models - SMV"],"summary":"Find profile","description":"Retrieve the profile of a SMV model","operationId":"ModelsSMVFindProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of SMV model to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_profile":{"$ref":"#\/components\/schemas\/ModelsSmvItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Models - SMV"],"summary":"Update a SMV model","description":"Update a SMV model","operationId":"ModelsSMVUpdateProfileById","parameters":[{"name":"model_id","in":"path","description":"ID of SMV model to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"properties":{"name":{"description":"SMV model name","type":"string","nullable":true},"voice_file":{"description":"The voice file must be in .WAV format and have a duration between 20 and 50 seconds.","type":"string","format":"binary"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyVoiceFileException"},{"$ref":"#\/components\/schemas\/InvalidVoiceFileException"},{"$ref":"#\/components\/schemas\/VoiceFileIncorrectLengthException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Models - SMV"],"summary":"Delete a SMV model","description":"Delete a SMV model","operationId":"ModelsSMVDelete","parameters":[{"name":"model_id","in":"path","description":"ID of SMV model to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/smv\/{model_id}\/copy":{"post":{"tags":["Models - SMV"],"summary":"Copy a SMV model","description":"Copy a SMV model","operationId":"ModelsSMVCopy","parameters":[{"name":"model_id","in":"path","description":"ID of SMV model to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the SMV model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/models\/smv\/{model_id}\/copy\/to\/{user_id}":{"post":{"tags":["Models - SMV"],"summary":"Copy a SMV model to user ID","description":"Copy a SMV model to user ID","operationId":"ModelsSMVCopyTo","parameters":[{"name":"model_id","in":"path","description":"ID of SMV model to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of the user to copy the SMV model to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["model_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"model_id":{"description":"Display the SMV model ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Models.EmptyModelIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations":{"get":{"tags":["Organizations"],"summary":"Fetch list","description":"Retrieve the list of organizations","operationId":"OrganizationsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["organizations_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"organizations_list":{"description":"Displays the list of organizations","type":"array","items":{"$ref":"#\/components\/schemas\/OrganizationProfile"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Organizations"],"summary":"Create an organization","description":"Create an organization","operationId":"OrganizationsCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrganizationCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["organization_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"organization_id":{"description":"Display the organization ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations\/{organization_id}":{"get":{"tags":["Organizations"],"summary":"Find profile","description":"Retrieve the profile of an organization","operationId":"OrganizationsFindProfileById","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["organization_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"organization_profile":{"$ref":"#\/components\/schemas\/OrganizationProfile"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Organizations"],"summary":"Update profile","description":"Update an organization profile","operationId":"OrganizationsUpdateProfileById","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrganizationUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Organizations"],"summary":"Delete an organization","description":"Delete an organization","operationId":"OrganizationsDelete","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations\/{organization_id}\/users":{"get":{"tags":["Organizations"],"summary":"Fetch users list","description":"Retrieve the list of organization users","operationId":"OrganizationsFetchUsersListById","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["users_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"users_list":{"description":"Displays the list of organization users","type":"array","items":{"$ref":"#\/components\/schemas\/UserProfile"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations\/join":{"post":{"tags":["Organizations"],"summary":"Join an organization","description":"Join an organization","operationId":"OrganizationsJoin","requestBody":{"content":{"application\/json":{"schema":{"required":["organization_code"],"properties":{"organization_code":{"description":"Organization code","type":"string","example":"my Organization code"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["organization_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"organization_id":{"description":"Displays the ID of the organization you just joined","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/EmptyOrganizationCodeException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationCodeInvalidException"},{"$ref":"#\/components\/schemas\/AlreadyInOrganizationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"429":{"description":"Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TooManyAttemptsException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations\/{organization_id}\/leave":{"delete":{"tags":["Organizations"],"summary":"Leave an organization","description":"Leave an organization","operationId":"OrganizationsLeave","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations\/{organization_id}\/role\/{user_id}":{"put":{"tags":["Organizations"],"summary":"Update the role of an user","description":"Update the role of an user on an organization (for admins of the organization)","operationId":"OrganizationsRole","parameters":[{"name":"organization_id","in":"path","description":"ID of the organization","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of user to modify","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["role_id"],"properties":{"role_id":{"description":"Role id","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyRoleIdException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations\/{organization_id}\/invite":{"post":{"tags":["Organizations"],"summary":"Invite an user to an organization","description":"Invite an user to an organization","operationId":"OrganizationsInvite","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to invite","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["email"],"properties":{"email":{"type":"string","example":"email@example.org"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmailErrorException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}},"429":{"description":"Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TooManyAttemptsException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/organizations\/{organization_id}\/level\/{user_id}":{"put":{"tags":["Organizations"],"summary":"Update the level of a user","description":"Update the level of a user on an organization (for admins of the organization)","operationId":"OrganizationsLevel","parameters":[{"name":"organization_id","in":"path","description":"ID of the organization","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of user to modify","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["level"],"properties":{"level":{"$ref":"#\/components\/schemas\/OrganizationLevel"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh\/domain\/availability\/{domain}\/{external_api_key_id}":{"get":{"tags":["OVH"],"summary":"Check domain availability and price","description":"Check if a domain is available for purchase and return its price (excl. tax) and currency.","operationId":"OvhCheckDomainAvailabilityAndPrice","parameters":[{"name":"domain","in":"path","description":"Domain to check availability","required":true,"allowEmptyValue":false,"schema":{"type":"string"}},{"name":"external_api_key_id","in":"path","description":"ID of external api key","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["available"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"available":{"description":"True if the domain is available to purchase","type":"boolean","example":true},"price":{"description":"Price of the domain if available, null if unavailable","type":"number","format":"float","example":12.99,"nullable":true},"currency":{"description":"Currency of the price","type":"string","example":"EUR","nullable":true}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/ApiOvh.MissingApiCredentialsException"},{"$ref":"#\/components\/schemas\/ApiOvh.InvalidDomainFormatException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh\/account\/{external_api_key_id}\/validate-ordering-prerequisites":{"get":{"tags":["OVH"],"summary":"Check OVH account readiness for ordering","description":"Check if OVH account is ready to order (valid payment mean and email pro service)","operationId":"OvhValidateAccountOrderingPrerequisites","parameters":[{"name":"external_api_key_id","in":"path","description":"ID of external api key","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/ApiOvh.MissingApiCredentialsException"},{"$ref":"#\/components\/schemas\/ApiOvh.UserAccountNotReadyForOrderingException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh\/checkout":{"post":{"tags":["OVH"],"summary":"Order a domain and\/or associated email pro accounts","description":"Order a domain and\/or create email pro accounts associated with that domain.","operationId":"OvhCheckoutDomainAndEmails","requestBody":{"content":{"application\/json":{"schema":{"required":["domain"],"properties":{"domain":{"description":"Domain name to register or use for email accounts","type":"string","example":"domain.tld","nullable":false},"emails":{"description":"Optional list of email accounts to create on the specified domain","type":"array","items":{"$ref":"#\/components\/schemas\/ovhCheckoutEmails"},"nullable":true},"external_api_key_id":{"description":"ID of external api key","type":"integer","example":5,"nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/ApiOvh.MissingApiCredentialsException"},{"$ref":"#\/components\/schemas\/ApiOvh.UserAccountNotReadyForOrderingException"},{"$ref":"#\/components\/schemas\/ApiOvh.InvalidDomainFormatException"},{"$ref":"#\/components\/schemas\/ApiOvh.DomainNotAvailableException"},{"$ref":"#\/components\/schemas\/ApiOvh.InvalidEmailFormatException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/ApiOvh.UnauthorizedDomainException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"},{"$ref":"#\/components\/schemas\/ApiOvh.DomainDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh":{"get":{"tags":["OVH"],"summary":"Fetch list","description":"Displays the list of your OVH domains\/emails","operationId":"OvhFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"list":{"description":"Displays the list of your OVH domains\/emails","type":"array","items":{"$ref":"#\/components\/schemas\/ovhResultItems"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh\/domain\/{domain_id}":{"delete":{"tags":["OVH"],"summary":"Delete an OVH domain","description":"Delete an OVH domain from the database","operationId":"OvhDeleteDomain","parameters":[{"name":"domain_id","in":"path","description":"ID of domain to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiOvh.UnauthorizedDomainException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiOvh.DomainDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh\/email\/{email_id}":{"delete":{"tags":["OVH"],"summary":"Delete an OVH email account","description":"Delete an OVH email account from the database","operationId":"OvhDeleteEmail","parameters":[{"name":"email_id","in":"path","description":"ID of email to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiOvh.UnauthorizedDomainException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ApiOvh.DomainDoesNotExistException"},{"$ref":"#\/components\/schemas\/ApiOvh.EmailDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh\/sync-assets":{"post":{"tags":["OVH"],"summary":"Sync OVH domains\/emails","description":"Import domains and email pro accounts from OVH.","operationId":"OvhSyncAssets","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["external_api_key_id"],"properties":{"external_api_key_id":{"description":"ID of external api key","type":"integer","example":5,"nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/ApiOvh.MissingApiCredentialsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/ovh\/sync-assets\/{external_api_key_id}\/results":{"get":{"tags":["OVH"],"summary":"Fetch sync-assets job results","description":"List job results for OVH sync-assets operations","operationId":"OvhSyncAssetsResults","parameters":[{"name":"external_api_key_id","in":"path","description":"ID of the external API key used to sync assets","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["jobs_results"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"jobs_results":{"description":"List of sync-assets job result details","type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidApiKeyException"},{"$ref":"#\/components\/schemas\/EmptyExternalAPiKeyIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts":{"get":{"tags":["PRM"],"summary":"Fetch the contacts of your PRM","description":"Retrieve the contacts of your PRM<br>Allowed field_name for filter\/sort: id (contact id), status, custom_status, is_positive, created_on, score, status_changed_date, all data fields ids,\n        any_datafield (to search on all datafields, can\\'t be used on sort), last_link_click,\n        last_email_open, last_email_answered, last_linkedin_invitation_accepted, last_linkedin_message_answered, last_call,\n        last_sms_got, last_sms_not_got, last_reply, last_reply_or_status_changed_date, programmation_id\/workflow_id\/contact_list_id (cannot be used on sort),\n        status_from_programmation (in the format \"status_id of programmation\", cannot be used on sort),\n        integration_id (cannot be used on sort, using \"equals\" only), call_created_by (cannot be used on sort, using \"equals\" only), person_in_charge,\n        company_has_person_in_charge\/phone_has_person_in_charge\/in_active_programmation\/contacted_linkedin\/contacted_email (only with equals, not on sort, value can be only 0 or 1),\n        link_click (cannot be used on sort, using \"equals\" only), tag_id (cannot be used on sort, using \"equals\/not_equals\/does_exist\/does_not_exist\" only), last_note_date, notes (cannot be used on sort),\n        status_change_count (in the format \"date start_date end_amount to compare\", example \"2025-04-01_2025-05-01_2\", cannot be used on sort),\n        new_reply\/new_first_reply (only with equals, value can only be 0 or 1),\n        opener_step\/clicker_step\/answerer_step (only with equals, not with sort, value must be the step id),\n        email_open_count\/click_count (only with equals, not with sort, value must be an integer)\n        \n\nYou can use relative values (like -7 days, -4 hours, +4 hours or +1 week 2 hours by example) for the fields date_event, last_reply, status_changed_date, created_on, and those starting with \"last_\"","operationId":"PRMFetchContacts","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"3"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of your PRM","type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["PRM"],"summary":"Import contact into your PRM","description":"Import contact into your PRM","operationId":"PRMImportContact","requestBody":{"content":{"application\/json":{"schema":{"required":["contact","status"],"properties":{"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}},"status":{"$ref":"#\/components\/schemas\/PRMContactStatus"},"custom_status":{"type":"integer"},"person_in_charge":{"type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_id":{"description":"Display the contact ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMEmptyProperties"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/PRMIncorrectStatus"},{"$ref":"#\/components\/schemas\/PRMCustomStatusDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMContactAlreadyExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedCustomStatus"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["PRM"],"summary":"Delete contacts from your PRM","description":"Delete contacts from your PRM","operationId":"PRMDeleteContacts","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/user\/{user_id}":{"get":{"tags":["PRM"],"summary":"Fetch contacts of a PRM","description":"Retrieve the contacts of the PRM of another user<br>Allowed field_name for filter\/sort: id (contact id), status, \n        custom_status, is_positive, created_on, score, status_changed_date, all data fields ids, any_datafield (to search on all datafields, can't be used on sort), last_link_click,\n        last_email_open, last_email_answered, last_linkedin_invitation_accepted, last_linkedin_message_answered, last_call,\n        last_sms_got, last_sms_not_got, last_reply, last_reply_or_status_changed_date, programmation_id\/workflow_id\/contact_list_id (cannot be used on sort),\n        status_from_programmation (in the format \"status_id of programmation\", cannot be used on sort),\n        integration_id (cannot be used on sort, using \"equals\" only), call_created_by (cannot be used on sort, using \"equals\" only), person_in_charge,\n        link_click (cannot be used on sort, using \"equals\" only),\n        company_has_person_in_charge\/phone_has_person_in_charge\/in_active_programmation\/contacted_linkedin\/contacted_email (only with equals, not on sort, value can be only 0 or 1),\n        tag_id (cannot be used on sort, using \"equals\/not_equals\/does_exist\/does_not_exist\" only), last_note_date, notes (cannot be used on sort),\n        status_change_count (in the format \\\"date start_date end_amount to compare\\\", example \\\"2025-04-01_2025-05-01_2\\\", cannot be used on sort),\n        new_reply\/new_first_reply (only with equals, value can only be 0 or 1),\n        opener_step\/clicker_step\/answerer_step (only with equals, not with sort, value must be the step id),\n        email_open_count\/click_count (only with equals, not with sort, value must be an integer)\n        <br><br>\n        You can use relative values (like -7 days, -4 hours, +4 hours or +1 week 2 hours by example) for the fields date_event, last_reply, status_changed_date, created_on, and those starting with \"last_\"","operationId":"PRMFetchContactsByUserId","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"3"}},"type":"object"}},"type":"object"}]}}}},{"name":"user_id","in":"path","description":"User id of PRM","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of the PRM","type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["PRM"],"summary":"Import contact into a PRM","description":"Import contact into a PRM","operationId":"PRMImportContactByUserId","parameters":[{"name":"user_id","in":"path","description":"User id of PRM","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["contact","status"],"properties":{"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}},"status":{"$ref":"#\/components\/schemas\/PRMContactStatus"},"custom_status":{"type":"integer"},"person_in_charge":{"type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_id":{"description":"Display the contact ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMEmptyProperties"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/PRMIncorrectStatus"},{"$ref":"#\/components\/schemas\/PRMCustomStatusDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMContactAlreadyExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedCustomStatus"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPersonInCharge"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["PRM"],"summary":"Delete contacts from a PRM","description":"Delete contacts from a PRM","operationId":"PRMDeleteContactsByUserId","parameters":[{"name":"user_id","in":"path","description":"User id of PRM","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/users":{"get":{"tags":["PRM"],"summary":"Fetch contacts of multiple PRM","description":"Retrieve the contacts of the PRM from multiple users. The users should be in a team or organization that you are admin,\n        or they should be on a reseller where you are admin. It list all contacts, not just those shared.\n        <br>Same Allowed field_name for filter\/sort as \/prm\/contacts\/user\/{user_id}","operationId":"PRMFetchContactsFromMultipleUsers","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PRMPaginationOptionsUserIds"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"3"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of the PRM","type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/shared":{"get":{"tags":["PRM"],"summary":"Fetch the contacts of your PRM that you shared","description":"Retrieve the contacts of your PRM that you shared<br>Allowed field_name for filter\/sort: id (contact id), status, custom_status, is_positive, created_on, score, status_changed_date\n        all data fields ids, any_datafield (to search on all datafields, can't be used on sort), last_link_click,\n        last_email_open, last_email_answered, last_linkedin_invitation_accepted, last_linkedin_message_answered, last_call,\n        last_sms_got, last_sms_not_got, last_reply, last_reply_or_status_changed_date, programmation_id\/workflow_id\/contact_list_id (cannot be used on sort),\n        status_from_programmation (in the format \"status_id of programmation\", cannot be used on sort),\n        integration_id (cannot be used on sort, using \"equals\" only), call_created_by (cannot be used on sort, using \"equals\" only), person_in_charge,\n        link_click (cannot be used on sort, using \"equals\" only),\n        company_has_person_in_charge\/phone_has_person_in_charge\/in_active_programmation\/contacted_linkedin\/contacted_email (only with equals, not on sort, value can be only 0 or 1),\n        tag_id (cannot be used on sort, using \"equals\/not_equals\/does_exist\/does_not_exist\" only), last_note_date, notes (cannot be used on sort),\n        status_change_count (in the format \\\"date start_date end_amount to compare\\\", example \\\"2025-04-01_2025-05-01_2\\\", cannot be used on sort),\n        new_reply\/new_first_reply (only with equals, value can only be 0 or 1),\n        opener_step\/clicker_step\/answerer_step (only with equals, not with sort, value must be the step id),\n        email_open_count\/click_count (only with equals, not with sort, value must be an integer)\n        <br><br>\n        You can use relative values (like -7 days, -4 hours, +4 hours or +1 week 2 hours by example) for the fields date_event, last_reply, status_changed_date, created_on, and those starting with \"last_\"","operationId":"PRMFetchSharedContacts","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PRMPaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"3"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of your PRM","type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}":{"get":{"tags":["PRM"],"summary":"Find a contact profile","description":"Retrieve a contact profile","operationId":"PRMFetchContact","parameters":[{"name":"contact_id","in":"path","description":"ID of contact profile to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"set_new_reply_read","in":"query","description":"Set new_reply and new_first_reply to 0","required":false,"allowEmptyValue":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_profile":{"$ref":"#\/components\/schemas\/PRMContact"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMEmptyContactIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["PRM"],"summary":"Update a PRM contact","description":"Update a contact from a PRM","operationId":"PRMUpdateContact","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PRMContactUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/ContactInfoAlreadyExistException"},{"$ref":"#\/components\/schemas\/PRMIncorrectStatus"},{"$ref":"#\/components\/schemas\/PRMCustomStatusDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedCustomStatus"},{"$ref":"#\/components\/schemas\/PRMCantDeleteAllFields"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPersonInCharge"},{"$ref":"#\/components\/schemas\/UnauthorizedTagException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/call":{"post":{"tags":["PRM"],"summary":"Create a PRM call from a contact","description":"Create a call from a PRM","operationId":"PRMCreateCall","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PRMContactCallCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"call_id":{"description":"Display the call ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/PRMInvalidCallType"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/call\/{call_id}":{"delete":{"tags":["PRM"],"summary":"Delete a PRM call from a contact","description":"Delete a call from a PRM","operationId":"PRMDeleteCall","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"call_id","in":"path","description":"ID of the PRM call","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedCall"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMCallDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/note":{"post":{"tags":["PRM"],"summary":"Create a PRM note from a contact","description":"Create a note from a PRM","operationId":"PRMCreateNote","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["note"],"properties":{"note":{"type":"string","example":"My note"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"note_id":{"description":"Display the note ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/note\/{note_id}":{"put":{"tags":["PRM"],"summary":"Update a PRM note from a contact","description":"Update a note from a PRM","operationId":"PRMUpdateNote","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"note_id","in":"path","description":"ID of the PRM note","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["note"],"properties":{"note":{"type":"string","example":"My note"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedNote"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMNoteDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["PRM"],"summary":"Delete a PRM note from a contact","description":"Delete a note from a PRM","operationId":"PRMDeleteNote","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"note_id","in":"path","description":"ID of the PRM note","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedCall"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMCallDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/reply\/{history_type_reply}\/{reply_id}":{"put":{"tags":["PRM"],"summary":"Mark a contact reply as positive\/negative or remove the mark","description":"Mark a contact reply as positive\/negative or remove the mark","operationId":"PRMSetReplyPositive","parameters":[{"name":"contact_id","in":"path","description":"ID of the contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"history_type_reply","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/HistoryTypeReply"}},{"name":"reply_id","in":"path","description":"ID of the reply","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["is_positive"],"properties":{"is_positive":{"type":"boolean","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedNote"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMNoteDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/programmation\/{programmation_id}\/step\/{step_id}":{"post":{"tags":["PRM"],"summary":"Manually progress a contact to an event after a call step","description":"Continue the prm contact to a step","operationId":"PRMContinueContactToStep","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"programmation_id","in":"path","description":"ID of the PRM programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of the step to continue to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"call_id":{"description":"Display the call ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMStepDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/exclude\/{workflow_id}":{"post":{"tags":["PRM"],"summary":"Exclude a PRM contact from a workflow","description":"Exclude a PRM contact from a workflow","operationId":"PRMExcludeContactWorkflow","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_id","in":"path","description":"ID of the workflow","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/exclude\/programmation\/{programmation_id}":{"post":{"tags":["PRM"],"summary":"Exclude a PRM contact from a programmation","description":"Exclude a PRM contact from a programmation","operationId":"PRMExcludeContactWorkflowProgrammation","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"programmation_id","in":"path","description":"ID of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/linkedin\/invitation":{"post":{"tags":["PRM"],"summary":"Send a linkedin invitation to a contact","description":"Send a linkedin invitation to a contact","operationId":"PRMContactLinkedinInvite","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["integration_id"],"properties":{"message":{"type":"string","nullable":true},"integration_id":{"type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/PRMContactWithoutLinkedinUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/linkedin\/message":{"post":{"tags":["PRM"],"summary":"Send a linkedin message to a contact","description":"Send a linkedin message to a contact","operationId":"PRMContactLinkedinMessage","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["integration_id"],"properties":{"message":{"description":"Message content. Can be empty or null if a file is attached.","type":"string","nullable":true},"integration_id":{"type":"integer"},"file_id":{"description":"ID of the file previously uploaded. Maximum 20MB.","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/PRMContactWithoutLinkedinUrlException"},{"$ref":"#\/components\/schemas\/Models.EmptyTextException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedFileException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/status":{"put":{"tags":["PRM"],"summary":"Update PRM contacts statuses","description":"Update the status of multiple contacts from a PRM","operationId":"PRMUpdateContactsStatus","requestBody":{"content":{"application\/json":{"schema":{"required":["user_id","contacts_selection"],"properties":{"user_id":{"description":"User id of PRM","type":"integer"},"contacts_selection":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true,"description":"Don't provide or put null to use the existing status"},"custom_status":{"description":"Put null to remove the custom status, don't provide to keep the existing one","type":"integer","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["updated_count"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"updated_count":{"type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/PRMIncorrectStatus"},{"$ref":"#\/components\/schemas\/PRMCustomStatusDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyContactIdsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedCustomStatus"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/new_reply":{"put":{"tags":["PRM"],"summary":"Update PRM contacts new reply","description":"Update the new reply of multiple contacts from a PRM","operationId":"PRMUpdateContactsNewReply","requestBody":{"content":{"application\/json":{"schema":{"required":["user_id","contacts_selection","new_reply"],"properties":{"user_id":{"description":"User id of PRM","type":"integer"},"contacts_selection":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"},"new_reply":{"description":"Set the new reply state of the contacts","type":"boolean","nullable":false},"new_first_reply":{"description":"Set the new first reply state of the contacts","type":"boolean","nullable":true,"default":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["updated_count"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"updated_count":{"type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactIdsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/contact-list\/{contact_list_id}\/add":{"post":{"tags":["PRM"],"summary":"Add contacts from a PRM to a contact list","description":"Add contacts from a PRM to a contact list","operationId":"PRMAddContactsToContactList","parameters":[{"name":"contact_list_id","in":"path","description":"ID of the contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["user_id","contacts_selection"],"properties":{"user_id":{"description":"User id of PRM","type":"integer"},"contacts_selection":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/sharings":{"get":{"tags":["PRM"],"summary":"Retrieve your PRM sharings","description":"Retrieve your PRM sharings","operationId":"PRMFetchSharings","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["sharings"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"sharings":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/SharingFilterResponse"},{"$ref":"#\/components\/schemas\/SharingContactResponse"}]}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["PRM"],"summary":"Create sharing","description":"Create a sharing on your PRM<br>Allowed field_name for filter: id (contact id), status, \n        custom_status, is_positive, created_on, score, status_changed_date, all data fields ids, last_link_click,\n        last_email_open, last_email_answered, last_linkedin_invitation_accepted, last_linkedin_message_answered, last_call,\n        last_sms_got, last_sms_not_got, last_reply","operationId":"PRMCreateSharing","requestBody":{"content":{"application\/json":{"schema":{"required":["sharing"],"properties":{"sharing":{"description":"Sharing","oneOf":[{"$ref":"#\/components\/schemas\/SharingFilter"},{"$ref":"#\/components\/schemas\/SharingContact"}]}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"sharing_id":{"description":"Display the sharing ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/sharings\/{sharing_id}":{"put":{"tags":["PRM"],"summary":"Update sharing","description":"Update a sharing on your PRM<br>Allowed field_name for filter: id (contact id), status, \n        custom_status, is_positive, created_on, score, status_changed_date, all data fields ids, last_link_click,\n        last_email_open, last_email_answered, last_linkedin_invitation_accepted, last_linkedin_message_answered, last_call,\n        last_sms_got, last_sms_not_got, last_reply","operationId":"PRMUpdateSharing","parameters":[{"name":"sharing_id","in":"path","description":"ID of the sharing","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["sharing"],"properties":{"sharing":{"description":"Sharing","oneOf":[{"$ref":"#\/components\/schemas\/SharingFilter"},{"$ref":"#\/components\/schemas\/SharingContact"}]}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/CantChangeSharingTypeException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"},{"$ref":"#\/components\/schemas\/UnauthorizedSharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/SharingDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["PRM"],"summary":"Delete sharing","description":"Delete a sharing from your PRM","operationId":"PRMDeleteSharing","parameters":[{"name":"sharing_id","in":"path","description":"ID of the sharing","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/SharingDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/status":{"get":{"tags":["PRM"],"summary":"Retrieve your PRM statuses","description":"Retrieve your PRM statuses","operationId":"PRMFetchStatus","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["status"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"status":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMStatusVisibility"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/status\/{status}":{"put":{"tags":["PRM"],"summary":"Update a PRM status","description":"Update a PRM status","operationId":"PRMUpdateStatus","parameters":[{"name":"status","in":"path","description":"Status","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/PRMContactStatus"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/StatusVisibilityUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedCustomStatus"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMIncorrectStatus"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/status\/custom":{"get":{"tags":["PRM"],"summary":"Retrieve your PRM custom statuses","description":"Retrieve your PRM custom statuses","operationId":"PRMFetchCustomStatus","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["status"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"status":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactCustomStatus"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["PRM"],"summary":"Create a PRM custom status","description":"Create a PRM custom status","operationId":"PRMCreateCustomStatus","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomStatusCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["status_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"status_id":{"type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/PRMInvalidColorException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/status\/custom\/{status_id}":{"put":{"tags":["PRM"],"summary":"Update a PRM custom status","description":"Update a PRM custom status","operationId":"PRMUpdateCustomStatus","parameters":[{"name":"status_id","in":"path","description":"ID of the custom status","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomStatusUpdate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["status_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"status_id":{"type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedCustomStatus"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMCustomStatusDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["PRM"],"summary":"Delete a PRM custom status","description":"Delete a custom status from your PRM. Default statuses cannot be deleted","operationId":"PRMDeleteCustomStatus","parameters":[{"name":"status_id","in":"path","description":"ID of the custom status","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMCantDeleteDefaultCustomStatusException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedCustomStatus"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMCustomStatusDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/list":{"get":{"tags":["PRM"],"summary":"List visible PRM","description":"List the users from which you have access to their PRM","operationId":"PRMListVisiblePRM","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["prm"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"prm":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMListed"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/export\/{file_type}":{"post":{"tags":["PRM"],"summary":"Export the contacts of your PRM","description":"Retrieve the contacts of your PRM<br>The allowed field_name for filter are the same than for fetch contacts","operationId":"PRMExportContacts","parameters":[{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of your PRM","type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/user\/{user_id}\/export\/{file_type}":{"post":{"tags":["PRM"],"summary":"Export contacts of a PRM","description":"Retrieve the contacts of the PRM of another user<br>The allowed field_name for filter are the same than for fetch contacts","operationId":"PRMExportContactsByUserId","parameters":[{"name":"user_id","in":"path","description":"User id of PRM","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of the PRM","type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/user\/{user_id}\/tags":{"post":{"tags":["PRM"],"summary":"Add tags to contacts of a PRM","description":"Add tags to contacts of a PRM","operationId":"PRMAddTagsToContactsByUserId","parameters":[{"name":"user_id","in":"path","description":"User id of PRM","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/prm.ContactsSelection"},{"required":["tag_ids"],"properties":{"tag_ids":{"description":"Array of tag IDs to add to the selected contacts","type":"array","items":{"type":"integer"}}},"type":"object"}]}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["contacts_updated"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contacts_updated":{"description":"Displays the number of contacts that were updated with the new tags","type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/UnauthorizedTagException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["PRM"],"summary":"Remove tags from contacts of a PRM","description":"Remove tags from contacts of a PRM","operationId":"PRMRemoveTagsFromContactsByUserId","parameters":[{"name":"user_id","in":"path","description":"User id of PRM","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/prm.ContactsSelection"},{"required":["tag_ids"],"properties":{"tag_ids":{"description":"Array of tag IDs to remove from the selected contacts","type":"array","items":{"type":"integer"}}},"type":"object"}]}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["tags_removed"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"tags_removed":{"description":"Number of tag associations that were actually removed from the selected contacts","type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/UnauthorizedTagException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/user\/{user_id}\/enrich\/external\/{enrich_external_api}\/{external_api_key_id}":{"post":{"tags":["PRM"],"summary":"Enrich the prm using an external api","description":"Enrich the prm using an external api. Available enrichments :\n- Kaspr : Using contact LinkedIn url and name, get a phone number\n- Dropcontact : Using contact name and company, or LinkedIn url, get an email address and phone number\n- ContactOut : Using contact LinkedIn url, get an email address","operationId":"PrmEnrichExternalApiUser","parameters":[{"name":"user_id","in":"path","description":"prm user id","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"enrich_external_api","in":"path","description":"Type of enrichment","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/contactlists.enrichexternalapi"}},{"name":"external_api_key_id","in":"path","description":"ID of external api key","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidApiKeyException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/enrich\/external\/{enrich_external_api}\/{external_api_key_id}":{"post":{"tags":["PRM"],"summary":"Enrich the prm using an external api","description":"Enrich the prm using an external api. Available enrichments :\n- Kaspr : Using contact LinkedIn url and name, get a phone number\n- Dropcontact : Using contact name and company, or LinkedIn url, get an email address and phone number\n- ContactOut : Using contact LinkedIn url, get an email address","operationId":"PrmEnrichExternalApi","parameters":[{"name":"enrich_external_api","in":"path","description":"Type of enrichment","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/contactlists.enrichexternalapi"}},{"name":"external_api_key_id","in":"path","description":"ID of external api key","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidApiKeyException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedExternalApiKeyException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ExternalApiKeyDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/nurturing":{"post":{"tags":["PRM"],"summary":"Create a PRM nurturing","description":"Create a PRM nurturing","operationId":"PRMCreateNurturing","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/NurturingCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"nurturing_id":{"description":"Display the nurturing ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactList.EmptyContactListIdsException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/nurturings":{"get":{"tags":["PRM"],"summary":"Get PRM nurturings","description":"Get PRM nurturings","operationId":"PRMGetNurturings","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["nurturings"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"nurturings":{"type":"array","items":{"$ref":"#\/components\/schemas\/NurturingResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/nurturing\/{nurturing_id}":{"get":{"tags":["PRM"],"summary":"Get a PRM nurturing","description":"Get a PRM nurturing","operationId":"PRMGetNurturing","parameters":[{"name":"nurturing_id","in":"path","description":"ID of the PRM nurturing","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["nurturing"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"nurturing":{"$ref":"#\/components\/schemas\/NurturingItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedNurturing"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMNurturingDoesNotExist"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["PRM"],"summary":"Update a PRM nurturing","description":"Update a PRM nurturing","operationId":"PRMUpdateNurturing","parameters":[{"name":"nurturing_id","in":"path","description":"ID of the PRM nurturing","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/NurturingUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactList.EmptyContactListIdsException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedNurturing"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMNurturingDoesNotExist"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["PRM"],"summary":"Delete a PRM nurturing","description":"Delete a PRM nurturing","operationId":"PRMDeleteNurturing","parameters":[{"name":"nurturing_id","in":"path","description":"ID of the PRM nurturing","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactList.EmptyContactListIdsException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedNurturing"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMNurturingDoesNotExist"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/enrich\/phone\/mobile":{"post":{"tags":["PRM"],"summary":"Enrich a contact phone number","description":"Enrich a contact phone number","operationId":"PRMContactEnrichMobilePhone","parameters":[{"name":"contact_id","in":"path","description":"Contact ID to enrich","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"mobile_phone":{"description":"Displays mobile phone number if found","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/reply\/{history_type_reply}\/{reply_id}\/suggest-reply":{"post":{"tags":["PRM"],"summary":"Generate a suggested reply using AI","description":"Generate a suggested reply using AI for a contact","operationId":"PRMSuggestReply","parameters":[{"name":"contact_id","in":"path","description":"ID of the contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"history_type_reply","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/HistoryTypeReply"}},{"name":"reply_id","in":"path","description":"ID of the reply","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["number_paragraphs","language"],"properties":{"prompt":{"description":"Prompt to generate the suggested reply using AI (max 10000 characters)","type":"string","example":"My prompt","nullable":true},"language":{"description":"Language code of the suggested reply - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"number_paragraphs":{"description":"Number of paragraphs (max 4)","type":"integer","example":1},"temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["content"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"content":{"description":"Display the content","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/InvalidTemperatureException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/MaxDatafieldAiPerMonthReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedGenerateSuggestedAnswerAiException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMInvalidHistoryTypeReply"},{"$ref":"#\/components\/schemas\/PRMReplyDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/note\/{note_id}\/attachment":{"post":{"tags":["PRM"],"summary":"Upload note attachments","description":"Upload one or multiple attachments to a PRM note","operationId":"PRMUploadNoteAttachments","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"note_id","in":"path","description":"ID of the PRM note","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["attachments[]"],"properties":{"attachments[]":{"description":"Files to upload. Max 10 files, 10MB each","type":"array","items":{"type":"string","format":"binary"}}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"type":"object"},{"properties":{"attachment_ids":{"description":"IDs of uploaded attachments","type":"array","items":{"type":"integer"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/UnauthorizedFileFormatException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedNote"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMNoteDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/note\/{note_id}\/attachments":{"get":{"tags":["PRM"],"summary":"Get note attachments","description":"List attachments of a PRM note","operationId":"PRMListNoteAttachments","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"note_id","in":"path","description":"ID of the PRM note","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/NoteAttachment"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMNoteDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contact\/{contact_id}\/note\/{note_id}\/attachment\/{attachment_id}":{"delete":{"tags":["PRM"],"summary":"Delete note attachment","description":"Delete an attachment from a PRM note","operationId":"PRMDeleteNoteAttachment","parameters":[{"name":"contact_id","in":"path","description":"ID of the PRM contact","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"note_id","in":"path","description":"ID of the PRM note","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"attachment_id","in":"path","description":"ID of the attachment","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMNoteDoesNotExistException"},{"$ref":"#\/components\/schemas\/Files.FileDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/contacts\/import":{"post":{"tags":["PRM"],"summary":"Import contacts","description":"Import or update contacts in a PRM. If contact email or LinkedIn URL already exist on a contact, it will not be updated (you must add their ID). Otherwise, a new contact will be created.","operationId":"PRMImportContacts","requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["contacts"],"properties":{"contacts":{"description":"Contacts to import in the form of a JSON file, containing an array of ContactImport objects (one per line in JSON Lines format). Limitation: The import of contacts is limited to 1000000 contacts per API call.","type":"string","format":"binary"},"ignore_errors":{"description":"Ignore data with errors instead of stopping the import","type":"boolean","default":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyContactsException"},{"$ref":"#\/components\/schemas\/InvalidContactsFileException"},{"$ref":"#\/components\/schemas\/ImportLimitExceededException"},{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/prm\/notifications\/column-entry":{"get":{"tags":["PRM"],"summary":"Retrieve PRM column-entry notification watchlist","description":"Retrieve watched PRM columns for column-entry notifications","operationId":"PRMGetColumnEntryNotificationWatchlist","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["watched_columns"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"watched_columns":{"type":"array","items":{"type":"string"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["PRM"],"summary":"Replace PRM column-entry notification watchlist","description":"Replace watched PRM columns for column-entry notifications","operationId":"PRMReplaceColumnEntryNotificationWatchlist","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["watched_columns"],"properties":{"watched_columns":{"description":"Array of column keys. Each item must be either \"status:<status_value>\" or \"custom:<custom_status_id>\". Example: [\"status:opener\",\"custom:12\"].","type":"array","items":{"type":"string","example":"status:opener"},"example":["status:opener","custom:12"]}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":[],"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":[],"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataValidationException"},{"$ref":"#\/components\/schemas\/PRMCustomStatusDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/permissions\/{permission_name}\/{user_id}":{"put":{"tags":["Permissions"],"summary":"Update a user permission","description":"Update a user permission","operationId":"PermissionsUpdateUserPermission","parameters":[{"name":"permission_name","in":"path","description":"Name of permission to update","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/PermissionNames"}},{"name":"user_id","in":"path","description":"ID of the user to update permission","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["value"],"properties":{"value":{"description":"Permission value","oneOf":[{"description":"Permission value as integer","type":"integer","example":5,"nullable":false},{"description":"Permission value as boolean","type":"boolean","example":true,"nullable":false}]}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidPermissionValueException"},{"$ref":"#\/components\/schemas\/EmptyPermissionNameException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/PermissionDoesNotExistException"},{"$ref":"#\/components\/schemas\/Permissions.PermissionValueLimitReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPermissionException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifyThisPermissionValueException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PermissionDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Permissions"],"summary":"Delete a permission","description":"Delete a permission","operationId":"PermissionsDelete","parameters":[{"name":"permission_name","in":"path","description":"Name of permission to delete","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/PermissionNames"}},{"name":"user_id","in":"path","description":"ID of the user to delete permission","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyPermissionNameException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/PermissionDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPermissionException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PermissionDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/permissions":{"get":{"tags":["Permissions"],"summary":"Fetch list","description":"Retrieve the list of your permissions","operationId":"PermissionsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["permissions_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"permissions_list":{"description":"Displays the list of your permissions","type":"array","items":{"$ref":"#\/components\/schemas\/PermissionItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/permissions\/{user_id}":{"get":{"tags":["Permissions"],"summary":"Fetch list of a user","description":"Retrieve a user list of permissions","operationId":"PermissionsFetchListUserId","parameters":[{"name":"user_id","in":"path","description":"User ID to retrieve permissions list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["permissions_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"permissions_list":{"description":"Displays list of user permissions","type":"array","items":{"$ref":"#\/components\/schemas\/PermissionItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPermissionException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PermissionDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Permissions"],"summary":"Batch update user permissions","description":"Update multiple permissions for a user","operationId":"PermissionsUpdateUserPermissions","parameters":[{"name":"user_id","in":"path","description":"ID of the user to update permissions","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["permissions"],"properties":{"permissions":{"description":"Permissions to update","type":"array","items":{"$ref":"#\/components\/schemas\/UpdatePermissions"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidPermissionValueException"},{"$ref":"#\/components\/schemas\/EmptyPermissionNameException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/PermissionDoesNotExistException"},{"$ref":"#\/components\/schemas\/Permissions.PermissionValueLimitReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPermissionException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifyThisPermissionValueException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PermissionDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/pools":{"get":{"tags":["Pools"],"summary":"Fetch list","description":"Retrieve the list of pools, including those shared to you","operationId":"PoolsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["pools_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"pools_list":{"description":"Displays the list of your pools","type":"array","items":{"$ref":"#\/components\/schemas\/PoolResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Pools"],"summary":"Create a pool","description":"Create a pool","operationId":"PoolsCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name","type"],"properties":{"name":{"description":"Pool name","type":"string","example":"My pool"},"type":{"$ref":"#\/components\/schemas\/poolsPoolType"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"auto_remove_enabled":{"type":"boolean","default":false},"reputation_threshold":{"type":"integer","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["pool_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"pool_id":{"description":"Display the pool ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyTypeException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/pools\/{pool_id}":{"get":{"tags":["Pools"],"summary":"Find profile","description":"Retrieve the profile of a pool","operationId":"PoolsFindProfileById","parameters":[{"name":"pool_id","in":"path","description":"ID of pool to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["pool_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"pool_profile":{"$ref":"#\/components\/schemas\/PoolItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyPoolIdException"},{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPoolException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Pools"],"summary":"Update profile","description":"Update a pool profile","operationId":"PoolsUpdateProfileById","parameters":[{"name":"pool_id","in":"path","description":"ID of pool to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Pool name","type":"string","example":"My pool","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"remove_emails_sharing":{"description":"If true and sharing is set to an empty array, also remove sharing from all email accounts in the pool","type":"boolean","nullable":true},"auto_remove_enabled":{"type":"boolean","nullable":true},"reputation_threshold":{"type":"integer","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyPoolIdException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPoolException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Pools"],"summary":"Delete a pool","description":"Delete a pool","operationId":"PoolsDelete","parameters":[{"name":"pool_id","in":"path","description":"ID of pool to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyPoolIdException"},{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPoolException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/pools\/{pool_id}\/{integration_id}":{"post":{"tags":["Pools"],"summary":"Add an integration in the pool","description":"Add an integration in the pool","operationId":"PoolsAddIntegration","parameters":[{"name":"pool_id","in":"path","description":"ID of pool to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"integration_id","in":"path","description":"ID of integration to add","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyPoolIdException"},{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/MassMailingTypeNotAllowed"},{"$ref":"#\/components\/schemas\/PoolTypeNotEmailException"},{"$ref":"#\/components\/schemas\/PoolTypeNotLinkedinException"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPoolException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Pools"],"summary":"Remove an integration in the pool","description":"Remove an integration in the pool","operationId":"PoolsRemoveIntegration","parameters":[{"name":"pool_id","in":"path","description":"ID of pool to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"integration_id","in":"path","description":"ID of integration to remove","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyPoolIdException"},{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/MassMailingTypeNotAllowed"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedin.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedPoolException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/reporting\/reports":{"get":{"tags":["Reporting"],"summary":"Fetch list of reports","description":"Fetch list of reports","operationId":"ReportingFetchListReport","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["reports"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"reports":{"description":"Displays the list of your reports","type":"array","items":{"$ref":"#\/components\/schemas\/ReportingReportResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/reporting\/report\/{report_id}":{"get":{"tags":["Reporting"],"summary":"Retrieve a report","description":"Retrieve a report","operationId":"ReportingFindReportById","parameters":[{"name":"report_id","in":"path","description":"ID of report to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["report_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"report_profile":{"$ref":"#\/components\/schemas\/ReportingReportItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyReportIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedReportException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ReportDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Reporting"],"summary":"Update report","description":"Update a report","operationId":"ReportingReportUpdate","parameters":[{"name":"report_id","in":"path","description":"ID of report to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ReportUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyReportIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedReportException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ReportDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Reporting"],"summary":"Delete a report","description":"Delete a report","operationId":"ReportingReportDelete","parameters":[{"name":"report_id","in":"path","description":"ID of report to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyReportIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedReportException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ReportDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/reporting\/report":{"post":{"tags":["Reporting"],"summary":"Create a report","description":"Create a report","operationId":"ReportingCreateReport","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ReportCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"report_id":{"description":"Display the report ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidChartTypeException"},{"$ref":"#\/components\/schemas\/InvalidXAxisException"},{"$ref":"#\/components\/schemas\/InvalidYAxisException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers":{"post":{"tags":["Resellers"],"summary":"Create a reseller. Users of your reseller will need to use your domain_saas\/domain_saas2\/domain_saas3","description":"Create a reseller","operationId":"ResellersCreate","requestBody":{"content":{"multipart\/form-data":{"schema":{"$ref":"#\/components\/schemas\/ResellerCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["reseller_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"reseller_id":{"description":"Display the reseller ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyDomainSaasException"},{"$ref":"#\/components\/schemas\/IncorrectDomainSaasException"},{"$ref":"#\/components\/schemas\/IncorrectDomainSaas2Exception"},{"$ref":"#\/components\/schemas\/IncorrectDomainSaas3Exception"},{"$ref":"#\/components\/schemas\/IncorrectDomainFilesException"},{"$ref":"#\/components\/schemas\/IncorrectDomainRedirectException"},{"$ref":"#\/components\/schemas\/IncorrectDomainApiException"},{"$ref":"#\/components\/schemas\/DomainSaasUsedException"},{"$ref":"#\/components\/schemas\/DomainFilesUsedException"},{"$ref":"#\/components\/schemas\/DomainRedirectUsedException"},{"$ref":"#\/components\/schemas\/DomainApiUsedException"},{"$ref":"#\/components\/schemas\/DomainMustDifferentException"},{"$ref":"#\/components\/schemas\/IncorrectEmailAccountTypeException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedLogoFormatException"},{"$ref":"#\/components\/schemas\/LogoMenuSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedLogoMenuFormatException"},{"$ref":"#\/components\/schemas\/FaviconSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedFaviconFormatException"},{"$ref":"#\/components\/schemas\/IncorrectMutedColorException"},{"$ref":"#\/components\/schemas\/IncorrectPrimaryTextColorException"},{"$ref":"#\/components\/schemas\/IncorrectSecondaryTextColorException"},{"$ref":"#\/components\/schemas\/IncorrectPrimaryColorException"},{"$ref":"#\/components\/schemas\/IncorrectSecondaryColorException"},{"$ref":"#\/components\/schemas\/IncorrectLinkChromeExtensionException"},{"$ref":"#\/components\/schemas\/IncorrectSsoAuthorizationUrlException"},{"$ref":"#\/components\/schemas\/IncorrectSsoTokenUrlException"},{"$ref":"#\/components\/schemas\/IncorrectSsoUserinfoUrlException"},{"$ref":"#\/components\/schemas\/IncorrectBookDemoException"},{"$ref":"#\/components\/schemas\/IncorrectPricingUrlException"},{"$ref":"#\/components\/schemas\/IncorrectContactSupportException"},{"$ref":"#\/components\/schemas\/Resellers.NumberResellersReachedException"},{"$ref":"#\/components\/schemas\/InvalidTermsOfSaleFormatException"},{"$ref":"#\/components\/schemas\/TermsOfSalePdfTooLargeException"},{"$ref":"#\/components\/schemas\/PRMInvalidColorException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}":{"get":{"tags":["Resellers"],"summary":"Find profile by ID","description":"Retrieve the profile of a reseller","operationId":"ResellersFindProfileById","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["reseller_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"reseller_profile":{"$ref":"#\/components\/schemas\/ResellerProfile"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Resellers"],"summary":"Update profile","description":"Update a reseller profile","operationId":"ResellersUpdateProfileById","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"$ref":"#\/components\/schemas\/ResellerUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyDomainSaasException"},{"$ref":"#\/components\/schemas\/IncorrectDomainSaasException"},{"$ref":"#\/components\/schemas\/IncorrectDomainSaas2Exception"},{"$ref":"#\/components\/schemas\/IncorrectDomainSaas3Exception"},{"$ref":"#\/components\/schemas\/IncorrectDomainFilesException"},{"$ref":"#\/components\/schemas\/IncorrectDomainRedirectException"},{"$ref":"#\/components\/schemas\/IncorrectDomainApiException"},{"$ref":"#\/components\/schemas\/DomainSaasUsedException"},{"$ref":"#\/components\/schemas\/DomainFilesUsedException"},{"$ref":"#\/components\/schemas\/DomainRedirectUsedException"},{"$ref":"#\/components\/schemas\/DomainApiUsedException"},{"$ref":"#\/components\/schemas\/DomainMustDifferentException"},{"$ref":"#\/components\/schemas\/IncorrectEmailAccountTypeException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/LogoSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedLogoFormatException"},{"$ref":"#\/components\/schemas\/LogoMenuSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedLogoMenuFormatException"},{"$ref":"#\/components\/schemas\/FaviconSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedFaviconFormatException"},{"$ref":"#\/components\/schemas\/IncorrectMutedColorException"},{"$ref":"#\/components\/schemas\/IncorrectPrimaryTextColorException"},{"$ref":"#\/components\/schemas\/IncorrectSecondaryTextColorException"},{"$ref":"#\/components\/schemas\/IncorrectPrimaryColorException"},{"$ref":"#\/components\/schemas\/IncorrectSecondaryColorException"},{"$ref":"#\/components\/schemas\/IncorrectLinkChromeExtensionException"},{"$ref":"#\/components\/schemas\/IncorrectSsoAuthorizationUrlException"},{"$ref":"#\/components\/schemas\/IncorrectSsoTokenUrlException"},{"$ref":"#\/components\/schemas\/IncorrectSsoUserinfoUrlException"},{"$ref":"#\/components\/schemas\/IncorrectBookDemoException"},{"$ref":"#\/components\/schemas\/IncorrectPricingUrlException"},{"$ref":"#\/components\/schemas\/IncorrectContactSupportException"},{"$ref":"#\/components\/schemas\/InvalidTermsOfSaleFormatException"},{"$ref":"#\/components\/schemas\/TermsOfSalePdfTooLargeException"},{"$ref":"#\/components\/schemas\/PRMInvalidColorException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Resellers"],"summary":"Delete a reseller","description":"Delete a reseller","operationId":"ResellersDelete","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_domain_saas}":{"get":{"tags":["Resellers"],"summary":"Find profile by domain saas","description":"Retrieve the profile of a reseller","operationId":"ResellersFindProfileByDomainSaas","parameters":[{"name":"reseller_domain_saas","in":"path","description":"Domain SAAS of reseller to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["reseller_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"reseller_profile":{"$ref":"#\/components\/schemas\/ResellerProfile"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyDomainSaasException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/users":{"get":{"tags":["Resellers"],"summary":"Fetch users list by ID","description":"Retrieve the list of reseller users","operationId":"ResellersFetchUsersListById","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"include_teams","in":"query","description":"Include teams in the response","required":false,"schema":{"type":"boolean"}},{"name":"include_organizations","in":"query","description":"Include organizations in the response","required":false,"schema":{"type":"boolean"}},{"name":"include_resellers","in":"query","description":"Include resellers in the response","required":false,"schema":{"type":"boolean"}},{"name":"include_actions_required","in":"query","description":"Include actions required in the response","required":false,"schema":{"type":"boolean"}},{"name":"include_subscriptions","in":"query","description":"Include subscriptions in the response","required":false,"schema":{"type":"boolean"}},{"name":"only_shareable_permissions","in":"query","description":"Limit the permissions displayed in the response to those that can be shared with customers","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["users_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"users_list":{"description":"Displays the list of reseller users","type":"array","items":{"$ref":"#\/components\/schemas\/UserProfile"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_domain_saas}\/users":{"get":{"tags":["Resellers"],"summary":"Fetch users list by domain saas","description":"Retrieve the list of reseller users","operationId":"ResellersFetchUsersListByDomainSaas","parameters":[{"name":"reseller_domain_saas","in":"path","description":"Domain SAAS of reseller to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["users_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"users_list":{"description":"Displays the list of reseller users","type":"array","items":{"$ref":"#\/components\/schemas\/UserProfile"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyDomainSaasException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/role\/{user_id}":{"put":{"tags":["Resellers"],"summary":"Update the role of an user","description":"Update the role of an user on a reseller (for admins of the reseller)","operationId":"ResellersRole","parameters":[{"name":"reseller_id","in":"path","description":"ID of the reseller","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of user to modify","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["role_id"],"properties":{"role_id":{"description":"Role id","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyRoleIdException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/cnames":{"get":{"tags":["Resellers"],"summary":"Fetch list of our CNAMES","description":"Retrieve the list of our CNAMES domains to point your reseller domain.<br>Choose a single domain from the list and change your domain's DNS to CNAME type.","operationId":"ResellersFetchCnamesList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["cnames_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"cnames_list":{"description":"Displays the list of our CNAMES domains","type":"array","items":{"$ref":"#\/components\/schemas\/CnamesResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/dns-refresh-requests":{"post":{"tags":["Resellers"],"summary":"DNS refresh requests for reseller domains","description":"DNS refresh requests for reseller domains","operationId":"ResellersDnsRefreshRequests","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller to DNS refresh requests","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/download\/extension\/chrome":{"get":{"tags":["Resellers"],"summary":"Download extension for Chrome","description":"Download extension for Chrome","operationId":"ResellersDownloadChromeExtension","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyDomainSaasException"},{"$ref":"#\/components\/schemas\/EmptyLogoException"},{"$ref":"#\/components\/schemas\/EmptyLogoMenuException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/messages":{"get":{"tags":["Resellers"],"summary":"Get transactionnal base messages","description":"Returns default transactionnal messages","operationId":"getTransactionnalMessages","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/messages\/{reseller_id}":{"get":{"tags":["Resellers"],"summary":"Get transactionnal messages of a reseller, including base messages","description":"Returns both default and reseller-specific transactionnal messages","operationId":"getResellerTransactionnalMessages","parameters":[{"name":"reseller_id","in":"path","description":"Reseller ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["messages"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"messages":{"$ref":"#\/components\/schemas\/Messages"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/messages":{"post":{"tags":["Resellers"],"summary":"Create or update a transactionnal message for a reseller","description":"Allows resellers to customize email","operationId":"saveResellerTransactionnalMessage","parameters":[{"name":"reseller_id","in":"path","description":"Reseller ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name","type","language","subject","content"],"properties":{"name":{"description":"Type of transactionnal message","type":"string","example":"PasswordResetEmail","enum":["MailTestSmtpCredentials","MailValidationMassMailing","MailValidationMail","MailDisconnectedAPIEmailAccount","LinkedinDisconnected","OrganizationJoin","TeamJoin","PasswordResetEmail","AccountLocked","InviteUserOrganization","InviteUserTeam","PositiveReply","NeutralReply","NegativeReply","PrmColumnEntryInstant","PrmColumnEntryDailyDigest"]},"language":{"description":"ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string"},"subject":{"description":"Email subject.<br><br>Global placeholders available:<br>{resellerName}, {resellerDomainSaas}, {resellerDomainApi}, {resellerDomainFiles}, {resellerDomainRedirect}, {userName}<br><br>Optional placeholders per message type:<br>- `MailDisconnectedAPIEmailAccount`: {emailAccount}<br>- `LinkedinDisconnected`: {linkedinAccountName}<br>- `OrganizationJoin`: {userName}, {organizationName}<br>- `TeamJoin`: {userName}, {teamName}<br>- `PasswordResetEmail`: {resetCode}<br>- `AccountLocked`: {unlockCode}<br>- `InviteUserOrganization`: {userName}, {organizationName}<br>- `InviteUserTeam`: {userName}, {teamName}<br>- `PositiveReply`: {fullName}<br>- `NegativeReply`: {fullName}<br>- `NeutralReply`: {fullName}","type":"string","example":"Your password reset code : {resetCode}"},"content":{"description":"Email message content.<br><br>Global placeholders available:<br>{resellerName}, {resellerDomainSaas}, {resellerDomainApi}, {resellerDomainFiles}, {resellerDomainRedirect}, {userName}<br><br>Required placeholders per message type:<br>- `MailTestSmtpCredentials`: No specific placeholders required.<br>- `MailValidationMassMailing`: {validateUrl}<br>- `MailValidationMail`: {validateUrl}<br>- `MailDisconnectedAPIEmailAccount`: {emailAccount}, {reconnectUrl}<br>- `LinkedinDisconnected`: {linkedinAccountName}<br>- `OrganizationJoin`: {userName}, {organizationName}<br>- `TeamJoin`: {userName}, {teamName}<br>- `PasswordResetEmail`: {resetCode}<br>- `AccountLocked`: {unlockCode}<br>- `InviteUserOrganization`: {userName}, {organizationName}, {joinUrl}<br>- `InviteUserTeam`: {userName}, {teamName}<br>- `PositiveReply`: {replyURL}, {fullName}<br>- `NegativeReply`: {replyURL}, {fullName}<br>- `NeutralReply`: {replyURL}, {fullName}","type":"string","example":"Hello, here is the code to reset your password : {resetCode}"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidName"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/MissingMessagePlaceholders"},{"$ref":"#\/components\/schemas\/Resellers.EmptySubjectException"},{"$ref":"#\/components\/schemas\/Resellers.EmptyContentException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/users\/{user_id}":{"delete":{"tags":["Resellers"],"summary":"Delete reseller user","description":"Delete a user from a reseller","operationId":"ResellerUserDelete","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller","required":true,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of user to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/users\/{user_id}\/tags":{"put":{"tags":["Resellers"],"summary":"Update reseller user tags","description":"Update the list of tags assigned to a reseller user","operationId":"ResellerUserUpdateTags","parameters":[{"name":"reseller_id","in":"path","description":"ID of reseller","required":true,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of user to tag","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["tags_ids"],"properties":{"tags_ids":{"description":"List of tag IDs to assign to the user","type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/tutorial\/videos":{"get":{"tags":["Resellers"],"summary":"Get tutorial videos of a reseller","description":"Returns reseller-specific tutorial video URLs and optional thumbnail URLs","operationId":"getResellerTutorialVideos","parameters":[{"name":"reseller_id","in":"path","description":"Reseller ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["videos"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"videos":{"$ref":"#\/components\/schemas\/Video"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Resellers"],"summary":"Create, update or delete multiple tutorial videos for a reseller","description":"Set multiple tutorial video URLs and optional thumbnails in a single multipart request. If a video URL is an empty string, the corresponding video is deleted.","operationId":"saveResellerTutorialVideos","parameters":[{"name":"reseller_id","in":"path","description":"Reseller ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["videos"],"properties":{"videos":{"description":"JSON string containing an array of tutorial videos with keys name, url and optional remove_thumbnail.","type":"string","example":"[{\"name\":\"HomeWelcomeDemo\",\"url\":\"https:\/\/videos.example.com\/tutorials\/home-welcome\",\"remove_thumbnail\":false}]"},"thumbnails[HomeWelcomeDemo]":{"description":"Optional thumbnail file for HomeWelcomeDemo","type":"string","format":"binary"},"thumbnails[HomeSenderEmailConnectDemo]":{"description":"Optional thumbnail file for HomeSenderEmailConnectDemo","type":"string","format":"binary"},"thumbnails[HomeLinkedinAccountConnectDemo]":{"description":"Optional thumbnail file for HomeLinkedinAccountConnectDemo","type":"string","format":"binary"},"thumbnails[HomeListCreationDemo]":{"description":"Optional thumbnail file for HomeListCreationDemo","type":"string","format":"binary"},"thumbnails[HomeTemplateCreationDemo]":{"description":"Optional thumbnail file for HomeTemplateCreationDemo","type":"string","format":"binary"},"thumbnails[HomeCampaignCreationDemo]":{"description":"Optional thumbnail file for HomeCampaignCreationDemo","type":"string","format":"binary"},"thumbnails[ListsScrapingSourcesTutorial]":{"description":"Optional thumbnail file for ListsScrapingSourcesTutorial","type":"string","format":"binary"},"thumbnails[ListsScrapeLinkedinTutorial]":{"description":"Optional thumbnail file for ListsScrapeLinkedinTutorial","type":"string","format":"binary"},"thumbnails[ListsScrapeGoogleMapsTutorial]":{"description":"Optional thumbnail file for ListsScrapeGoogleMapsTutorial","type":"string","format":"binary"},"thumbnails[ListsScrapeLinkedinJobPostPublishersTutorial]":{"description":"Optional thumbnail file for ListsScrapeLinkedinJobPostPublishersTutorial","type":"string","format":"binary"},"thumbnails[ListsScrapeLinkedinLikersCommentersTutorial]":{"description":"Optional thumbnail file for ListsScrapeLinkedinLikersCommentersTutorial","type":"string","format":"binary"},"thumbnails[ListsLinkedinScrapeLinkedinTutorial]":{"description":"Optional thumbnail file for ListsLinkedinScrapeLinkedinTutorial","type":"string","format":"binary"},"thumbnails[ListsLinkedinScrapeJobPostPublishersTutorial]":{"description":"Optional thumbnail file for ListsLinkedinScrapeJobPostPublishersTutorial","type":"string","format":"binary"},"thumbnails[ListsLinkedinScrapingErrorTutorial]":{"description":"Optional thumbnail file for ListsLinkedinScrapingErrorTutorial","type":"string","format":"binary"},"thumbnails[ListsManualImportTutorial]":{"description":"Optional thumbnail file for ListsManualImportTutorial","type":"string","format":"binary"},"thumbnails[ListsGoogleMapsScrapeGoogleMapsTutorial]":{"description":"Optional thumbnail file for ListsGoogleMapsScrapeGoogleMapsTutorial","type":"string","format":"binary"},"thumbnails[LeadsTrackingZapierMakeSyncTutorial]":{"description":"Optional thumbnail file for LeadsTrackingZapierMakeSyncTutorial","type":"string","format":"binary"},"thumbnails[IntegrationOVHTutorial]":{"description":"Optional thumbnail file for IntegrationOVHTutorial","type":"string","format":"binary"},"thumbnails[IntegrationLinkedinConnectTutorial]":{"description":"Optional thumbnail file for IntegrationLinkedinConnectTutorial","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidName"},{"$ref":"#\/components\/schemas\/Resellers.IncorrectVideoUrlException"},{"$ref":"#\/components\/schemas\/UnauthorizedTutorialVideoThumbnailFormatException"},{"$ref":"#\/components\/schemas\/TutorialVideoThumbnailSizeExceededException"},{"$ref":"#\/components\/schemas\/InvalidTutorialVideoThumbnailRequestException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/options":{"get":{"tags":["Resellers"],"summary":"Get options of a reseller","description":"Returns reseller-specific options","operationId":"getResellerOptions","parameters":[{"name":"reseller_id","in":"path","description":"Reseller ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["options"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"type":"object"},{"properties":{"options":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResellerOption"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Resellers"],"summary":"Create or update multiple options for a reseller","description":"Set multiple options and their variables in a single request.","operationId":"saveResellerOptions","parameters":[{"name":"reseller_id","in":"path","description":"Reseller ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["options"],"properties":{"options":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResellerOption"}}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/resellers\/{reseller_id}\/messages\/table-columns\/prm-digest":{"put":{"tags":["Resellers"],"summary":"Configure table columns for PRM daily digest email","description":"Customize which columns appear in the PRM daily digest email table. The lead_id column is mandatory.","operationId":"configurePrmDigestTableColumns","parameters":[{"name":"reseller_id","in":"path","description":"Reseller ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["columns"],"properties":{"columns":{"description":"List of columns to display in the digest table. At least one column is required. The lead_id column is mandatory.","type":"array","items":{"required":["key","label"],"properties":{"key":{"description":"Column identifier","type":"string","enum":["contact_date","time","lead_id","lead_status","company","email","first_name","last_name","phone","mobile_phone","linkedin_link","conversation_link"]},"label":{"description":"Column label in English","type":"string"},"label_fr":{"description":"Column label in French (optional)","type":"string"}},"type":"object"},"example":[{"key":"contact_date","label":"Contact date","label_fr":"Date du contact"},{"key":"time","label":"Classification time","label_fr":"Heure classification"},{"key":"lead_id","label":"Lead ID","label_fr":"Lead ID"},{"key":"lead_status","label":"Lead status","label_fr":"Statut du lead"},{"key":"company","label":"Company","label_fr":"Soci\u00e9t\u00e9"},{"key":"email","label":"Email","label_fr":"Email"},{"key":"linkedin_link","label":"LinkedIn link","label_fr":"Lien LinkedIn"},{"key":"conversation_link","label":"Conversation link","label_fr":"Lien conversation"}]}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyResellerIdException"},{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidPrmDigestTableColumnsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/UnauthorizedPersonalizeTransactionalEmailsException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerDoesNotExistException"},{"$ref":"#\/components\/schemas\/TransactionalMessageDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/roles":{"get":{"tags":["Roles"],"summary":"Fetch list","description":"Retrieve the list of roles","operationId":"RolesFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["roles_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"roles_list":{"description":"Displays the list of your roles","type":"array","items":{"$ref":"#\/components\/schemas\/RoleResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Roles"],"summary":"Create a role","description":"Create a role","operationId":"RolesCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RoleCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["role_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"role_id":{"description":"Display the role ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/roles\/{role_id}":{"get":{"tags":["Roles"],"summary":"Find profile","description":"Retrieve the profile of a role","operationId":"RolesFindProfileById","parameters":[{"name":"role_id","in":"path","description":"ID of role to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["role_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"role_profile":{"$ref":"#\/components\/schemas\/RoleItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyRoleIdException"},{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedRoleException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Roles"],"summary":"Update profile","description":"Update a role profile","operationId":"RolesUpdateProfileById","parameters":[{"name":"role_id","in":"path","description":"ID of role to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RoleUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyRoleIdException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedRoleException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Roles"],"summary":"Delete a role","description":"Delete a role","operationId":"RolesDelete","parameters":[{"name":"role_id","in":"path","description":"ID of role to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyRoleIdException"},{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedRoleException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/programmations":{"get":{"tags":["Statistics"],"summary":"Fetch programmations statistics","description":"Retrieve the statistics of your programmations.<br>Allowed field_name for filter: id, created_on, workflow_id, date_start and the following field_name \n        should only be used with does_exist\/does_not_exist : contains_email_step, contains_smv_step, contains_sms_step,\n        contains_linkedin_message_step, contains_linkedin_invitation_step, contains_call_step<br>\n        Allowed field_name for sort : id, contacted, contacts_opened, contacts_clicked, contacts_answered, contacts_opened_rate, contacts_clicked_rate, contacts_answered_rate<br>\n        The rate field_name sort on the percentage instead of the number of unique contacts : contacts_opened_rate is contacts_opened out of contacted,\n        contacts_clicked_rate is contacts_clicked out of contacts_opened and contacts_answered_rate is contacts_answered out of contacts_opened.\n        A programmation whose rate cannot be computed (nothing contacted, or nobody opened) is sorted as 0<br><br>\n        You can use relative values (like -7 days, -4 hours, +4 hours or +1 week 2 hours by example) for the field date_start","operationId":"StatisticsProgrammations","parameters":[{"name":"page","in":"query","description":"number of current page","required":false,"allowEmptyValue":false,"schema":{"type":"integer","default":1}},{"name":"type","in":"query","description":"Filter the programmations displayed","required":false,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/Statistics.ProgrammationType"}},{"name":"query","in":"query","description":"Search","required":false,"allowEmptyValue":false,"schema":{"type":"string"}},{"name":"filter","in":"query","required":false,"explode":false,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Filter.Workflows"}}}},{"name":"sort","in":"query","required":false,"explode":false,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProgrammationSort"}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/ProgrammationsStatistics"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"},{"$ref":"#\/components\/schemas\/InvalidSortException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/programmations\/{programmation_id}":{"get":{"tags":["Statistics"],"summary":"Fetch statistics of a programmation","description":"Retrieve the statistics of a programmation","operationId":"StatisticsProgrammationsSingle","parameters":[{"name":"programmation_id","in":"path","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["programmation"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"programmation":{"$ref":"#\/components\/schemas\/Programmation"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/programmations\/download\/{file_type}":{"get":{"tags":["Statistics"],"summary":"Download programmations statistics","description":"Download the statistics of your programmations","operationId":"StatisticsProgrammationsDownload","parameters":[{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/programmations\/{programmation_id}\/download\/{file_type}":{"get":{"tags":["Statistics"],"summary":"Download the statistics of a programmation","description":"Download the statistics of a programmation","operationId":"StatisticsProgrammationsDownloadSingle","parameters":[{"name":"programmation_id","in":"path","description":"ID of programmation to download","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/integrations":{"get":{"tags":["Statistics"],"summary":"Fetch integrations statistics","description":"Retrieve the statistics of your integrations","operationId":"StatisticsIntegrations","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["integrations"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"integrations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.IntegrationStatisticDate"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/global":{"get":{"tags":["Statistics"],"summary":"Fetch global programmations statistics","description":"Retrieve the global statistics of your programmations","operationId":"StatisticsGlobalProgrammations","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"$ref":"#\/components\/schemas\/GlobalStatistics"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/global\/detailed":{"post":{"tags":["Statistics"],"summary":"Fetch global programmation stats by various parameters","description":"Fetch global programmation stats by various parameters. Limited to max 370 days","operationId":"StatisticsGlobalDetailed","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"$ref":"#\/components\/schemas\/statistics.date_range"},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"}},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"$ref":"#\/components\/schemas\/GlobalStatisticsDate"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/RangeTooLarge"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/date":{"post":{"tags":["Statistics"],"summary":"Fetch programmation stats by date","description":"Fetch programmation stats by date. Limited to max 370 days","operationId":"StatisticsDate","requestBody":{"content":{"application\/json":{"schema":{"required":["start_date","end_date"],"properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/DateStats"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/RangeTooLarge"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/date\/detailed":{"post":{"tags":["Statistics"],"summary":"Fetch programmation stats by various parameters, day by day","description":"Fetch programmation stats by various parameters, day by day. Limited to max 60 days","operationId":"StatisticsDateDetailed","requestBody":{"content":{"application\/json":{"schema":{"required":["date_range"],"properties":{"date_range":{"$ref":"#\/components\/schemas\/statistics.date_range"},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"}},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/DateStatsDetailed"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/RangeTooLarge"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/date\/contacts":{"post":{"tags":["Statistics"],"summary":"Download programmation contacts by date","description":"Download programmation contacts by date in xslsx. Limited to max 60 days","operationId":"StatisticsDateContacts","requestBody":{"content":{"application\/json":{"schema":{"required":["start_date","end_date"],"properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"text\/xlsx":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/RangeTooLarge"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/messages":{"get":{"tags":["Statistics"],"summary":"Retrieve the list of possible statistics messages","description":"Retrieve the list of possible statistics messages","operationId":"StatisticsMessages","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["messages"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"messages":{"type":"object","additionalProperties":{"description":"Hashmap of identifier with the translation","type":"string"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-company-size":{"post":{"tags":["Statistics"],"summary":"Responders by company size","description":"Fetch responders count grouped by normalized company-size bucket.","operationId":"StatisticsRespondersByCompanySize","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByCompanySize"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-sector":{"post":{"tags":["Statistics"],"summary":"Responders by activity sector (top 10)","description":"Fetch responders count grouped by activity sector, top 10 most represented sectors only.","operationId":"StatisticsRespondersBySector","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderBySector"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-country":{"post":{"tags":["Statistics"],"summary":"Responders by country","description":"Fetch responders count grouped by country.","operationId":"StatisticsRespondersByCountry","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByCountry"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-region":{"post":{"tags":["Statistics"],"summary":"Responders by country and region","description":"Fetch responders count grouped by ISO country code and resolved region. Only countries with a region resolver are returned; for now, only France (FRA) is supported.","operationId":"StatisticsRespondersByRegion","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByRegion"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-tag":{"post":{"tags":["Statistics"],"summary":"Responders by PRM contact tag","description":"Fetch responders count grouped by PRM contact tag. Responders without any tag (or without a PRM contact) are aggregated into a single bucket with `tag_id` and `tag_name` set to null. A responder with multiple tags counts in each of its tag buckets.","operationId":"StatisticsRespondersByTag","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByTag"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-prm-owner":{"post":{"tags":["Statistics"],"summary":"Responders by PRM contact owner","description":"Fetch responders count grouped by PRM contact owner. Responders without a PRM contact, or whose PRM contact has no owner assigned, are aggregated into a single bucket with `owner` set to null.","operationId":"StatisticsRespondersByPrmOwner","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByPrmOwner"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-programmation-and-list":{"post":{"tags":["Statistics"],"summary":"Responders by programmation and contact list","description":"Fetch responders count grouped by programmation and contact list. Responders not bound to a contact list contribute to a bucket where `contact_list` is null for the matching programmation.","operationId":"StatisticsRespondersByProgrammationAndList","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByProgrammationAndList"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-company-size-and-status":{"post":{"tags":["Statistics"],"summary":"Responders by company size and PRM status","description":"Fetch responders count grouped by normalized company-size bucket and PRM contact status. Responders without a PRM contact, or without a status set, are aggregated into a single bucket with null status values.","operationId":"StatisticsRespondersByCompanySizeAndStatus","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByCompanySizeAndStatus"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-sector-and-status":{"post":{"tags":["Statistics"],"summary":"Responders by activity sector (top 10) and PRM status","description":"Fetch responders count grouped by activity sector and PRM contact status. Only the top 10 most represented sectors are returned (all their status buckets are included). Responders without a PRM contact, or without a status set, are aggregated into a single bucket with null status values for each sector.","operationId":"StatisticsRespondersBySectorAndStatus","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderBySectorAndStatus"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/statistics\/responders\/by-channel-and-status":{"post":{"tags":["Statistics"],"summary":"Responders by channel and PRM status","description":"Fetch responders count grouped by communication channel (email\/linkedin) and PRM contact status. Each responder counts in each channel they replied through.","operationId":"StatisticsRespondersByChannelAndStatus","requestBody":{"content":{"application\/json":{"schema":{"properties":{"date_range":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.date_range"}],"nullable":true},"limit_to_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"limit_to_integration_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["statistics"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResponderByChannelAndStatus"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/products":{"get":{"tags":["Subscriptions"],"summary":"Fetch products list","description":"Retrieve the list of products (Price excluding VAT)","operationId":"SubscriptionsFetchProductsList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["products_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"products_list":{"description":"Displays the list of your products","type":"array","items":{"$ref":"#\/components\/schemas\/ProductResultItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyProductsListException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/subscribe":{"post":{"tags":["Subscriptions"],"summary":"Subscribe","description":"Subscribe","operationId":"SubscriptionsSubscribe","requestBody":{"content":{"application\/json":{"schema":{"required":["items","success_url","cancel_url"],"properties":{"items":{"description":"Items to subscribe","type":"array","items":{"$ref":"#\/components\/schemas\/SubscribeItems"},"nullable":false},"success_url":{"description":"The URL to which customers should be sent when payment is complete","type":"string","example":"https:\/\/example.com\/success?session_id={CHECKOUT_SESSION_ID}","nullable":false},"cancel_url":{"description":"Customers will be directed to this URL if they decide to cancel the payment and return to your website","type":"string","example":"https:\/\/example.com\/cancel","nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["checkout_url"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"checkout_url":{"description":"The URL to which customers should be sent to checkout","type":"string","example":"https:\/\/checkout.example.com\/pay\/123456789"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptySubscribeItemsException"},{"$ref":"#\/components\/schemas\/Subscriptions.EmptySuccessUrlException"},{"$ref":"#\/components\/schemas\/InvalidSuccessUrlException"},{"$ref":"#\/components\/schemas\/Subscriptions.EmptyCancelUrlException"},{"$ref":"#\/components\/schemas\/InvalidCancelUrlException"},{"$ref":"#\/components\/schemas\/MismatchedBillingIntervalException"},{"$ref":"#\/components\/schemas\/ActiveSubscriptionExistsException"},{"$ref":"#\/components\/schemas\/InvalidSubscribeItemsException"},{"$ref":"#\/components\/schemas\/LinkedinAccountsRemovalRequiredException"},{"$ref":"#\/components\/schemas\/SmtpAccountsRemovalRequiredException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/subscribe\/{user_id}":{"post":{"tags":["Subscriptions"],"summary":"Subscribe","description":"Subscribe by User ID","operationId":"SubscriptionsSubscribeByUserId","parameters":[{"name":"user_id","in":"path","description":"The ID of the user","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["end_date"],"properties":{"end_date":{"description":"The date at which the subscription will end","type":"string","format":"date-time"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ActiveSubscriptionExistsException"},{"$ref":"#\/components\/schemas\/EndDateInPastException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/unsubscribe\/{user_id}":{"delete":{"tags":["Subscriptions"],"summary":"Unsubscribe","description":"Unsubscribe by User ID","operationId":"SubscriptionsUnsubscribeByUserId","parameters":[{"name":"user_id","in":"path","description":"The ID of the user","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/NoSubscriptionExistsException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedSubscribeUserException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/unsubscribe":{"delete":{"tags":["Subscriptions"],"summary":"Unsubscribe","description":"Unsubscribe","operationId":"SubscriptionsUnsubscribe","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/NoSubscriptionExistsException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/add\/options":{"put":{"tags":["Subscriptions"],"summary":"Add Subscription Options","description":"Add Subscription Options","operationId":"SubscriptionsAddOptions","requestBody":{"content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"description":"Items to add to subscription","type":"array","items":{"$ref":"#\/components\/schemas\/SubscribeItems"},"nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidSubscribeItemsException"},{"$ref":"#\/components\/schemas\/EmptySubscribeItemsException"},{"$ref":"#\/components\/schemas\/LinkedinAccountsRemovalRequiredException"},{"$ref":"#\/components\/schemas\/SmtpAccountsRemovalRequiredException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/remove\/options":{"delete":{"tags":["Subscriptions"],"summary":"Remove Subscription Options","description":"Remove Subscription Options","operationId":"SubscriptionsRemoveOptions","requestBody":{"content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"description":"Items to remove to subscription","type":"array","items":{"$ref":"#\/components\/schemas\/SubscribeItems"},"nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidSubscribeItemsException"},{"$ref":"#\/components\/schemas\/EmptySubscribeItemsException"},{"$ref":"#\/components\/schemas\/ItemDoesNotExistException"},{"$ref":"#\/components\/schemas\/ItemIsNotAnOptionException"},{"$ref":"#\/components\/schemas\/LinkedinAccountsRemovalRequiredException"},{"$ref":"#\/components\/schemas\/SmtpAccountsRemovalRequiredException"},{"$ref":"#\/components\/schemas\/NoSubscriptionExistsException"},{"$ref":"#\/components\/schemas\/MismatchedBillingIntervalException"},{"$ref":"#\/components\/schemas\/MinimumOptionQuantityException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/add\/payment-method":{"post":{"tags":["Subscriptions"],"summary":"Add and set default payment method","description":"Add a new payment method and set it as the default payment method","operationId":"SubscriptionsAddAndSetDefaultPaymentMethod","requestBody":{"content":{"application\/json":{"schema":{"required":["success_url","cancel_url"],"properties":{"success_url":{"description":"The URL to which customers should be sent once the payment method has been added and set as default","type":"string","example":"https:\/\/example.com\/success?session_id={CHECKOUT_SESSION_ID}","nullable":false},"cancel_url":{"description":"Customers will be directed to this URL if they decide to cancel the payment method addition and return to your website.","type":"string","example":"https:\/\/example.com\/cancel","nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["redirect_url"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"redirect_url":{"description":"The URL to redirect the user to the page for adding a payment method and setting it as default","type":"string","example":"https:\/\/checkout.example.com\/pay\/123456789"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/NoSubscriptionExistsException"},{"$ref":"#\/components\/schemas\/Subscriptions.EmptySuccessUrlException"},{"$ref":"#\/components\/schemas\/InvalidSuccessUrlException"},{"$ref":"#\/components\/schemas\/Subscriptions.EmptyCancelUrlException"},{"$ref":"#\/components\/schemas\/InvalidCancelUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/update\/default-payment-method":{"post":{"tags":["Subscriptions"],"summary":"Update the default payment method","description":"Update the default payment method","operationId":"SubscriptionsUpdateDefaultPaymentMethod","requestBody":{"content":{"application\/json":{"schema":{"required":["payment_method_id"],"properties":{"payment_method_id":{"description":"The ID of the payment method to be set as default","type":"string","example":"pm_123456789","nullable":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyPaymentMethodException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/PaymentMethodNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/update\/customer-info":{"post":{"tags":["Subscriptions"],"summary":"Update customer information","description":"Update customer information including email, name, and address.","operationId":"SubscriptionsUpdateCustomerInfo","requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Customer name","type":"string","nullable":true},"line1":{"description":"Address line 1","type":"string","nullable":true},"line2":{"description":"Address line 2","type":"string","nullable":true},"city":{"description":"City","type":"string","nullable":true},"state":{"description":"State","type":"string","nullable":true},"postal_code":{"description":"Postal code","type":"string","nullable":true},"country":{"description":"Country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","nullable":true},"vat_number":{"description":"The VAT number for the customer. Format should match the VAT ID requirements for the specified country.","type":"string","example":"FR12345678901","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IncorrectCountryException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/NoSubscriptionExistsException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/invoices":{"get":{"tags":["Subscriptions"],"summary":"Fetch client invoices list","description":"Retrieve the list of invoices for the client","operationId":"SubscriptionsFetchInvoicesList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["invoices_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"invoices_list":{"description":"Displays the list of client invoices","type":"array","items":{"$ref":"#\/components\/schemas\/InvoiceResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/subscriptions\/invoices\/download\/{invoice_id}":{"get":{"tags":["Subscriptions"],"summary":"Download client invoice","description":"Download an invoice by its ID","operationId":"SubscriptionsDownloadInvoice","parameters":[{"name":"invoice_id","in":"path","description":"ID of the invoice to download","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvoiceDownloadLinkException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvoiceNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/tags":{"get":{"tags":["Tags"],"summary":"Fetch list","description":"Retrieve the list of tags, including those shared to you","operationId":"TagsFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["tags_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"tags_list":{"description":"Displays the list of your tags","type":"array","items":{"$ref":"#\/components\/schemas\/TagResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Tags"],"summary":"Create a tag","description":"Create a tag","operationId":"TagsCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Tag name","type":"string","example":"My tag"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["tag_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"tag_id":{"description":"Display the tag ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/PRMInvalidColorException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/tags\/{tag_id}":{"get":{"tags":["Tags"],"summary":"Find profile","description":"Retrieve the profile of a tag","operationId":"TagsFindProfileById","parameters":[{"name":"tag_id","in":"path","description":"ID of tag to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["tag_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"tag_profile":{"$ref":"#\/components\/schemas\/TagItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTagIdException"},{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTagException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Tags"],"summary":"Update profile","description":"Update a tag profile","operationId":"TagsUpdateProfileById","parameters":[{"name":"tag_id","in":"path","description":"ID of tag to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Tag name","type":"string","example":"My tag","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyTagIdException"},{"$ref":"#\/components\/schemas\/TagDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/PRMInvalidColorException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTagException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Tags"],"summary":"Delete a tag","description":"Delete a tag","operationId":"TagsDelete","parameters":[{"name":"tag_id","in":"path","description":"ID of tag to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTagIdException"},{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTagException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-publishers-job-offers":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract the publishers of job offers on LinkedIn","description":"Extract the publishers of job offers on LinkedIn","operationId":"TargetingLinkedinExtractPublishersJobOffers","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_job_search_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_job_search_url":{"description":"LinkedIn URL of the job search","type":"string","example":"https:\/\/www.linkedin.com\/jobs\/search\/?f_E=2&f_L=European%20Economic%20Area&geoId=91000002&keywords=marketing%20manager&location=European%20Economic%20Area"},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 1000)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinJobSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinJobSearchUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-post-likers":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract contacts who liked a post on LinkedIn","description":"Extract contacts who liked a post on LinkedIn","operationId":"TargetingLinkedinExtractPostLikers","requestBody":{"content":{"application\/json":{"schema":{"required":["max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_post_url":{"description":"LinkedIn URL of the post. If you don't provide this parameter, the job will try to find a LinkedIn post URL in the contact list properties and use it. It will be used for all the contacts of the list. The property name that will be searched is \"Linkedin Post URL\".","type":"string","example":"https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity:7056173010206044161"},"linkedin_post_urls":{"description":"LinkedIn URLs of the posts. If you don't provide this parameter, the job will try to find a LinkedIn post URL in the contact list properties and use it. It will be used for all the contacts of the list. The property name that will be searched is \"Linkedin Post URL\".","type":"array","items":{"type":"string"},"example":["https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity:7056173010206044161"]},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 30000)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-post-commenters":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract contacts who commented on a LinkedIn post","description":"Extract contacts who commented on a LinkedIn post","operationId":"TargetingLinkedinExtractPostCommenters","requestBody":{"content":{"application\/json":{"schema":{"required":["max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_post_url":{"description":"LinkedIn URL of the post. If you don't provide this parameter, the job will try to find a LinkedIn post URL in the contact list properties and use it. It will be used for all the contacts of the list. The property name that will be searched is \"Linkedin Post URL\".","type":"string","example":"https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity:7056173010206044161"},"linkedin_post_urls":{"description":"LinkedIn URLs of the posts. If you don't provide this parameter, the job will try to find a LinkedIn post URL in the contact list properties and use it. It will be used for all the contacts of the list. The property name that will be searched is \"Linkedin Post URL\".","type":"array","items":{"type":"string"},"example":["https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity:7056173010206044161"]},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 1000)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-sales-navigator-peoples-search":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract contacts from a Sales Navigator search","description":"Extract contacts from a Sales Navigator search","operationId":"TargetingLinkedinExtractSalesNavigatorPeoplesSearch","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_sales_navigator_search_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_sales_navigator_search_url":{"description":"Sales Navigator search URL","type":"string","example":"https:\/\/www.linkedin.com\/sales\/search\/people?geoIncluded=101240143&industryIncluded=6&logHistory=true&page=1&rsLogId=247258001&titleIncluded=Marketing%2520Director%3A63"},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 2500)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"exclude_viewed_leads":{"description":"Remove viewed Leads from search","type":"boolean","example":false},"exclude_crm_contacts":{"description":"Exclude CRM contacts","type":"boolean","example":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-sales-navigator-peoples-search-alternative":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract contacts from a Sales Navigator search (alternative)","description":"Extract contacts from a Sales Navigator search","operationId":"TargetingLinkedinExtractSalesNavigatorPeoplesSearchAlternative","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_sales_navigator_search_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_sales_navigator_search_url":{"description":"Sales Navigator search URL","type":"string","example":"https:\/\/www.linkedin.com\/sales\/search\/people?geoIncluded=101240143&industryIncluded=6&logHistory=true&page=1&rsLogId=247258001&titleIncluded=Marketing%2520Director%3A63"},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 2500)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinUrlTooLongException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedTargetingAlternativeException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-posts":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract posts on LinkedIn","description":"Extract posts on LinkedIn","operationId":"TargetingLinkedinExtractSearchContent","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_search_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_search_url":{"description":"LinkedIn URL of the search","type":"string","example":"https:\/\/www.linkedin.com\/search\/results\/content\/?keywords=ceo&origin=SWITCH_SEARCH_VERTICAL"},"max_results":{"description":"Maximum number of posts to be extracted (maximum 3000)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"extract_commenters":{"description":"Set to true to automatically launch a job to extract commenters from those posts","type":"boolean","nullable":true,"default":false},"extract_likers":{"description":"Set to true to automatically launch a job to extract likers from those posts","type":"boolean","nullable":true,"default":false},"extract_reposters":{"description":"Set to true to automatically launch a job to extract reposters from those posts","type":"boolean","nullable":true,"default":false}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-posts-sync":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn posts (synchronous)","description":"Synchronously extract LinkedIn posts from a content search URL and return them directly. Capped at 20 results to avoid HTTP timeouts.","operationId":"TargetingLinkedinExtractPostsSync","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_search_url","max_results"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"linkedin_search_url":{"description":"LinkedIn content search URL","type":"string","example":"https:\/\/www.linkedin.com\/search\/results\/content\/?keywords=marketing"},"max_results":{"description":"Maximum number of posts to extract (1-20)","type":"integer","example":20}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["posts"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"posts":{"description":"List of extracted LinkedIn posts","type":"array","items":{"$ref":"#\/components\/schemas\/JobResultExtractSearchContent"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/ApiLinkedin.NumberLinkedinInteractionsReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-peoples-search-sync":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn profiles from a people search (synchronous)","description":"Synchronously extract LinkedIn profiles from a people search URL and return them directly. Capped at 20 results to avoid HTTP timeouts.","operationId":"TargetingLinkedinExtractPeoplesSearchSync","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_people_search_url","max_results"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"linkedin_people_search_url":{"description":"LinkedIn people search URL","type":"string","example":"https:\/\/www.linkedin.com\/search\/results\/people\/?facetGeoRegion=%5B%22fr%3A0%22%5D&keywords=CTO"},"max_results":{"description":"Maximum number of profiles to extract (1-20)","type":"integer","example":20}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["profiles"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"profiles":{"description":"List of extracted LinkedIn profiles","type":"array","items":{"$ref":"#\/components\/schemas\/JobResultExtractPeoplesSearch"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPeopleSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPeopleSearchUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/ApiLinkedin.NumberLinkedinInteractionsReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-companies-search-sync":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn companies from a company search (synchronous)","description":"Synchronously extract LinkedIn companies from a company search URL and return them directly. Capped at 20 results to avoid HTTP timeouts.","operationId":"TargetingLinkedinExtractCompaniesSearchSync","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_company_search_url","max_results"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"linkedin_company_search_url":{"description":"LinkedIn company search URL","type":"string","example":"https:\/\/www.linkedin.com\/search\/results\/companies\/?keywords=marketing"},"max_results":{"description":"Maximum number of companies to extract (1-20)","type":"integer","example":20}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["companies"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"companies":{"description":"List of extracted LinkedIn companies","type":"array","items":{"$ref":"#\/components\/schemas\/JobResultExtractCompaniesSearch"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinCompanySearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinCompanySearchUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/ApiLinkedin.NumberLinkedinInteractionsReachedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-profile-viewers":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn profile viewers","description":"Extract LinkedIn profile viewers","operationId":"TargetingLinkedinExtractProfileViewers","requestBody":{"content":{"application\/json":{"schema":{"required":["max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"max_results":{"description":"Maximum number of viewers to be extracted (maximum 500)","type":"integer","example":50},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-event-attendees":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn event attendees","description":"Extract LinkedIn event attendees","operationId":"TargetingLinkedinExtractEventAttendees","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_event_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_event_url":{"description":"LinkedIn event URL","type":"string","example":"https:\/\/www.linkedin.com\/events\/6578957872855689398\/"},"max_results":{"description":"Maximum number of attendees to be extracted (maximum 1000)","type":"integer","example":100},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-company-viewers":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn company viewers","description":"Extract LinkedIn company viewers","operationId":"TargetingLinkedinExtractCompanyViewers","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_company_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_company_url":{"description":"LinkedIn company URL","type":"string","example":"https:\/\/www.linkedin.com\/company\/openai\/"},"max_results":{"description":"Maximum number of viewers to be extracted (maximum 30000)","type":"integer","example":50},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-group-members":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn group members","description":"Extract LinkedIn group members","operationId":"TargetingLinkedinExtractGroupMembers","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_group_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_group_url":{"description":"LinkedIn group URL","type":"string","example":"https:\/\/www.linkedin.com\/groups\/8952\/"},"max_results":{"description":"Maximum number of members to be extracted (maximum 2500)","type":"integer","example":100},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-people-comment-activity":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn people comment activity","description":"Extract LinkedIn people comment activity","operationId":"TargetingLinkedinExtractPeopleCommentActivity","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_profile_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_profile_url":{"description":"LinkedIn profile URL","type":"string","example":"https:\/\/www.linkedin.com\/in\/francois-kolli"},"max_results":{"description":"Maximum number of activities to be extracted (maximum 500)","type":"integer","example":50},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-people-post-activity":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn people post activity","description":"Extract LinkedIn people post activity","operationId":"TargetingLinkedinExtractPeoplePostActivity","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_profile_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_profile_url":{"description":"LinkedIn profile URL","type":"string","example":"https:\/\/www.linkedin.com\/in\/francois-kolli"},"max_results":{"description":"Maximum number of activities to be extracted (maximum 500)","type":"integer","example":50},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-people-reaction-activity":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn people reaction activity","description":"Extract LinkedIn people reaction activity","operationId":"TargetingLinkedinExtractPeopleReactionActivity","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_profile_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_profile_url":{"description":"LinkedIn profile URL","type":"string","example":"https:\/\/www.linkedin.com\/in\/francois-kolli"},"max_results":{"description":"Maximum number of activities to be extracted (maximum 500)","type":"integer","example":50},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-post-reposters":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract LinkedIn post reposters","description":"Extract LinkedIn post reposters","operationId":"TargetingLinkedinExtractPostReposters","requestBody":{"content":{"application\/json":{"schema":{"required":["max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_post_url":{"description":"LinkedIn post URL. If you don't provide this parameter, the job will try to find a LinkedIn post URL in the contact list properties and use it. It will be used for all the contacts of the list. The property name that will be searched is \"Linkedin Post URL\".","type":"string","example":"https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity:7056173010206044161"},"linkedin_post_urls":{"description":"LinkedIn URLs of the posts. If you don't provide this parameter, the job will try to find a LinkedIn post URL in the contact list properties and use it. It will be used for all the contacts of the list. The property name that will be searched is \"Linkedin Post URL\".","type":"array","items":{"type":"string"},"example":["https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity:7056173010206044161"]},"max_results":{"description":"Maximum number of reposters to be extracted (maximum 1000)","type":"integer","example":100},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters)","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters)","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPostUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-sales-navigator-companies-search":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract companies from a Sales Navigator search","description":"Extract companies from a Sales Navigator search","operationId":"TargetingLinkedinExtractSalesNavigatorCompaniesSearch","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_sales_navigator_search_url","max_results"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_sales_navigator_search_url":{"description":"Sales Navigator search URL","type":"string","example":"https:\/\/www.linkedin.com\/sales\/search\/company?query=(spellCorrectionEnabled%3Atrue%2Ckeywords%3Aibm)"},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 2500)","type":"integer","example":10},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinUrlTooLongException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-sales-navigator-companies-search-alternative":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract companies from a Sales Navigator search (alternative)","description":"Extract companies from a Sales Navigator search","operationId":"TargetingLinkedinExtractSalesNavigatorCompaniesSearchAlternative","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_sales_navigator_search_url","max_results"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_sales_navigator_search_url":{"description":"Sales Navigator search URL","type":"string","example":"https:\/\/www.linkedin.com\/sales\/search\/company?query=(spellCorrectionEnabled%3Atrue%2Ckeywords%3Aibm)"},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 2500)","type":"integer","example":10},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinSalesNavigatorSearchUrlException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinUrlTooLongException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedTargetingAlternativeException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-peoples-search":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract contacts from a LinkedIn search","description":"Extract contacts from a LinkedIn search","operationId":"TargetingLinkedinExtractPeoplesSearch","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_people_search_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_people_search_url":{"description":"LinkedIn people search URL","type":"string","example":"https:\/\/www.linkedin.com\/search\/results\/people\/?facetGeoRegion=%5B%22fr%3A0%22%5D&keywords=CTO"},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 1000)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPeopleSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPeopleSearchUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-peoples-search-alternative":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract contacts from a LinkedIn search (alternative)","description":"Extract contacts from a LinkedIn search","operationId":"TargetingLinkedinExtractPeoplesSearchAlternative","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_people_search_url","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1,"nullable":true},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"linkedin_people_search_url":{"description":"LinkedIn people search URL","type":"string","example":"https:\/\/www.linkedin.com\/search\/results\/people\/?facetGeoRegion=%5B%22fr%3A0%22%5D&keywords=CTO"},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 1000)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinPeopleSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidLinkedinPeopleSearchUrlException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/LinkedinUrlTooLongException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedTargetingAlternativeException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/LinkedinAccountDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/refresh\/{contact_list_id}":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Refresh LinkedIn targeting on a contact list","description":"Refresh LinkedIn targeting on a contact list","operationId":"TargetingLinkedinRefreshContactList","parameters":[{"name":"contact_list_id","in":"path","description":"ID of your contact list to refresh","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_account_id"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/TargetingLinkedinNotFoundException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/extract-connections":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Extract contacts from LinkedIn connections","description":"Extract contacts from LinkedIn connections","operationId":"TargetingLinkedinExtractConnections","requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_account_id","max_results","generate_email"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1},"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 30000)","type":"integer","example":10},"generate_email":{"description":"Try to generate contact email","type":"boolean","default":false},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/LinkedinAccountDisconnected"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/google\/extract-maps-search":{"post":{"tags":["Targeting - Google"],"summary":"Extract contacts from a Google Maps Search","description":"Extract contacts from a Google Maps Search","operationId":"TargetingGoogleExtractMapsSearch","requestBody":{"content":{"application\/json":{"schema":{"required":["google_maps_search_urls","max_results"],"properties":{"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"google_maps_search_urls":{"description":"Google Maps Search URLs (10 urls max)","type":"array","items":{"type":"string","example":"https:\/\/www.google.com\/maps\/search\/restaurant\/@43.2928346,5.3662584,14z"}},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 200)","type":"integer","example":10},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/EmptyGoogleMapsSearchUrlException"},{"$ref":"#\/components\/schemas\/InvalidGoogleMapsSearchUrlException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/google\/generate-maps-search-urls":{"post":{"tags":["Targeting - Google"],"summary":"Generate Google Maps Search URLs","description":"Generate Google Maps Search URLs","operationId":"TargetingGoogleGenerateMapsSearchUrls","requestBody":{"content":{"application\/json":{"schema":{"required":["search"],"properties":{"search":{"description":"Text describing what the user wants to search on Google Maps","type":"string","example":"plombiers","maxLength":300},"locations":{"description":"Optional locations used to scope the generated Google Maps searches","type":"array","items":{"type":"string","example":"Bordeaux","maxLength":120},"maxItems":20},"max_links":{"description":"Maximum number of Google Maps search URLs to return (between 1 and 40)","type":"integer","example":20}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["google_maps_search_urls"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"google_maps_search_urls":{"description":"Generated Google Maps Search URLs","type":"array","items":{"type":"string","example":"https:\/\/www.google.com\/maps\/search\/plombiers+Bordeaux\/@44.837789,-0.57918,12z\/"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyGoogleMapsSearchQueryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedSearchAIException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/generate-sales-navigator-peoples-search-url":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Generate a Linkedin Sales Navigator peoples search url","description":"Generate a Linkedin Sales Navigator peoples search url","operationId":"TargetingLinkedinGenerateSalesNavigatorPeoplesSearchUrl","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GenerateSalesNavigatorPeoplesSearch"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["linkedin_url"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"linkedin_url":{"description":"Display the linkedin url","type":"string","example":"https:\/\/www.linkedin.com\/sales\/search\/people"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinSearchUrlParametersException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedSearchAIException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/generate-peoples-search-url":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Generate a Linkedin peoples search url","description":"Generate a Linkedin peoples search url","operationId":"TargetingLinkedinGeneratePeoplesSearchUrl","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GeneratePeoplesSearch"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["linkedin_url"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"linkedin_url":{"description":"Display the linkedin url","type":"string","example":"https:\/\/www.linkedin.com\/search\/results\/people"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyLinkedinSearchUrlParametersException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/database\/count":{"post":{"tags":["Targeting - Database"],"summary":"Count the number of contacts found with the given filters","description":"Count the number of contacts found with the given filters","operationId":"TargetingDatabaseCount","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DatabaseFilters"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["number_of_contacts"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"number_of_contacts":{"description":"Number of contacts found","type":"integer","example":5}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidFiltersException"},{"$ref":"#\/components\/schemas\/FilterLimitExceededException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTargetingDatabaseException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/database\/extract":{"post":{"tags":["Targeting - Database"],"summary":"Extract contacts found with the given filters","description":"Extract contacts found with the given filters","operationId":"TargetingDatabaseExtract","requestBody":{"content":{"application\/json":{"schema":{"properties":{"contact_list_name":{"description":"If you want to create a new list: Give a name to your new contact list where the results will be inserted","type":"string","example":"My contact list"},"contact_list_id":{"description":"If you want to use an existing contact list: Specify the ID of your contact list into which the results will be inserted.","type":"integer","example":1},"filters":{"description":"Array of filter criteria.","type":"array","items":{"$ref":"#\/components\/schemas\/DatabaseFilter"}},"max_results":{"description":"Maximum number of profiles to be extracted (maximum 50000)","type":"integer","example":10},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["contact_list_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"contact_list_id":{"description":"Display the contact list ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidFiltersException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdNameException"},{"$ref":"#\/components\/schemas\/NoMatchingContactFoundException"},{"$ref":"#\/components\/schemas\/FilterLimitExceededException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTargetingDatabaseException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/locations\/search":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Search linkedin location ids","description":"Search linkedin location ids","operationId":"TargetingLinkedinLocationSearch","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Name to search","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["locations"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"locations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Location"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/database\/count-preview":{"post":{"tags":["Targeting - Database"],"summary":"Count and preview contacts based on filters","description":"Count the number of contacts and preview the first results based on given filters","operationId":"TargetingDatabaseCountAndPreview","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DatabaseFilters"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["number_of_contacts","contacts"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"number_of_contacts":{"description":"Total number of contacts found","type":"integer","example":5},"contacts":{"description":"Preview of contact details","type":"array","items":{"$ref":"#\/components\/schemas\/ContactDatabase"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidFiltersException"},{"$ref":"#\/components\/schemas\/FilterLimitExceededException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTargetingDatabaseException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/database\/locations\/search":{"post":{"tags":["Targeting - Database"],"summary":"Search database location","description":"Search database location","operationId":"TargetingDatabaseLocationSearch","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Name to search (min 3 caracters)","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["locations"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"locations":{"type":"array","items":{"$ref":"#\/components\/schemas\/DatabaseLocation"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/NameTooShortException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/google\/extract-maps-search\/{contact_list_id}\/relaunch-errors":{"post":{"tags":["Targeting - Google"],"summary":"Relaunch extractions with errors","description":"Relaunch extractions with errors","operationId":"TargetingGoogleExtractMapsSearchRelaunchErrors","parameters":[{"name":"contact_list_id","in":"path","description":"ID of your contact list containing errors to be re-launched","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/NoGoogleMapsSearchExtractionWithErrorsFoundException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/google\/extract-maps-search\/{contact_list_id}\/relaunch":{"post":{"tags":["Targeting - Google"],"summary":"Relaunch extractions","description":"Relaunch extractions","operationId":"TargetingGoogleExtractMapsSearchRelaunch","parameters":[{"name":"contact_list_id","in":"path","description":"ID of your contact list to be re-launched","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/NoGoogleMapsSearchExtractionFoundException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/targeting\/linkedin\/{contact_list_id}\/relaunch-errors":{"post":{"tags":["Targeting - LinkedIn"],"summary":"Relaunch LinkedIn extractions with errors","description":"Relaunch LinkedIn extractions with errors","operationId":"TargetingLinkedinExtractionsRelaunchErrors","parameters":[{"name":"contact_list_id","in":"path","description":"ID of your contact list containing errors to be re-launched","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["linkedin_account_id"],"properties":{"linkedin_account_id":{"description":"LinkedIn account ID to use","type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/NoLinkedinExtractionWithErrorsFoundException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/TargetingLinkedinNotFoundException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams":{"post":{"tags":["Teams"],"summary":"Create a team","description":"Create a team","operationId":"TeamsCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"description":"Team name","type":"string","example":"My team"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["team_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"team_id":{"description":"Display the team ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams\/{team_id}":{"get":{"tags":["Teams"],"summary":"Find profile","description":"Retrieve the profile of a team","operationId":"TeamsFindProfileById","parameters":[{"name":"team_id","in":"path","description":"ID of team to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["team_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"team_profile":{"$ref":"#\/components\/schemas\/TeamProfile"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Teams"],"summary":"Update profile","description":"Update a team profile","operationId":"TeamsUpdateProfileById","parameters":[{"name":"team_id","in":"path","description":"ID of team to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Team name","type":"string","example":"My team","nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Teams"],"summary":"Delete a team","description":"Delete a team","operationId":"TeamsDelete","parameters":[{"name":"team_id","in":"path","description":"ID of team to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams\/{team_id}\/users":{"get":{"tags":["Teams"],"summary":"Fetch users list","description":"Retrieve the list of team users","operationId":"TeamsFetchUsersListById","parameters":[{"name":"team_id","in":"path","description":"ID of team to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["users_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"users_list":{"description":"Displays the list of team users","type":"array","items":{"$ref":"#\/components\/schemas\/UserProfile"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams\/join":{"post":{"tags":["Teams"],"summary":"Join a team","description":"Join a team","operationId":"TeamsJoin","requestBody":{"content":{"application\/json":{"schema":{"required":["team_code"],"properties":{"team_code":{"description":"Team code","type":"string","example":"my team code"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["team_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"team_id":{"description":"Displays the ID of the team you just joined","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/EmptyTeamCodeException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/TeamCodeInvalidException"},{"$ref":"#\/components\/schemas\/AlreadyInTheTeamException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"429":{"description":"Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TooManyAttemptsException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams\/{team_id}\/leave":{"delete":{"tags":["Teams"],"summary":"Leave a team","description":"Leave a team","operationId":"TeamsLeave","parameters":[{"name":"team_id","in":"path","description":"ID of team to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/YouAreAdminException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams\/{team_id}\/role\/{user_id}":{"put":{"tags":["Teams"],"summary":"Update the role of an user","description":"Update the role of an user on a team (for admins of the team)","operationId":"TeamsRole","parameters":[{"name":"team_id","in":"path","description":"ID of team","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of user to modify","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["role_id"],"properties":{"role_id":{"description":"Role id","type":"integer","example":1,"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/RoleDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyRoleIdException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams\/{team_id}\/invite":{"post":{"tags":["Teams"],"summary":"Invite an user to a team","description":"Invite an user to a team","operationId":"TeamsInvite","parameters":[{"name":"team_id","in":"path","description":"ID of team to invite","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["email"],"properties":{"email":{"type":"string","example":"email@example.org"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmailErrorException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}},"429":{"description":"Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TooManyAttemptsException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/teams\/{team_id}\/level\/{user_id}":{"put":{"tags":["Teams"],"summary":"Update the level of a user","description":"Update the level of a user on a team (for admins of the team)","operationId":"TeamsLevel","parameters":[{"name":"team_id","in":"path","description":"ID of team","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of user to modify","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["level"],"properties":{"level":{"$ref":"#\/components\/schemas\/TeamLevel"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyTeamIdException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/urls-shortener":{"get":{"tags":["URLs Shortener"],"summary":"Fetch list","description":"Retrieve the list of shortened URLs, including those shared to you","operationId":"URLsShortenerFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["shortened_urls_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"shortened_urls_list":{"description":"Displays the list of your shortened URLs","type":"array","items":{"$ref":"#\/components\/schemas\/URLShortenerResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["URLs Shortener"],"summary":"Create a shortened URL","description":"Create a shortened URL","operationId":"URLsShortenerCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name","url"],"properties":{"name":{"description":"Shortened URL name","type":"string","example":"My shortened URL"},"url":{"description":"URL to shorten","type":"string","example":"https:\/\/www.domaine.fr"},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["shortened_url_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"shortened_url_id":{"description":"Display the shortened URL ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyUrlException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/urls-shortener\/bulk":{"post":{"tags":["URLs Shortener"],"summary":"Create shortened URLs in bulk","description":"Create shortened URLs in bulk","operationId":"URLsShortenerBulkCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/URLShortenerBulkCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["shortened_urls"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"shortened_urls":{"description":"Displays the shortened URLs","type":"array","items":{"$ref":"#\/components\/schemas\/URLShortenerBulkResultItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/urls-shortener\/{shortened_url_id}":{"get":{"tags":["URLs Shortener"],"summary":"Find profile","description":"Retrieve the profile of a shortened URL","operationId":"URLsShortenerFindProfileById","parameters":[{"name":"shortened_url_id","in":"path","description":"ID of shortened URL to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["shortened_url_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"shortened_url_profile":{"$ref":"#\/components\/schemas\/URLShortenerItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyShortenedUrlIdException"},{"$ref":"#\/components\/schemas\/ShortenedUrlDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedShortenedUrlException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ShortenedUrlDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["URLs Shortener"],"summary":"Update profile","description":"Update a shortened URL profile","operationId":"URLsShortenerUpdateProfileById","parameters":[{"name":"shortened_url_id","in":"path","description":"ID of shortened URL to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"description":"Shortened URL name","type":"string","example":"My shortened URL","nullable":true},"url":{"description":"URL to shorten","type":"string","example":"https:\/\/www.domaine.fr","nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyUrlException"},{"$ref":"#\/components\/schemas\/EmptyShortenedUrlIdException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedShortenedUrlException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ShortenedUrlDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["URLs Shortener"],"summary":"Delete a shortened URL","description":"Delete a shortened URL","operationId":"URLsShortenerDelete","parameters":[{"name":"shortened_url_id","in":"path","description":"ID of shortened URL to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyShortenedUrlIdException"},{"$ref":"#\/components\/schemas\/ShortenedUrlDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedShortenedUrlException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ShortenedUrlDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/urls-shortener\/{url_code}":{"get":{"tags":["URLs Shortener"],"summary":"Find URL by URL code","description":"Retrieve the URL of a shortened URL","operationId":"URLsShortenerFindURLByCode","parameters":[{"name":"url_code","in":"path","description":"URL code of URL to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["url"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"url":{"description":"Displays the shortened URL","type":"string","example":"http:\/\/example.org\/short"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UrlCodeDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/unsubscribers":{"get":{"tags":["Unsubscribers"],"summary":"Fetch unsubscribers","description":"Fetch unsubscribers<br>Allowed field_name for filter\/sort: id, organization_id, value_type, value","operationId":"FetchUnsubscribers","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"value_type"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the unsubscribers","type":"array","items":{"$ref":"#\/components\/schemas\/Unsubscriber"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Unsubscribers"],"summary":"Import unsubscribers","description":"Import unsubscribers to an organization","operationId":"UnsubscribersImport","requestBody":{"content":{"application\/json":{"schema":{"required":["organization_id","data"],"properties":{"organization_id":{"description":"Organization ID","type":"integer","example":1,"nullable":true},"data":{"description":"Data to import","type":"array","items":{"properties":{"value":{"type":"string"}},"type":"object"},"example":[{"value":"name@mydomain.ext"},{"value":"@mydomain.ext"},{"value":"https:\/\/www.linkedin.com\/in\/abc\/"},{"value":"0612345678"},{"value":"123456789"},{"value":"12345678900020"},{"value":"6209Z"},{"value":"My Company"}]}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/ImportUnsubscribersDataResponse"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/EmptyDataException"},{"$ref":"#\/components\/schemas\/ImportLimitExceededException"},{"$ref":"#\/components\/schemas\/DataValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/unsubscribers\/organization\/{organization_id}":{"get":{"tags":["Unsubscribers"],"summary":"Retrieve unsubscribers from an organization","description":"Retrieve unsubscribers from an organization<br>Allowed field_name for filter\/sort: id, organization_id, value_type, value","operationId":"RetrieveUnsubscribersFromAnOrganization","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"value_type"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the unsubscribers","type":"array","items":{"$ref":"#\/components\/schemas\/Unsubscriber"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/unsubscribers\/{unsubscriber_id}":{"delete":{"tags":["Unsubscribers"],"summary":"Delete an unsubscriber","description":"Delete an unsubscriber","operationId":"UnsubscriberDelete","parameters":[{"name":"unsubscriber_id","in":"path","description":"ID of unsubscriber to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyUnsubscriberIdException"},{"$ref":"#\/components\/schemas\/UnsubscriberDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedUnsubscriberException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnsubscriberDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/unsubscribers\/search":{"post":{"tags":["Unsubscribers"],"summary":"Search unsubscribers from all organizations","description":"Search unsubscribers from all organizations<br>Allowed field_name for filter\/sort: id, organization_id, value_type, value, created_on","operationId":"UnsubscribersSearchAll","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"value_type"}},"type":"object"}},"type":"object"}]}}}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["query"],"properties":{"query":{"description":"Value of your search","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the unsubscribers","type":"array","items":{"$ref":"#\/components\/schemas\/Unsubscriber"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/QueryTooShortException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/unsubscribers\/organization\/{organization_id}\/search":{"post":{"tags":["Unsubscribers"],"summary":"Search unsubscribers from specific organization","description":"Search unsubscribers from specific organization<br>Allowed field_name for filter\/sort: id, organization_id, value_type, value","operationId":"UnsubscribersSearch","parameters":[{"name":"organization_id","in":"path","description":"ID of organization to search","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"value_type"}},"type":"object"}},"type":"object"}]}}}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["query"],"properties":{"query":{"description":"Value of your search","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the unsubscribers","type":"array","items":{"$ref":"#\/components\/schemas\/Unsubscriber"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/QueryTooShortException"},{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/unsubscribers\/download\/{file_type}":{"get":{"tags":["Unsubscribers"],"summary":"Download the list of unsubscribers","description":"Download the list of unsubscribers","operationId":"UnsubscribersDownload","parameters":[{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyOrganizationIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/unsubscribers\/organization\/{organization_id}\/download\/{file_type}":{"get":{"tags":["Unsubscribers"],"summary":"Download the list of unsubscribers from an organization","description":"Download the list of unsubscribers from an organization","operationId":"UnsubscribersDownloadFromOrganization","parameters":[{"name":"organization_id","in":"path","description":"ID of the organization to download the list of unsubscribers","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/register":{"post":{"tags":["Users"],"summary":"Register","description":"Create an user account","operationId":"UsersRegister","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["user_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"user_id":{"description":"The user id of the created user","type":"integer"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Users.EmptyEmailException"},{"$ref":"#\/components\/schemas\/Users.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmptyPasswordException"},{"$ref":"#\/components\/schemas\/PasswordNotStrongException"},{"$ref":"#\/components\/schemas\/EmailUsedException"},{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneCountryException"},{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneException"},{"$ref":"#\/components\/schemas\/IncorrectDomainSaasException"},{"$ref":"#\/components\/schemas\/DomainSaasDoesNotExistException"},{"$ref":"#\/components\/schemas\/IncorrectEmailValidationUrlSuccessException"},{"$ref":"#\/components\/schemas\/IncorrectEmailValidationUrlErrorException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IncorrectSexException"},{"$ref":"#\/components\/schemas\/EmailErrorException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/ReferredUserIdDoesNotExistException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DomainSaasDoesNotExistException"}]}}}}}}},"\/users\/authentication":{"post":{"tags":["Users"],"summary":"Authentication","description":"Authenticate to an user account. Returns an access token and refresh token","operationId":"UsersAuthentication","requestBody":{"content":{"application\/json":{"schema":{"required":["email","password"],"properties":{"email":{"description":"Identification\/Contact email","type":"string","example":"jean.dupont@example.com"},"password":{"description":"Identification password","type":"string","example":"Azerty123!"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["access_token","refresh_token"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"access_token":{"description":"Display the JWT Token to use to connect to the account. The lifetime of the token is 30 minutes.","type":"string"},"refresh_token":{"description":"Display the Token to use to refresh token.","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Users.EmptyEmailException"},{"$ref":"#\/components\/schemas\/Users.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmptyPasswordException"},{"$ref":"#\/components\/schemas\/IncorrectEmailOrPasswordException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}}}},"\/users\/authentication\/refresh":{"post":{"tags":["Users"],"summary":"Refresh authentication","description":"Refresh token JWT to a new pair or refresh and access token","operationId":"UsersRefreshAuthentication","requestBody":{"content":{"application\/json":{"schema":{"required":["refresh_token"],"properties":{"refresh_token":{"description":"Refresh token received during authentication","type":"string","example":"abcdefghijklmnopqrstuvwxyz"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["access_token","refresh_token"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"access_token":{"description":"Display the JWT Token to use to connect to the account. The lifetime of the token is 30 minutes.","type":"string"},"refresh_token":{"description":"Display the Token to use to refresh token.","type":"string"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyRefreshTokenException"},{"$ref":"#\/components\/schemas\/RefreshTokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/RefreshTokenAlreadyUsedException"},{"$ref":"#\/components\/schemas\/RefreshTokenExpiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/RefreshTokenDoesNotExistException"}]}}}}}}},"\/users\/me\/quick":{"get":{"tags":["Users"],"summary":"Find my profile (quick version)","description":"Retrieve the profile of my account, including the teams and organizations I am in and the resellers I have created. Displays only display restriction permissions.","operationId":"UsersProfileQuick","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["user_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"user_profile":{"$ref":"#\/components\/schemas\/UserProfileMe"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/me":{"get":{"tags":["Users"],"summary":"Find my profile","description":"Retrieve the profile of my account, including the teams and organizations I am in and the resellers I have created","operationId":"UsersProfile","parameters":[{"name":"reseller_id","in":"query","description":"Optional reseller ID to simulate user context","required":false,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["user_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"user_profile":{"$ref":"#\/components\/schemas\/UserProfileMe"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Users"],"summary":"Update my profile","description":"Update my user account","operationId":"UsersUpdateProfile","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Users.EmptyEmailException"},{"$ref":"#\/components\/schemas\/Users.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmptyCountryException"},{"$ref":"#\/components\/schemas\/IncorrectCountryException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneCountryException"},{"$ref":"#\/components\/schemas\/EmailUsedException"},{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneException"},{"$ref":"#\/components\/schemas\/IncorrectEmailValidationUrlSuccessException"},{"$ref":"#\/components\/schemas\/IncorrectEmailValidationUrlErrorException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmailErrorException"},{"$ref":"#\/components\/schemas\/IncorrectSourceException"},{"$ref":"#\/components\/schemas\/Users.IncorrectCurrentPasswordException"},{"$ref":"#\/components\/schemas\/EmptyCurrentPasswordException"},{"$ref":"#\/components\/schemas\/LinkClickScoreCannotBeEmptyException"},{"$ref":"#\/components\/schemas\/IncorrectColumnEntryNotificationFrequencyException"},{"$ref":"#\/components\/schemas\/IncorrectColumnEntryNotificationDigestTimeException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Users"],"summary":"Delete my user account","description":"Delete my user account","operationId":"UsersDelete","requestBody":{"content":{"application\/json":{"schema":{"required":["password"],"properties":{"current_password":{"description":"The current user password to confirm deletion","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Users.IncorrectCurrentPasswordException"},{"$ref":"#\/components\/schemas\/EmptyPasswordException"},{"$ref":"#\/components\/schemas\/AdminAccountDeletionException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/{user_id}":{"get":{"tags":["Users"],"summary":"Find profile by ID","description":"Retrieve the profile of an user account, including the list of teams, organizations and resellers I have created and from which this user is a member","operationId":"UsersFindProfileById","parameters":[{"name":"user_id","in":"path","description":"ID of user to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["user_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"user_profile":{"$ref":"#\/components\/schemas\/UserProfile"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Users.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Users"],"summary":"Update profile by ID","description":"Update an user account. You can only update users from your resellers","operationId":"UsersUpdateProfileById","parameters":[{"name":"user_id","in":"path","description":"ID of user to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Users.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/Users.EmptyEmailException"},{"$ref":"#\/components\/schemas\/Users.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/EmptyCountryException"},{"$ref":"#\/components\/schemas\/IncorrectCountryException"},{"$ref":"#\/components\/schemas\/EmptyLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneCountryException"},{"$ref":"#\/components\/schemas\/EmailUsedException"},{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneException"},{"$ref":"#\/components\/schemas\/IncorrectEmailValidationUrlSuccessException"},{"$ref":"#\/components\/schemas\/IncorrectEmailValidationUrlErrorException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/IncorrectContactListLanguageException"},{"$ref":"#\/components\/schemas\/IncorrectContactListCountryException"},{"$ref":"#\/components\/schemas\/IncorrectSourceException"},{"$ref":"#\/components\/schemas\/EmptyCurrentPasswordException"},{"$ref":"#\/components\/schemas\/Users.IncorrectCurrentPasswordException"},{"$ref":"#\/components\/schemas\/LinkClickScoreCannotBeEmptyException"},{"$ref":"#\/components\/schemas\/IncorrectColumnEntryNotificationFrequencyException"},{"$ref":"#\/components\/schemas\/IncorrectColumnEntryNotificationDigestTimeException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/UnauthorizedAnswerAiMarkPositiveException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Users"],"summary":"Delete an user account","description":"Delete an user account","operationId":"UsersDeleteById","parameters":[{"name":"user_id","in":"path","description":"ID of user to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/Users.DeleteUseMeEndpointException"},{"$ref":"#\/components\/schemas\/AdminAccountDeletionException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/me\/disable":{"put":{"tags":["Users"],"summary":"Disable","description":"Disable my user account","operationId":"UsersDisable","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/{user_id}\/disable":{"put":{"tags":["Users"],"summary":"Disable by ID","description":"Disable an user account","operationId":"UsersDisableById","parameters":[{"name":"user_id","in":"path","description":"ID of user to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/password\/forgot":{"put":{"tags":["Users"],"summary":"Forgot password","description":"Request a password reset for a user account. You will need to validate the operation by email.","operationId":"UsersForgotPassword","requestBody":{"content":{"application\/json":{"schema":{"required":["email"],"properties":{"email":{"description":"Identification email","type":"string","example":"jean.dupont@example.com"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Users.EmptyEmailException"},{"$ref":"#\/components\/schemas\/Users.IncorrectEmailException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"429":{"description":"Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TooManyAttemptsException"}]}}}}}}},"\/users\/password\/reset":{"put":{"tags":["Users"],"summary":"Reset password","description":"Reset user account password with a code sent by email","operationId":"UsersResetPassword","requestBody":{"content":{"application\/json":{"schema":{"required":["code","password"],"properties":{"code":{"description":"Code received by email","type":"string","example":"ABCDEF"},"password":{"description":"New password","type":"string","example":"Azerty123!"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyCodeException"},{"$ref":"#\/components\/schemas\/EmptyPasswordException"},{"$ref":"#\/components\/schemas\/IncorrectCodeException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}}}}},"\/users\/unlock":{"put":{"tags":["Users"],"summary":"Unlock user account","description":"Unlock user account with a code sent by sms","operationId":"UsersUnlockAccount","requestBody":{"content":{"application\/json":{"schema":{"required":["code"],"properties":{"code":{"description":"Code received by SMS","type":"string","example":"ABCDEF"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyCodeException"},{"$ref":"#\/components\/schemas\/IncorrectCodeException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}}}}},"\/users\/list":{"get":{"tags":["Users"],"summary":"Retrieve the list of users","description":"Fetch list of users in the same teams or organization as you, or in your resellers.<br><br>Limitation : Limited to 100 results per page.<br>Allowed field_name for filter\/sort : id, last_name, first_name, email, source, created_on, last_activity.","operationId":"UsersList","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"id"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)"},"results":{"description":"Displays the list of users","type":"array","items":{"$ref":"#\/components\/schemas\/UsersListData"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/list\/search":{"post":{"tags":["Users"],"summary":"Search users","description":"Search users in the same teams or organization as you, or in your resellers.<br><br>Limitation : Limited to 100 results per page.<br>Allowed field_name for filter\/sort: id, last_name, first_name, email, source, created_on, last_activity","operationId":"UsersListSearch","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"id"}},"type":"object"}},"type":"object"}]}}}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["query"],"properties":{"query":{"description":"Value of your search","type":"string","example":"abc"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)"},"results":{"description":"Displays the list of users","type":"array","items":{"$ref":"#\/components\/schemas\/UsersListData"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyQueryException"},{"$ref":"#\/components\/schemas\/QueryTooShortException"},{"$ref":"#\/components\/schemas\/SearchIdNotExistingException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/me\/avatar":{"post":{"tags":["Users"],"summary":"Upload an avatar to my user account","description":"Upload an avatar to my user account","operationId":"UsersUploadAvatar","requestBody":{"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"The avatar to upload. Maximum file size 2mb. Authorized file format : JPG \/ JPEG \/ PNG","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyFileException"},{"$ref":"#\/components\/schemas\/AvatarSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedAvatarFormatException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Users"],"summary":"Delete the avatar from my user account","description":"Delete the avatar from my user account","operationId":"UsersDeleteAvatar","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/{user_id}\/avatar":{"post":{"tags":["Users"],"summary":"Upload an avatar to a user account","description":"Upload an avatar to a user account","operationId":"UsersUploadAvatarById","parameters":[{"name":"user_id","in":"path","description":"ID of user to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"The avatar to upload. Maximum file size 2mb. Authorized file format : JPG \/ JPEG \/ PNG","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyFileException"},{"$ref":"#\/components\/schemas\/AvatarSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedAvatarFormatException"},{"$ref":"#\/components\/schemas\/Users.EmptyUserIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Users"],"summary":"Delete the avatar of a user account","description":"Delete the avatar of a user account","operationId":"UsersDeleteAvatarById","parameters":[{"name":"user_id","in":"path","description":"ID of user to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/users\/switch\/to\/{user_id}":{"post":{"tags":["Users"],"summary":"Switch to a user account","description":"Switch to a user account","operationId":"UsersSwitchTo","parameters":[{"name":"user_id","in":"path","description":"ID of user to switch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["token"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"token":{"description":"Display the switch token (For use in apiKey). The lifetime of this token is 60 minutes.","type":"string","example":"abcdefghijklmnopqrstuvwxyz"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedSwitchException"},{"$ref":"#\/components\/schemas\/Users.EmptyUserIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/oauth\/{provider}\/redirect":{"post":{"tags":["Users"],"summary":"Register or login using third party logins","description":"Register or login using third party logins. The request body will only be used if the account does not exist yet","operationId":"OauthRedirect","parameters":[{"name":"provider","in":"path","required":true,"schema":{"$ref":"#\/components\/schemas\/oauth.provider"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OauthRegisterOrLogin"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["location"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"location":{"description":"The url to go to continue the authentication"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/UserNotInResellerException"},{"$ref":"#\/components\/schemas\/MissingEmailException"},{"$ref":"#\/components\/schemas\/UserAccountLockedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnknownProviderException"}]}}}}}}},"\/users\/verification\/sms\/confirm":{"put":{"tags":["Users"],"summary":"Confirm account via SMS code","description":"Confirm account ownership using an SMS code","operationId":"UsersConfirmAccountSms","requestBody":{"content":{"application\/json":{"schema":{"required":["code"],"properties":{"code":{"description":"Code received by SMS","type":"string","example":"ABCDEF"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyCodeException"},{"$ref":"#\/components\/schemas\/IncorrectCodeException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}}}}},"\/users\/verification\/sms\/resend":{"post":{"tags":["Users"],"summary":"Resend SMS verification code","description":"Resend an SMS verification code","operationId":"UsersResendVerificationSms","requestBody":{"content":{"application\/json":{"schema":{"required":["mobile_phone","mobile_phone_country"],"properties":{"mobile_phone":{"description":"User mobile phone","type":"string","example":"33612345678"},"mobile_phone_country":{"description":"Mobile phone country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"domain_saas":{"description":"Current access domain name (ex: saas.domain.ext)","type":"string","example":"saas.domain.ext"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneCountryException"},{"$ref":"#\/components\/schemas\/IncorrectMobilePhoneException"},{"$ref":"#\/components\/schemas\/EmptyMobilePhoneException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}},"429":{"description":"Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TooManyAttemptsException"}]}}}}}}},"\/webhooks":{"get":{"tags":["Webhooks"],"summary":"Fetch list","description":"Retrieve the list of webhooks","operationId":"WebhooksFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["webhooks"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"webhooks":{"description":"Displays the list of your webhooks","type":"array","items":{"$ref":"#\/components\/schemas\/WebhookResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Webhooks"],"summary":"Create a webhook","description":"Create a webhook. Will send data using POST requests with a json object in the format of the schema *Webhooks.Data* every time a contact trigger the selected event.\n        You must respond with http code 200 in less than 2 seconds.","operationId":"WebhooksCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebhookCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["webhook_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"webhook_id":{"description":"Display the webhook ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/Webhooks.InvalidEventTypeException"},{"$ref":"#\/components\/schemas\/InvalidWebhookUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/webhooks\/{webhook_id}":{"get":{"tags":["Webhooks"],"summary":"Find profile","description":"Retrieve the profile of a webhook","operationId":"WebhooksFindProfileById","parameters":[{"name":"webhook_id","in":"path","description":"ID of webhook to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["webhook_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"webhook_profile":{"$ref":"#\/components\/schemas\/WebhookItem"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWebhookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WebhookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Webhooks"],"summary":"Update a webhook","description":"Update a webhook","operationId":"WebhooksUpdateProfileById","parameters":[{"name":"webhook_id","in":"path","description":"ID of webhook to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebhookUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/Webhooks.InvalidEventTypeException"},{"$ref":"#\/components\/schemas\/WebhookDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidWebhookUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWebhookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WebhookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Webhooks"],"summary":"Delete a webhook","description":"Delete a webhook","operationId":"WebhooksDelete","parameters":[{"name":"webhook_id","in":"path","description":"ID of webhook to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WebhookDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWebhookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WebhookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/webhooks\/{webhook_id}\/test":{"post":{"tags":["Webhooks"],"summary":"Test a webhook","description":"Test a webhook. Response is null in case of error.","operationId":"WebhooksTest","parameters":[{"name":"webhook_id","in":"path","description":"ID of webhook to test","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["response"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"response":{"description":"Is null if an error occured","type":"string","nullable":true}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWebhookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WebhookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows":{"get":{"tags":["Workflows"],"summary":"Fetch list","description":"Retrieve the list of workflows, including those shared to you","operationId":"WorkflowsFetchList","parameters":[{"name":"only_shared_with_reseller_customers","in":"query","description":"If true, only items shared with reseller customers will be shown, if null all items are returned","required":false,"schema":{"type":"boolean","nullable":true,"default":null}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["workflows"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"workflows":{"description":"Displays the list of your workflows","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Workflows"],"summary":"Create a workflow","description":"Create a workflow. A workflow must start with an action. Dummy action can be used as an initial step only.","operationId":"WorkflowsCreate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkflowCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["workflow_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"workflow_id":{"description":"Display the workflow ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/TooManyLevelsOfStepsException"},{"$ref":"#\/components\/schemas\/DuplicateStepIdException"},{"$ref":"#\/components\/schemas\/SameConsecutiveStepException"},{"$ref":"#\/components\/schemas\/ThereMustBeOneInitialStepAtRootException"},{"$ref":"#\/components\/schemas\/TooManyStepsException"},{"$ref":"#\/components\/schemas\/StepCantHaveItselfAsParentException"},{"$ref":"#\/components\/schemas\/ParentStepIdDoesNotExistException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/IntegrationDoesNotExistException"},{"$ref":"#\/components\/schemas\/ModelIdDoesNotMatchActionTypeException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/IntegrationIdDoesNotMatchActionTypeException"},{"$ref":"#\/components\/schemas\/ParentActionDoesNotMatchEventException"},{"$ref":"#\/components\/schemas\/CantSetBothPoolAndIntegrationException"},{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyPoolIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedPoolException"},{"$ref":"#\/components\/schemas\/PoolIdDoesNotMatchActionTypeException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/EmptyStepsException"},{"$ref":"#\/components\/schemas\/SomeEventMustHaveHigherWhenMinutesException"},{"$ref":"#\/components\/schemas\/ResponderEventWithAutoRemoveRespondersException"},{"$ref":"#\/components\/schemas\/SplitContactsEventCantHaveMultipleParentsException"},{"$ref":"#\/components\/schemas\/SplitContactsEventCantHaveFilterException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}":{"get":{"tags":["Workflows"],"summary":"Find profile","description":"Retrieve the profile of a workflow","operationId":"WorkflowsFindProfileById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["workflow_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"workflow_profile":{"$ref":"#\/components\/schemas\/WorkflowItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Workflows"],"summary":"Update profile","description":"Update a workflow profile. You can't update sharing if the workflow have already been programmed by someone else. Once a programmation have been started,\n        you are limited to the modifications of the steps. You can't delete or modify certain fields of a step that have been processed.","operationId":"WorkflowsUpdateProfileById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkflowUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/DuplicateStepIdException"},{"$ref":"#\/components\/schemas\/SameConsecutiveStepException"},{"$ref":"#\/components\/schemas\/ThereMustBeOneInitialStepAtRootException"},{"$ref":"#\/components\/schemas\/TooManyLevelsOfStepsException"},{"$ref":"#\/components\/schemas\/TooManyStepsException"},{"$ref":"#\/components\/schemas\/StepCantHaveItselfAsParentException"},{"$ref":"#\/components\/schemas\/ParentStepIdDoesNotExistException"},{"$ref":"#\/components\/schemas\/ModelDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelException"},{"$ref":"#\/components\/schemas\/IntegrationDoesNotExistException"},{"$ref":"#\/components\/schemas\/ModelIdDoesNotMatchActionTypeException"},{"$ref":"#\/components\/schemas\/UnauthorizedLinkedinAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/IntegrationIdDoesNotMatchActionTypeException"},{"$ref":"#\/components\/schemas\/ParentActionDoesNotMatchEventException"},{"$ref":"#\/components\/schemas\/CantSetBothPoolAndIntegrationException"},{"$ref":"#\/components\/schemas\/PoolDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyPoolIdException"},{"$ref":"#\/components\/schemas\/UnauthorizedPoolException"},{"$ref":"#\/components\/schemas\/PoolIdDoesNotMatchActionTypeException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/CantUpdateWorkflowSharingWithProgrammationException"},{"$ref":"#\/components\/schemas\/CantRemoveStepWithContactException"},{"$ref":"#\/components\/schemas\/ForbiddenModificationOfAStartedStepException"},{"$ref":"#\/components\/schemas\/ForbiddenParentModificationOfAStartedStepException"},{"$ref":"#\/components\/schemas\/LinkNotInMessageException"},{"$ref":"#\/components\/schemas\/EmptyStepsException"},{"$ref":"#\/components\/schemas\/SomeEventMustHaveHigherWhenMinutesException"},{"$ref":"#\/components\/schemas\/ResponderEventWithAutoRemoveRespondersException"},{"$ref":"#\/components\/schemas\/SplitContactsEventCantHaveMultipleParentsException"},{"$ref":"#\/components\/schemas\/SplitContactsEventCantHaveFilterException"},{"$ref":"#\/components\/schemas\/InvalidSharingArgumentException"},{"$ref":"#\/components\/schemas\/InvalidSharingIdsListException"},{"$ref":"#\/components\/schemas\/InvalidSharingNameException"},{"$ref":"#\/components\/schemas\/InvalidSharingPermissionException"},{"$ref":"#\/components\/schemas\/InvalidSharingTypeToException"},{"$ref":"#\/components\/schemas\/SharingReadPermissionMustBeTrueException"},{"$ref":"#\/components\/schemas\/TeamDoesNotExistException"},{"$ref":"#\/components\/schemas\/OrganizationDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"},{"$ref":"#\/components\/schemas\/TooManySharesException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/UnauthorizedTeamException"},{"$ref":"#\/components\/schemas\/UnauthorizedOrganizationException"},{"$ref":"#\/components\/schemas\/UnauthorizedProfileException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/UnauthorizedResellerException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedFolderException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Workflows"],"summary":"Delete a workflow","description":"Delete a workflow. Not possible if the workflow have already be programmed","operationId":"WorkflowsDelete","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/CantDeleteWorkflowWithProgrammationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/copy":{"post":{"tags":["Workflows"],"summary":"Copy a workflow","description":"Copy a workflow","operationId":"WorkflowsCopy","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["workflow_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"workflow_id":{"description":"Display the workflow ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/copy\/to\/{user_id}":{"post":{"tags":["Workflows"],"summary":"Copy a workflow to user ID","description":"Copy a workflow to user ID","operationId":"WorkflowsCopyTo","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to copy","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"user_id","in":"path","description":"ID of the user to copy the workflow to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":[],"properties":{"with_models":{"description":"Also copy attached models","type":"boolean","example":false}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["workflow_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"workflow_id":{"description":"Display the workflow ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/Exceptions.EmptyUserIdException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/program":{"post":{"tags":["Workflows"],"summary":"Program a workflow","description":"Program a workflow","operationId":"WorkflowsProgram","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to program","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkflowProgrammationCreate"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["workflow_programmation_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"workflow_programmation_id":{"description":"Display the workflow programmation ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/ShouldAllowAtLeastOneDayException"},{"$ref":"#\/components\/schemas\/AbProportionEmptyException"},{"$ref":"#\/components\/schemas\/Workflow.EmptyContactListIdsException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/LinkNotInMessageException"},{"$ref":"#\/components\/schemas\/UnauthorizedPriorityEmailException"},{"$ref":"#\/components\/schemas\/InvalidTimezoneException"},{"$ref":"#\/components\/schemas\/EmptyTagIdException"},{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/UnauthorizedTagException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}":{"get":{"tags":["Workflows"],"summary":"Find a workflow programmation","description":"Find a workflow programmation","operationId":"WorkflowsProgrammationFindProfileById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to find","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation to find","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["workflow_programmation_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"workflow_programmation_profile":{"$ref":"#\/components\/schemas\/WorkflowProgrammationItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Workflows"],"summary":"Update programmation profile","description":"Update a workflow programmation profile. You can't update certain fields if the programmation is already started. On contactlist_ids, you can only add new ids","operationId":"WorkflowsProgrammationUpdateProfileById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkflowProgrammationUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/ShouldAllowAtLeastOneDayException"},{"$ref":"#\/components\/schemas\/AbProportionEmptyException"},{"$ref":"#\/components\/schemas\/Workflow.EmptyContactListIdsException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationFieldNoUpdateStartedException"},{"$ref":"#\/components\/schemas\/UnauthorizedPriorityEmailException"},{"$ref":"#\/components\/schemas\/InvalidTimezoneException"},{"$ref":"#\/components\/schemas\/EmptyTagIdException"},{"$ref":"#\/components\/schemas\/TagDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/OnlyOwnerCanModifySharingException"},{"$ref":"#\/components\/schemas\/UnauthorizedTagException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/stop":{"put":{"tags":["Workflows"],"summary":"Stop a workflow programmation","description":"Stop a workflow programmation","operationId":"WorkflowsProgrammationStopById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation to stop","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationAlreadyStoppedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/resume":{"put":{"tags":["Workflows"],"summary":"Resume a workflow programmation","description":"Resume a stopped workflow programmation","operationId":"WorkflowsProgrammationResumeById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation to resume","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationAlreadyRunningException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/archive":{"put":{"tags":["Workflows"],"summary":"Archive a workflow programmation","description":"Archive a workflow programmation","operationId":"WorkflowsProgrammationArchiveById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation to archive","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationAlreadyArchivedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/unarchive":{"put":{"tags":["Workflows"],"summary":"Unarchive a workflow programmation","description":"Resume an archived workflow programmation","operationId":"WorkflowsProgrammationUnarchiveById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation to unarchive","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationAlreadyUnarchivedException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/step\/{step_id}\/stop":{"put":{"tags":["Workflows"],"summary":"Stop a workflow programmation step","description":"Stop a workflow programmation step","operationId":"WorkflowsProgrammationStepStopById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of step to stop","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepAlreadyStoppedException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepNotActionException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/step\/{step_id}\/resume":{"put":{"tags":["Workflows"],"summary":"Resume a workflow programmation step","description":"Resume a stopped workflow programmation step","operationId":"WorkflowsProgrammationStepResumeById","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of step to resume","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepAlreadyRunningException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/step\/{step_id}\/{contact_type}":{"get":{"tags":["Workflows"],"summary":"Get contacts by workflow programmation step and type","description":"Get contacts by workflow programmation step and type<br>Allowed field_name for filter\/sort: date_contacted, status_changed_date,\n        date_added_to_contact_list (can't be used on sort), all data fields ids, any_datafield (to search on all datafields, can't be used on sort)","operationId":"WorkflowsProgrammationGetContactsByStepAndType","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of step","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ContactType"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"date_contacted"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of your workflows programmations","type":"array","items":{"$ref":"#\/components\/schemas\/ProgrammationContactOutput"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepNotActionException"},{"$ref":"#\/components\/schemas\/ActionTypeDoesNotMatchContactTypeException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidContactTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/step\/{step_id}\/{contact_type}\/{file_type}":{"post":{"tags":["Workflows"],"summary":"Download contacts by workflow programmation step and type","description":"Download contacts by workflow programmation step and type.\n        <br>Allowed field_name for filter: status_changed_date, date_contacted, date_added_to_contact_list, all data fields ids, any_datafield (to search on all datafields)","operationId":"WorkflowsProgrammationDownloadContactsByStepAndType","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of step","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ContactType"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"contacts_selection":{"$ref":"#\/components\/schemas\/Workflows.ContactsSelection"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepNotActionException"},{"$ref":"#\/components\/schemas\/ActionTypeDoesNotMatchContactTypeException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidContactTypeException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/step\/{step_id}\/{contact_type}\/copy-to\/{contact_list_id_destination}":{"post":{"tags":["Workflows"],"summary":"Copy contacts of a workflow programmation step and type to a contact list","description":"Copy contacts of a workflow programmation step and contact type into a destination contact list. The copy runs asynchronously through a job.","operationId":"WorkflowsProgrammationCopyContactsByStepAndTypeToContactList","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of step","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ContactType"}},{"name":"contact_list_id_destination","in":"path","description":"ID of the destination contact list","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/Workflows.ContactsSelection"}],"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepNotActionException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidContactTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/step\/{step_id}\/{contact_type}\/blacklist\/{blacklist_id}":{"post":{"tags":["Workflows"],"summary":"Blacklist contacts by workflow programmation step and type","description":"Blacklist contacts by workflow programmation step, type, and blacklist ID. Allows to specify a blacklist to add the contacts.","operationId":"WorkflowsProgrammationBlacklistContactsByStepAndType","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of step","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ContactType"}},{"name":"blacklist_id","in":"path","description":"ID of the blacklist to add contacts to","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"date_contacted"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepNotActionException"},{"$ref":"#\/components\/schemas\/ActionTypeDoesNotMatchContactTypeException"},{"$ref":"#\/components\/schemas\/EmptyBlacklistIdException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/UnauthorizedBlacklistException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidContactTypeException"},{"$ref":"#\/components\/schemas\/BlacklistDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/step\/{step_id}\/click\/link\/{link_url}":{"get":{"tags":["Workflows"],"summary":"Get clicker contacts by workflow programmation step and type and link","description":"Get clicker contacts by workflow programmation step and type and link url<br>Allowed field_name for filter\/sort: date_contacted, status_changed_date,\n        date_added_to_contact_list (can't be used on sort), all data fields ids, any_datafield (to search on all datafields, can't be used on sort)","operationId":"WorkflowsProgrammationGetContactsClickerByStepAndTypeAndLink","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"ID of step","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"link_url","in":"path","required":true,"allowEmptyValue":false,"schema":{"type":"string"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"date_contacted"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of your workflows programmations","type":"array","items":{"$ref":"#\/components\/schemas\/ProgrammationContactOutput"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepNotActionException"},{"$ref":"#\/components\/schemas\/ActionTypeDoesNotMatchContactTypeException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidContactTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/{contact_type}":{"get":{"tags":["Workflows"],"summary":"Get contacts by workflow programmation and type","description":"Get contacts by workflow programmation and type<br>Allowed field_name for filter\/sort: status_changed_date,\n        date_added_to_contact_list (can't be used on sort), all data fields ids, any_datafield (to search on all datafields, can't be used on sort), contact_list_contacts_id","operationId":"WorkflowsProgrammationGetContactsByType","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ContactTypeProgrammation"}},{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"status_changed_date"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of your workflows programmations","type":"array","items":{"$ref":"#\/components\/schemas\/ProgrammationContactForProgrammationOutput"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidContactTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/{contact_type}\/{file_type}":{"post":{"tags":["Workflows"],"summary":"Download contacts by workflow programmation and type","description":"Download contacts by workflow programmation and type.\n        <br>Allowed field_name for filter: status_changed_date, date_added_to_contact_list, all data fields ids, any_datafield (to search on all datafields)","operationId":"WorkflowsProgrammationDownloadContactsByType","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow of the programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"workflow_programmation_id","in":"path","description":"ID of workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}},{"name":"contact_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ContactTypeProgrammation"}},{"name":"file_type","in":"path","required":true,"allowEmptyValue":false,"schema":{"$ref":"#\/components\/schemas\/ExportFileType"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"contacts_selection":{"$ref":"#\/components\/schemas\/Workflows.ContactsSelection"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/EmptyWorkflowProgrammationIdException"},{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepNotActionException"},{"$ref":"#\/components\/schemas\/ActionTypeDoesNotMatchContactTypeException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowProgrammationDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"},{"$ref":"#\/components\/schemas\/WorkflowProgrammationStepDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidContactTypeException"},{"$ref":"#\/components\/schemas\/UnknownFileTypeException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/programmations":{"get":{"tags":["Workflows"],"summary":"Fetch workflow programmations by workflow id","description":"Fetch workflow programmations by workflow id","operationId":"WorkflowsProgrammationFindProfilesByWorkflowId","parameters":[{"name":"workflow_id","in":"path","description":"ID of workflow to search","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays your workflows programmations","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowProgrammationResultItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyWorkflowIdException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/programmations":{"get":{"tags":["Workflows"],"summary":"Fetch workflow programmations","description":"Fetch workflow programmations<br>Allowed field_name for filter\/sort: id, created_on, workflow_id, date_start and for the following field_name \n        (which are only allowed on filter, not for sort), \n        should only be used with does_exist\/does_not_exist : contains_email_step, contains_smv_step, contains_sms_step,\n        contains_linkedin_message_step, contains_linkedin_invitation_step, contains_call_step<br><br>\n        You can use relative values (like -7 days, -4 hours, +4 hours or +1 week 2 hours by example) for the field date_start","operationId":"WorkflowsProgrammationFindProfiles","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"contains_linkedin_invitation_step"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays your workflows programmations","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowProgrammationResultItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/programmations\/contacts":{"get":{"tags":["Workflows"],"summary":"Fetch workflow programmations contacts","description":"Fetch workflow programmations contacts<br>Allowed field_name for filter\/sort: the same as for \n        \/workflows\/{workflow_id}\/programmation\/{workflow_programmation_id}\/{contact_type}","operationId":"WorkflowsProgrammationContacts","parameters":[{"name":"options","in":"query","required":false,"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"sort":{"properties":{"field_name":{"type":"string","example":"status_changed_date"}},"type":"object"}},"type":"object"}]}}}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_results":{"description":"Displays number of results (Limited to 100 results per page)","example":100},"results":{"description":"Displays the contacts of your workflows programmations","type":"array","items":{"$ref":"#\/components\/schemas\/ProgrammationContactForProgrammationOutput"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InvalidFilterException"},{"$ref":"#\/components\/schemas\/InvalidSortException"},{"$ref":"#\/components\/schemas\/InvalidPerPageException"},{"$ref":"#\/components\/schemas\/TooManyRecursiveFiltersException"},{"$ref":"#\/components\/schemas\/TooManyFiltersException"},{"$ref":"#\/components\/schemas\/ForbiddenFieldNameException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/exclude\/programmation\/{programmation_id}":{"get":{"tags":["Workflows"],"summary":"List exclusions of contacts from a programmation","description":"List exclusions of contacts from a programmation","operationId":"WorkflowsListExcludeContactWorkflowProgrammation","parameters":[{"name":"programmation_id","in":"path","description":"ID of the workflow programmation","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"exclusions":{"$ref":"#\/components\/schemas\/WorkflowProgrammationExclusion"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/exclude\/programmation\/{exclusion_id}":{"delete":{"tags":["Workflows"],"summary":"Remove exclusion of a contact from a programmation","description":"Remove exclusion of a contact from a programmation","operationId":"WorkflowsRemoveExcludeContactWorkflowProgrammation","parameters":[{"name":"exclusion_id","in":"path","description":"ID of the exclusion","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMExclusionIdDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/reply\/email\/{reply_id}\/download\/eml":{"get":{"tags":["Workflows"],"summary":"Download the eml of an email reply","description":"Download the eml of an email reply","operationId":"WorkflowsDownloadEmailReplyById","parameters":[{"name":"reply_id","in":"path","description":"ID of the email reply","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"message\/rfc822":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailReplyNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/sent\/email\/{id}\/download\/eml":{"get":{"tags":["Workflows"],"summary":"Download the eml of an email manually sent","description":"Download the eml of an email manually sent","operationId":"WorkflowsDownloadEmailManuallySentById","parameters":[{"name":"id","in":"path","description":"ID of the email sent","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"message\/rfc822":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowProgrammationException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailReplyNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/send\/email":{"post":{"tags":["Workflows"],"summary":"Send a single email","description":"Send individual email through specified email accounts, using SMTP\/Gmail\/Outlook integrations.\n        Either provide for tracking purposes : <br\/>\n        - contact_id and contact_list_id together<br\/>\n        - contact_id_prm<br\/>\n        - reply_id<br\/>\n        - programmation_contact_id","operationId":"WorkflowsSendEmail","requestBody":{"content":{"application\/json":{"schema":{"required":["email_account_id","recipients","subject","html"],"properties":{"email_account_id":{"description":"Email account ID to use (Only SMTP\/Gmail\/Outlook integrations)","type":"integer","example":1},"recipients":{"description":"List of the email addresses of the recipients","type":"array","items":{"type":"string","example":"jean.dupont@example.com"}},"subject":{"description":"Email subject","type":"string","example":"My email subject"},"html":{"description":"HTML content of your email","type":"string","example":"Example of the HTML content of my email"},"text":{"description":"Text content of your email","type":"string","example":"Example of the text content of my email"},"contact_list_id":{"description":"ID of the contact list where to contact profile to fetch (Used for datafields). Must be used together with contact_id.","type":"integer","example":1,"nullable":true},"contact_id":{"description":"ID of contact profile to fetch from contact list (Used for datafields). Must be used together with contact_list_id.","type":"integer","example":1,"nullable":true},"contact_id_prm":{"description":"ID of contact profile to fetch from PRM (Used for datafields). Cannot be used together with contact_list_id or contact_id.","type":"integer","example":1,"nullable":true},"reply_id":{"description":"ID of the email reply, used for tracking replies. This can be used instead of contact_id\/contact_list_id or contact_id_prm.","type":"integer","example":1,"nullable":true},"programmation_contact_id":{"description":"ID of the contact of the programmation.","type":"integer","example":1,"nullable":true},"email_signature_id":{"description":"ID of email signature to use. If not filled in, it automatically uses the signature linked to the email account.","type":"integer","example":1,"nullable":true},"cc_recipients":{"description":"List of the email addresses of the CC recipients","type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyRecipientsException"},{"$ref":"#\/components\/schemas\/IncorrectRecipientsException"},{"$ref":"#\/components\/schemas\/EmptySubjectException"},{"$ref":"#\/components\/schemas\/EmptyHTMLException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.InvalidEmailAccountException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.InvalidEmailAccountTypeException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmailAccountNoLongerValidException"},{"$ref":"#\/components\/schemas\/EmptyEmailSignatureIdException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListEmptyContactIdException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/send\/email-with-attachments":{"post":{"tags":["Workflows"],"summary":"Send a single email with attachments","description":"Send individual email with attachments through specified email accounts, using SMTP\/Gmail\/Outlook integrations.\n        Either provide for tracking purposes : <br\/>\n        - contact_id and contact_list_id together<br\/>\n        - contact_id_prm<br\/>\n        - reply_id<br\/>\n        - programmation_contact_id","operationId":"WorkflowsSendEmailWithAttachments","requestBody":{"content":{"multipart\/form-data":{"schema":{"required":["email_account_id","recipients","subject","html","attachments[]"],"properties":{"email_account_id":{"description":"Email account ID to use (Only SMTP\/Gmail\/Outlook integrations)","type":"integer","example":1},"recipients":{"description":"List of the email addresses of the recipients","type":"array","items":{"type":"string","example":"jean.dupont@example.com"}},"subject":{"description":"Email subject","type":"string","example":"My email subject"},"html":{"description":"HTML content of your email","type":"string","example":"Example of the HTML content of my email"},"text":{"description":"Text content of your email","type":"string","example":"Example of the text content of my email"},"contact_list_id":{"description":"ID of the contact list where to contact profile to fetch (Used for datafields). Must be used together with contact_id.","type":"integer","example":1,"nullable":true},"contact_id":{"description":"ID of contact profile to fetch from contact list (Used for datafields). Must be used together with contact_list_id.","type":"integer","example":1,"nullable":true},"contact_id_prm":{"description":"ID of contact profile to fetch from PRM (Used for datafields). Cannot be used together with contact_list_id or contact_id.","type":"integer","example":1,"nullable":true},"programmation_contact_id":{"description":"ID of the contact of the programmation.","type":"integer","example":1,"nullable":true},"reply_id":{"description":"ID of the email reply, used for tracking replies. This can be used instead of contact_id\/contact_list_id or contact_id_prm.","type":"integer","example":1,"nullable":true},"email_signature_id":{"description":"ID of email signature to use. If not filled in, it automatically uses the signature linked to the email account.","type":"integer","example":1,"nullable":true},"attachments[]":{"description":"List of attachments to be sent with the email (Maximum file size is 10MB)","type":"array","items":{"type":"string","format":"binary"}},"cc_recipients":{"description":"List of the email addresses of the CC recipients","type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyRecipientsException"},{"$ref":"#\/components\/schemas\/IncorrectRecipientsException"},{"$ref":"#\/components\/schemas\/IncorrectCcRecipientsException"},{"$ref":"#\/components\/schemas\/EmptySubjectException"},{"$ref":"#\/components\/schemas\/EmptyHTMLException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmptyIntegrationIdException"},{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.InvalidEmailAccountException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.InvalidEmailAccountTypeException"},{"$ref":"#\/components\/schemas\/IntegrationsEmail.EmailAccountNoLongerValidException"},{"$ref":"#\/components\/schemas\/EmptyEmailSignatureIdException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmptyContactListIdException"},{"$ref":"#\/components\/schemas\/ContactListEmptyContactIdException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedEmailAccountException"},{"$ref":"#\/components\/schemas\/UnauthorizedEmailSignatureException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailAccountDoesNotExistException"},{"$ref":"#\/components\/schemas\/EmailSignatureDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/{workflow_id}\/image":{"post":{"tags":["Workflows"],"summary":"Upload workflow image","description":"Upload a PNG\/SVG image for a workflow. Max size: 2MB.","operationId":"WorkflowsUploadImage","parameters":[{"name":"workflow_id","in":"path","description":"ID of the workflow","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"properties":{"image":{"description":"PNG\/SVG image file, max 2MB","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ImageSizeExceededException"},{"$ref":"#\/components\/schemas\/UnauthorizedImageFormatException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedWorkflowException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/ai-agent\/jobs":{"get":{"tags":["Workflows"],"summary":"Fetch AI agent workflow generation jobs","description":"Fetch recent asynchronous AI agent workflow generation jobs for the current user.","operationId":"WorkflowsAiAgentGenerationJobsFetchList","parameters":[{"name":"ai_agent_uniqid","in":"query","description":"Optional AI agent uniqid filter.","required":false,"schema":{"type":"string","nullable":true}},{"name":"state","in":"query","description":"Optional job state filter.","required":false,"schema":{"type":"string","nullable":true,"enum":["InQueue","InProgress","Completed","Failed","Cancelled"]}},{"name":"include_preview","in":"query","description":"Whether completed job preview payloads should be included.","required":false,"schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","description":"Maximum number of jobs to return.","required":false,"schema":{"type":"integer","default":50,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["jobs"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"jobs":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowAiAgentGenerationJobListItem"}}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/ai-agent\/jobs\/{job_uniqid}":{"get":{"tags":["Workflows"],"summary":"Fetch AI agent workflow generation status","description":"Fetch the status of an asynchronous AI agent workflow generation job.","operationId":"WorkflowsAiAgentGenerationJobGet","parameters":[{"name":"job_uniqid","in":"path","description":"Workflow AI generation job uniqid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/WorkflowAiAgentGenerationStatus"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/JobNotFoundException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/workflows\/ai-agent":{"post":{"tags":["Workflows"],"summary":"Queue AI agent workflow draft generation","description":"Queue an asynchronous workflow sequence draft generation from an AI agent. Poll the job endpoint with the returned uniqid to fetch generation details. Missing email or LinkedIn integrations do not prevent generation and are returned in preview missing_resources.","operationId":"WorkflowsAiAgentGenerate","requestBody":{"content":{"application\/json":{"schema":{"required":["ai_agent_uniqid","name","theme","nature","contactlist_ids"],"properties":{"ai_agent_uniqid":{"type":"string","example":"AIAGENT123456"},"name":{"type":"string","example":"Q2 outbound workflow"},"theme":{"type":"string","example":"Book demos with HR software companies"},"nature":{"$ref":"#\/components\/schemas\/WorkflowAiAgentNature"},"model_generation_mode":{"$ref":"#\/components\/schemas\/WorkflowAiAgentModelGenerationMode"},"auto_remove_responders":{"type":"boolean","default":true},"contactlist_ids":{"type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"responses":{"202":{"description":"Workflow generation job queued","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"$ref":"#\/components\/schemas\/WorkflowAiAgentQueuedJob"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/AiAgents.InvalidAiAgentCloneIdentityException"},{"$ref":"#\/components\/schemas\/Workflow.InvalidAiAgentWorkflowConfigurationException"},{"$ref":"#\/components\/schemas\/IncorrectLanguageException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyPromptException"},{"$ref":"#\/components\/schemas\/UnauthorizedModelGeneratorException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.UnauthorizedAiAgentException"},{"$ref":"#\/components\/schemas\/UnauthorizedContactListException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentDoesNotExistException"},{"$ref":"#\/components\/schemas\/ContactListDoesNotExistException"}]}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/AiAgents.AiAgentInactiveException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/zapier":{"get":{"tags":["Zapier"],"summary":"Fetch list","description":"Retrieve the list of Zapier hooks","operationId":"ZapierFetchList","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["zapier_hooks_list"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"zapier_hooks_list":{"description":"Displays the list of your Zapier hooks","type":"array","items":{"$ref":"#\/components\/schemas\/ZapierResultItem"}}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"post":{"tags":["Zapier"],"summary":"Create a Zapier hook","description":"Create a Zapier hook","operationId":"ZapierCreate","requestBody":{"content":{"application\/json":{"schema":{"required":["name","source","event","url","active","resend_synchronized_contacts"],"properties":{"name":{"description":"Name of the Zapier hook","type":"string"},"source":{"description":"Source type for the Zapier hook","type":"string","enum":["statistics","prm"]},"event":{"description":"Event type for the Zapier hook","type":"string","enum":["manual","every_24_hours","every_12_hours","every_6_hours","every_1_hour","every_3_months","every_1_month","every_1_week"]},"url":{"description":"Zapier webhook URL","type":"string","example":"https:\/\/hooks.zapier.com\/hooks\/catch\/1234\/abc\/"},"active":{"description":"Activate the Zapier hook ?","type":"boolean","example":false},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"description":"Only for source=prm<br>Allowed field_name for filter: id (contact id), status, custom_status, is_positive, created_on, score, status_changed_date, all data fields ids,\n                        any_datafield (to search on all datafields), last_link_click,\n                        last_email_open, last_email_answered, last_linkedin_invitation_accepted, last_linkedin_message_answered, last_call,\n                        last_sms_got, last_sms_not_got, last_reply, programmation_id, status_from_programmation (in the format \"status_id of programmation\"),\n                        contact_list_id, integration_id (using \"equals\" only), call_created_by (using \"equals\" only), person_in_charge, link_click (cannot be used on sort, using \"equals\" only)"},"resend_synchronized_contacts":{"description":"Resend synchronized contacts ?","type":"boolean","example":false}},"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"required":["zapier_hook_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"zapier_hook_id":{"description":"Display the Zapier hook ID","type":"integer","example":1}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/InvalidSourceException"},{"$ref":"#\/components\/schemas\/InvalidEventException"},{"$ref":"#\/components\/schemas\/EmptyZapierFilterException"},{"$ref":"#\/components\/schemas\/EmptyZapierUrlException"},{"$ref":"#\/components\/schemas\/InvalidZapierUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/zapier\/{zapier_hook_id}":{"get":{"tags":["Zapier"],"summary":"Find profile","description":"Retrieve the profile of a Zapier hook","operationId":"ZapierFindProfileById","parameters":[{"name":"zapier_hook_id","in":"path","description":"ID of Zapier hook to fetch","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"required":["zapier_hook_profile"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"},{"properties":{"zapier_hook_profile":{"$ref":"#\/components\/schemas\/ZapierItem"}},"type":"object"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyZapierHookIdException"},{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedZapierHookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"put":{"tags":["Zapier"],"summary":"Update profile","description":"Update a Zapier hook profile","operationId":"ZapierUpdateProfileById","parameters":[{"name":"zapier_hook_id","in":"path","description":"ID of Zapier hook to update","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"required":["source","event","url","active","resend_synchronized_contacts"],"properties":{"name":{"description":"Name of the Zapier hook","type":"string"},"source":{"description":"Source type for the Zapier hook","type":"string","enum":["statistics","prm"]},"event":{"description":"Event type for the Zapier hook","type":"string","enum":["manual","every_24_hours","every_12_hours","every_6_hours","every_1_hour","every_3_months","every_1_month","every_1_week"]},"url":{"description":"Zapier webhook URL","type":"string","example":"https:\/\/hooks.zapier.com\/hooks\/catch\/1234\/abc\/"},"active":{"description":"Activate the Zapier hook ?","type":"boolean","example":false},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"description":"Only for source=prm<br>Allowed field_name for filter: id (contact id), status, custom_status, is_positive, created_on, score, status_changed_date, all data fields ids,\n                        any_datafield (to search on all datafields), last_link_click,\n                        last_email_open, last_email_answered, last_linkedin_invitation_accepted, last_linkedin_message_answered, last_call,\n                        last_sms_got, last_sms_not_got, last_reply, programmation_id, status_from_programmation (in the format \"status_id of programmation\"),\n                        contact_list_id, integration_id (using \"equals\" only), call_created_by (using \"equals\" only), person_in_charge, link_click (cannot be used on sort, using \"equals\" only)"},"resend_synchronized_contacts":{"description":"Resend synchronized contacts ?","type":"boolean","example":false}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ValidationException"},{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidSourceException"},{"$ref":"#\/components\/schemas\/InvalidEventException"},{"$ref":"#\/components\/schemas\/EmptyZapierUrlException"},{"$ref":"#\/components\/schemas\/InvalidZapierUrlException"},{"$ref":"#\/components\/schemas\/EmptyNameException"},{"$ref":"#\/components\/schemas\/EmptyZapierFilterException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedZapierHookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Zapier"],"summary":"Delete a Zapier hook","description":"Delete a Zapier hook","operationId":"ZapierDelete","parameters":[{"name":"zapier_hook_id","in":"path","description":"ID of Zapier hook to delete","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyZapierHookIdException"},{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedZapierHookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/zapier\/{zapier_hook_id}\/activate":{"put":{"tags":["Zapier"],"summary":"Activate a Zapier hook","description":"Activate a Zapier hook","operationId":"ZapierActivate","parameters":[{"name":"zapier_hook_id","in":"path","description":"ID of Zapier hook to activate","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyZapierHookIdException"},{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedZapierHookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/zapier\/{zapier_hook_id}\/deactivate":{"put":{"tags":["Zapier"],"summary":"Deactivate a Zapier hook","description":"Deactivate a Zapier hook","operationId":"ZapierDeactivate","parameters":[{"name":"zapier_hook_id","in":"path","description":"ID of Zapier hook to deactivate","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyZapierHookIdException"},{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedZapierHookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/zapier\/{zapier_hook_id}\/test":{"post":{"tags":["Zapier"],"summary":"Test a Zapier hook","description":"Test a Zapier hook","operationId":"ZapierTest","parameters":[{"name":"zapier_hook_id","in":"path","description":"ID of Zapier hook to test","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyZapierHookIdException"},{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidZapierUrlException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedZapierHookException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"\/zapier\/{zapier_hook_id}\/send":{"post":{"tags":["Zapier"],"summary":"Send a Zapier hook","description":"Send a Zapier hook","operationId":"ZapierSend","parameters":[{"name":"zapier_hook_id","in":"path","description":"ID of Zapier hook to send","required":true,"allowEmptyValue":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"required":["contact_id"],"properties":{"contact_id":{"description":"Contact ID (PRM only)","type":"integer","nullable":true}},"type":"object"},{"type":"object","nullable":true,"allOf":[{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}]}]}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/stateSuccess"}]}}}},"400":{"description":"Invalid arguments","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/EmptyZapierHookIdException"},{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/InvalidFilterException"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/TokenEmptyException"},{"$ref":"#\/components\/schemas\/TokenDoesNotExistException"},{"$ref":"#\/components\/schemas\/TokenExpiredException"},{"$ref":"#\/components\/schemas\/UserAccountDisabledException"},{"$ref":"#\/components\/schemas\/EmailNotValidatedException"},{"$ref":"#\/components\/schemas\/SmsNotValidatedException"},{"$ref":"#\/components\/schemas\/YouMustReAuthenticateException"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/UnauthorizedZapierHookException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedContactException"},{"$ref":"#\/components\/schemas\/InsuffisantLevelRequiredException"},{"$ref":"#\/components\/schemas\/PRMUnauthorizedPRMException"}]}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/ZapierHookDoesNotExistException"},{"$ref":"#\/components\/schemas\/PRMContactDoesNotExistException"},{"$ref":"#\/components\/schemas\/UserDoesNotExistException"}]}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}}},"components":{"schemas":{"ApiKeyDoesNotExistException":{"description":"The API key does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_key_does_not_exist"]}},"type":"object"},"EmptyApiKeyIdException":{"description":"Empty API key id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_api_key_id"]}},"type":"object"},"UnauthorizedApiKeyException":{"description":"Unauthorized API key","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_api_key"]}},"type":"object"},"ActionNotExistException":{"description":"Action does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["action_not_exist"]}},"type":"object"},"EmptyAffiliateUserIdException":{"description":"Affiliate user ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_affiliate_user_id"]}},"type":"object"},"EmptyReferredUserIdException":{"description":"Referred user ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_referred_user_id"]}},"type":"object"},"ReferredUserIdDoesNotExistException":{"description":"Referred user ID does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["referred_user_id_does_not_exist"]}},"type":"object"},"AiAgents.AiAgentDoesNotExistException":{"description":"AI agent does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_agent_does_not_exist"]}},"type":"object"},"AiAgents.AiAgentInactiveException":{"description":"AI agent is inactive","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_agent_inactive"]}},"type":"object"},"AiAgents.EmptyAiAgentIdException":{"description":"AI agent id is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_ai_agent_id"]}},"type":"object"},"AiAgents.InvalidActionTypeException":{"description":"Invalid AI agent action type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_agents_invalid_action_type"]}},"type":"object"},"AiAgents.InvalidAiAgentCloneIdentityException":{"description":"AI agent clone identity is incomplete or inaccessible","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_agent_clone_identity_invalid"]}},"type":"object"},"AiAgents.InvalidAiAgentGeneratedBriefException":{"description":"Invalid AI agent generated brief","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_agents_invalid_generated_brief"]}},"type":"object"},"AiAgents.MissingBriefGenerationSourceException":{"description":"Missing AI agent brief generation source","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_agents_missing_brief_generation_source"]}},"type":"object"},"AiAgents.UnauthorizedAiAgentException":{"description":"Unauthorized AI agent","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_ai_agent"]}},"type":"object"},"AiModelStyleProfileRevisionDoesNotExistException":{"description":"AI model style profile revision does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_model_style_profile_revision_does_not_exist"]}},"type":"object"},"ApiLinkedin.AlreadyMappedException":{"description":"Session cookie already mapped","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["session_cookie_already_mapped"]}},"type":"object"},"ApiLinkedinNotFoundException":{"description":"Api linkedin not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_linkedin_not_found"]}},"type":"object"},"ApiLinkedin.EmptyAccountIdException":{"description":"Account ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_account_id"]}},"type":"object"},"ApiLinkedin.EmptyAccountNameException":{"description":"Account name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_account_name"]}},"type":"object"},"ApiLinkedin.EmptyApiLinkedinIdException":{"description":"API LinkedIn ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_api_linkedin_id"]}},"type":"object"},"ApiLinkedin.EmptyCountryException":{"description":"Country is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_linkedin_empty_country"]}},"type":"object"},"ApiLinkedin.EmptyEmailException":{"description":"Email is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_linkedin_empty_email"]}},"type":"object"},"ApiLinkedin.EmptyErrorException":{"description":"Error is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_error"]}},"type":"object"},"ApiLinkedin.EmptyFullNameException":{"description":"Full name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_full_name"]}},"type":"object"},"ApiLinkedin.EmptyHandleException":{"description":"Handle is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_handle"]}},"type":"object"},"ApiLinkedin.EmptyIdException":{"description":"ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_id"]}},"type":"object"},"ApiLinkedin.EmptyIntegrationIdException":{"description":"Integration ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_linkedin_empty_integration_id"]}},"type":"object"},"ApiLinkedin.EmptyIntegrationUidException":{"description":"IntegrationUID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_integration_uid"]}},"type":"object"},"ApiLinkedin.EmptyIntegrationsLinkedinApiIdException":{"description":"Integrations linkedin api id is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_integrations_linkedin_api_id"]}},"type":"object"},"ApiLinkedin.EmptyIntegrationsLinkedinApiJobIdException":{"description":"Integrations linkedin api job id is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_integrations_linkedin_api_job_id"]}},"type":"object"},"ApiLinkedin.EmptyJobIdException":{"description":"Job ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_job_id"]}},"type":"object"},"ApiLinkedin.EmptyJobSearchUrlsException":{"description":"Job search URLs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_job_search_urls"]}},"type":"object"},"ApiLinkedin.EmptyJobTypeException":{"description":"Job type is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_job_type_id"]}},"type":"object"},"ApiLinkedin.EmptyLimitTypeException":{"description":"Limit Type is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_limit_type"]}},"type":"object"},"EmptyLinkedinAccountNameException":{"description":"LinkedIn account name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_account_name"]}},"type":"object"},"ApiLinkedin.EmptyMessageException":{"description":"Message is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["linkedin_empty_message"]}},"type":"object"},"ApiLinkedin.EmptyPeopleSearchUrlsException":{"description":"People Search URLs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_people_search_urls"]}},"type":"object"},"ApiLinkedin.EmptyPostUrlsException":{"description":"Post URLs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_post_urls"]}},"type":"object"},"ApiLinkedin.EmptyProfileUrlException":{"description":"Profile URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_profile_url"]}},"type":"object"},"ApiLinkedin.EmptyProfileUrlsException":{"description":"Profile URLs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_profile_urls"]}},"type":"object"},"ApiLinkedin.EmptyRemoteIntegrationIdException":{"description":"Remote integration ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_remote_integration_id"]}},"type":"object"},"ApiLinkedin.EmptyRemoteUserIdException":{"description":"Remote user ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_remote_user_id"]}},"type":"object"},"ApiLinkedin.EmptySalesNavigatorProfileSearchUrlsException":{"description":"Sales Navigator Profile Search URLs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_sales_navigator_profile_search_urls"]}},"type":"object"},"ApiLinkedin.EmptySalesNavigatorUrlsException":{"description":"Sales Navigator URLs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_sales_navigator_urls"]}},"type":"object"},"ApiLinkedin.EmptySendUrlException":{"description":"Send URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_send_url_id"]}},"type":"object"},"ApiLinkedin.EmptySessionCookieException":{"description":"Session cookie is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_linkedin_empty_session_cookie"]}},"type":"object"},"ApiLinkedin.EmptyThreadIdException":{"description":"Thread ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_thread_id"]}},"type":"object"},"ApiLinkedin.EmptyUserIdException":{"description":"UserID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_linkedin_empty_user_id"]}},"type":"object"},"ApiLinkedin.EmptyUserUidException":{"description":"UserUID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_user_uid"]}},"type":"object"},"ApiLinkedin.IncorrectCountryException":{"description":"Country is not correct (ISO 3166 standard : 2 characters)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["api_linkedin_incorrect_country"]}},"type":"object"},"IntegrationsLinkedinNotFoundException":{"description":"Integrations linkedin not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integrations_linkedin_not_found"]}},"type":"object"},"ApiLinkedin.InvalidMessageException":{"description":"Message is invalid. An LinkedIn Invitation is limited to 300 characters.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_message"]}},"type":"object"},"LimitNotFoundException":{"description":"Limit not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["limit_not_found"]}},"type":"object"},"ApiLinkedin.LimitReachedException":{"description":"Limit reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["limit_reached"]}},"type":"object"},"ApiLinkedin.NeedSalesNavigatorAccountException":{"description":"Need sales navigator account","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["need_sales_navigator_account"]}},"type":"object"},"ApiLinkedin.NumberLinkedinInteractionsReachedException":{"description":"Number of Linkedin interactions reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["number_of_linkedin_interactions_reached"]}},"type":"object"},"ApiLinkedin.SessionCookieNotValidException":{"description":"Session cookie is not valid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["session_cookie_not_valid"]}},"type":"object"},"ApiOvh.AcceptAllPendingContractsException":{"description":"Failed to accept all pending contracts on OVH API","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["accept_all_pending_contracts_failed"]}},"type":"object"},"ApiOvh.AcceptContractException":{"description":"Failed to accept contract on OVH API","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["accept_contract_failed"]}},"type":"object"},"ApiOvh.AddDomainToCartFailedException":{"description":"Failed to add domain to cart","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["add_domain_to_cart_failed"]}},"type":"object"},"ApiOvh.AddDomainToEmailProServiceFailedException":{"description":"Add domain to EmailPro service failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["add_domain_to_emailpro_service_failed"]}},"type":"object"},"ApiOvh.AddEmailProToCartFailedException":{"description":"addEmailProToCart failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["add_emailpro_to_cart_failed"]}},"type":"object"},"ApiOvh.CheckDomainAvailabilityFailedException":{"description":"Failed to check domain availability","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["check_domain_availability_failed"]}},"type":"object"},"ApiOvh.CheckoutCartFailedException":{"description":"Failed to checkout cart","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["checkout_cart_failed"]}},"type":"object"},"ApiOvh.ConfigureEmailProAccountFailedException":{"description":"Configure EmailPro account failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["configure_emailpro_account_failed"]}},"type":"object"},"ApiOvh.CouldNotValidateCredentialsException":{"description":"Could not validate credentials","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["could_not_validate_credentials"]}},"type":"object"},"ApiOvh.DeleteEmailProAccountFailedException":{"description":"Delete EmailPro account failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["delete_emailpro_account_failed"]}},"type":"object"},"ApiOvh.DisableAutoRenewFailedException":{"description":"Disable auto-renew failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["disable_autorenew_failed"]}},"type":"object"},"ApiOvh.DomainAlreadyExistsOnServiceException":{"description":"Domain already exists on EmailPro service","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_already_exists_on_service"]}},"type":"object"},"ApiOvh.DomainDoesNotExistException":{"description":"The domain does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_does_not_exist_on_saas"]}},"type":"object"},"ApiOvh.DomainNotAvailableException":{"description":"The domain is not available for purchase","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_not_available"]}},"type":"object"},"ApiOvh.EmailAlreadyExistsException":{"description":"Email already exists for the given domain","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_already_exists"]}},"type":"object"},"ApiOvh.EmailDoesNotExistException":{"description":"The email does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_does_not_exist"]}},"type":"object"},"ApiOvh.EmailProAddressAlreadyUsedException":{"description":"Email address is already used by an account on the EmailPro service","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["emailpro_address_already_used"]}},"type":"object"},"ApiOvh.EmailProSlotAlreadyAvailableException":{"description":"There is already an available Email Pro slot","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_pro_slot_already_available"]}},"type":"object"},"ApiOvh.GetAllDomainsFailedException":{"description":"Get all domains failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_all_domains_failed"]}},"type":"object"},"ApiOvh.GetCartDetailsFailedException":{"description":"Failed to get cart details","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_cart_details_failed"]}},"type":"object"},"ApiOvh.GetConfiguremeEmailAccountFailedException":{"description":"Get configureme.me email account failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_configureme_email_account_failed"]}},"type":"object"},"ApiOvh.GetContractsException":{"description":"Failed to retrieve contracts from OVH API","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_contracts_failed"]}},"type":"object"},"ApiOvh.GetDefaultPaymentMeanForOrderFailedException":{"description":"getDefaultPaymentMeanForOrder failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_default_payment_mean_for_order_failed"]}},"type":"object"},"ApiOvh.GetDomainServiceStatusFailedException":{"description":"Failed to get domain service status","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_domain_service_status_failed"]}},"type":"object"},"ApiOvh.GetEmailProAccountInfoException":{"description":"Failed to retrieve EmailPro account info from OVH API","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_email_pro_account_info_failed"]}},"type":"object"},"ApiOvh.GetEmailProTaskStatusException":{"description":"Failed to retrieve EmailPro task status from OVH API","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_email_pro_task_status_failed"]}},"type":"object"},"ApiOvh.GetEmailsForDomainFailedException":{"description":"Get emails for domain failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_emails_for_domain_failed"]}},"type":"object"},"ApiOvh.GetOrderDetailsFailedException":{"description":"Get order details failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_order_details_failed"]}},"type":"object"},"ApiOvh.GetOrderStatusFailedException":{"description":"Get order status failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["get_order_status_failed"]}},"type":"object"},"ApiOvh.HasDefaultPaymentMethodFailedException":{"description":"Failed to check default payment method","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["has_default_payment_method_failed"]}},"type":"object"},"ApiOvh.HasFreeEmailProAccountFailedException":{"description":"hasFreeEmailProAccount failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["has_free_emailpro_account_failed"]}},"type":"object"},"ApiOvh.InvalidDomainFormatException":{"description":"Invalid domain format","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_domain_format"]}},"type":"object"},"ApiOvh.InvalidDomainResponseStructureException":{"description":"Invalid domain response structure","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_domain_response_structure"]}},"type":"object"},"ApiOvh.InvalidDomainStateException":{"description":"Invalid state for domain","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_domain_state"]}},"type":"object"},"ApiOvh.InvalidEmailFormatException":{"description":"The provided email format is invalid. Each email must include a prefix, password, and display name.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_email_format"]}},"type":"object"},"ApiOvh.InvalidOrderStatusFormatException":{"description":"Invalid order status format","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_order_status_format"]}},"type":"object"},"ApiOvh.InvalidTaskStatusException":{"description":"Invalid task status returned from OVH API","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_task_status"]}},"type":"object"},"ApiOvh.IsDomainReadyFailedException":{"description":"Failed to check if domain is ready","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["is_domain_ready_failed"]}},"type":"object"},"ApiOvh.MissingApiCredentialsException":{"description":"Missing API credentials","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["missing_api_credentials"]}},"type":"object"},"ApiOvh.NoAvailableEmailProServicesException":{"description":"No available Email Pro services","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_available_email_pro_services"]}},"type":"object"},"ApiOvh.NoConfiguremeEmailAccountFoundException":{"description":"No configureme.me email account found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_configureme_email_account_found"]}},"type":"object"},"ApiOvh.NoEmailProOfferAvailableForThisServiceException":{"description":"No EmailPro offer available for this service","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_emailpro_offer_available_for_this_service"]}},"type":"object"},"ApiOvh.NoEmailProServicesAvailableForOrderingException":{"description":"No Email Pro services available for ordering","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_email_pro_services_available_for_ordering"]}},"type":"object"},"ApiOvh.NoMonthlyPriceInfoAvailableForEmailProOfferException":{"description":"No monthly (P1M) price info available for EmailPro offer","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_monthly_price_info_available_for_emailpro_offer"]}},"type":"object"},"ApiOvh.NoValidDefaultPaymentMeanFoundException":{"description":"No valid default payment mean found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_valid_default_payment_mean_found"]}},"type":"object"},"ApiOvh.OrderEmailProAccountFailedException":{"description":"Order Email Pro account failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["order_email_pro_account_failed"]}},"type":"object"},"ApiOvh.PayOrderWithRegisteredPaymentMeanFailedException":{"description":"payOrderWithRegisteredPaymentMean failed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["pay_order_with_registered_payment_mean_failed"]}},"type":"object"},"ApiOvh.UnauthorizedDomainException":{"description":"The domain is not authorized","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_domain"]}},"type":"object"},"ApiOvh.UserAccountNotReadyForOrderingException":{"description":"The OVH account is not ready to place orders (missing payment method or email pro service)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_account_not_ready_for_ordering"]}},"type":"object"},"ApiOvh.UserHasNoDefaultPaymentMeanException":{"description":"User has no default payment mean","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_has_no_default_payment_mean"]}},"type":"object"},"warmup_account_verification_failed":{"required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["warmup_account_verification_failed"]}},"type":"object"},"TokenDoesNotExistException":{"description":"The TOKEN does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["token_not_exist"]}},"type":"object"},"TokenEmptyException":{"description":"The TOKEN is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["token_empty"]}},"type":"object"},"TokenExpiredException":{"description":"The TOKEN is expired","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["token_expired"]}},"type":"object"},"YouMustReAuthenticateException":{"description":"You must re-authenticate","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["you_must_re_authenticate"]}},"type":"object"},"BlacklistDoesNotExistException":{"description":"Blacklist does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["blacklist_does_not_exist"]}},"type":"object"},"CannotDeleteAutomaticBlacklistException":{"description":"You cannot delete blacklists created automatically","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cannot_delete_automatic_blacklist"]}},"type":"object"},"EmptyBlacklistIdException":{"description":"Blacklist ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_blacklist_id"]}},"type":"object"},"EmptyBlacklistIdsException":{"description":"Blacklist IDs are empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_blacklist_ids"]}},"type":"object"},"BlacklistEmptyData":{"description":"No data in the blacklist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["blacklist_empty_data"]}},"type":"object"},"UnauthorizedBlacklistException":{"description":"Unauthorized blacklist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_blacklist"]}},"type":"object"},"CantDeleteAllFields":{"description":"You cannot delete all fields","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cant_delete_all_fields"]}},"type":"object"},"ContactDoesNotExistException":{"description":"Contact does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["contact_does_not_exist"]}},"type":"object"},"ContactInfoAlreadyExistException":{"description":"Another contact with the same information already exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["contact_info_already_exist"]}},"type":"object"},"ContactListDoesNotExistException":{"description":"Contact list does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["contact_list_does_not_exist"]}},"type":"object"},"DestinationContactListDoesNotExistException":{"description":"Destination contact list does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["destination_contact_list_does_not_exist"]}},"type":"object"},"ContactListEmptyContactIdException":{"description":"Contact ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_contact_id"]}},"type":"object"},"EmptyContactIdsException":{"description":"Contact IDs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_contact_ids"]}},"type":"object"},"EmptyContactListIdDestinationException":{"description":"ID of the destination contact list is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_contact_list_id_destination"]}},"type":"object"},"EmptyContactListIdException":{"description":"Contact list ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_contact_list_id"]}},"type":"object"},"ContactList.EmptyContactListIdsException":{"description":"Contact list IDs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["contactlist_empty_contact_list_ids"]}},"type":"object"},"EmptyContactsException":{"description":"Contacts is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_contacts"]}},"type":"object"},"EmptyDatafieldAiPromptException":{"description":"Empty prompt","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_datafield_ai_prompt"]}},"type":"object"},"EmptyDatafieldInPromptException":{"description":"You must provide at least one datafield in the prompt","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_datafield_in_prompt"]}},"type":"object"},"ContactList.EmptyEmailException":{"description":"Email is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["contactlist_empty_email"]}},"type":"object"},"EmptyIceBreakerSubjectException":{"description":"Empty subject","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_icebreaker_subject"]}},"type":"object"},"EmptyNumberListsException":{"description":"How many lists would you like to split your list into ?","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_number_lists"]}},"type":"object"},"EmptyPropertiesException":{"description":"Properties is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_properties"]}},"type":"object"},"IncorrectVersionException":{"description":"Version is not correct (1 or 2)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_version"]}},"type":"object"},"InvalidContactListIdException":{"description":"Invalid contact list id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_contact_list_id"]}},"type":"object"},"InvalidContactsFileException":{"description":"Invalid contacts file","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_contacts_file"]}},"type":"object"},"InvalidEnrichExternalApiException":{"description":"Invalid enrich external api","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_enrich_external_api"]}},"type":"object"},"MaxDatafieldAiPerMonthReachedException":{"description":"Maximum number of Datafield Ai per month has been reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["max_datafield_ai_per_month_reached"]}},"type":"object"},"MaxEmailsGeneratedPerMonthReachedException":{"description":"Maximum number of emails generated per month has been reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["max_emails_generated_per_month_reached"]}},"type":"object"},"MaxIceBreakerPerMonthReachedException":{"description":"Maximum number of icebreakers per month has been reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["max_icebreaker_per_month_reached"]}},"type":"object"},"MaxMobilePhonesGeneratedPerMonthReachedException":{"description":"Maximum number of mobile phones per month has been reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["max_mobile_phones_per_month_reached"]}},"type":"object"},"MissingDatafieldValuesException":{"description":"Some datafields in the contact list have no values.","required":["state","missing_datafields","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"missing_datafields":{"description":"IDs of datafields with no values in the contact list.","type":"array","items":{"type":"integer"},"nullable":false},"state_message":{"description":"Details of the error","type":"string","enum":["missing_datafield_values"]}},"type":"object"},"MultipleContactInfoAlreadyExistException":{"description":"Multiple contacts with the same information already exist","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["multiple_contact_info_already_exist"]}},"type":"object"}]},"NoLinkedInContactsException":{"description":"No contacts with a LinkedIn link found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_linkedin_contacts"]}},"type":"object"},"NumberListExceededException":{"description":"You can divide your list into up to 100 lists","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["number_list_exceeded"]}},"type":"object"},"UnauthorizedContactListException":{"description":"Unauthorized contact list","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_contact_list"]}},"type":"object"},"UnauthorizedCopyingToPrmException":{"description":"Unauthorized for copying to PRM","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_copying_to_prm"]}},"type":"object"},"UnauthorizedDestinationContactListException":{"description":"Unauthorized destination contact list","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_destination_contact_list"]}},"type":"object"},"UnauthorizedEmailVerifierException":{"description":"Unauthorized to verify emails","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_verify_emails"]}},"type":"object"},"UnauthorizedGenerateDatafieldAiException":{"description":"Unauthorized to generate DatafieldAi","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_generate_datafield_ai"]}},"type":"object"},"UnauthorizedGenerateIceBreakerException":{"description":"Unauthorized to generate IceBreaker","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_generate_ice_breaker"]}},"type":"object"},"UnauthorizedIceBreakerVersionException":{"description":"Unauthorized to use this version of IceBreaker","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_ice_breaker_version"]}},"type":"object"},"cannot_change_cron_type":{"description":"You cannot change the cron type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cannot_change_cron_type"]}},"type":"object"},"CronDoesNotExistException":{"description":"Cron does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cron_does_not_exist"]}},"type":"object"},"EmptyCronIdException":{"description":"Empty cron id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_cron_id"]}},"type":"object"},"EmptyCronNameException":{"description":"Empty cron name","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_cron_name"]}},"type":"object"},"InvalidFrequencyException":{"description":"Invalid frequency","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["crons_invalid_frequency"]}},"type":"object"},"InvalidHookUrlException":{"description":"Invalid hook url","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cron_invalid_hook_url"]}},"type":"object"},"crons_invalid_type":{"description":"Invalid type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["crons_invalid_type"]}},"type":"object"},"ThisCronDoesNotSupportTestException":{"description":"This cron does not support test","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["this_cron_does_not_support_test"]}},"type":"object"},"UnauthorizedCronException":{"description":"Unauthorized cron","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_cron"]}},"type":"object"},"DataFieldDoesNotExistException":{"description":"Data field does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["data_field_does_not_exist"]}},"type":"object"},"EmptyDataFieldIdException":{"description":"Data field ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_data_field_id"]}},"type":"object"},"InvalidIdentifierException":{"description":"The identifier is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_identifier"]}},"type":"object"},"UnauthorizedDataFieldException":{"description":"Unauthorized data field","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_data_field"]}},"type":"object"},"DataValidationError":{"properties":{"line":{"type":"integer","example":1,"nullable":true},"error":{"type":"string","example":"The value must be a string."}},"type":"object"},"DataValidationException":{"description":"The data submitted is incorrect","required":["state","state_message","errors"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["data_validation_exception"]},"errors":{"description":"List of errors","type":"array","items":{"$ref":"#\/components\/schemas\/DataValidationError"}}},"type":"object"},"DatabaseConnectionErrorException":{"description":"Cannot connect to the database","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["database_connection_error"]}},"type":"object"}]},"EmptyEmailRawException":{"description":"Email raw is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_email_raw"]}},"type":"object"},"EmailErrorException":{"description":"An error occurred while sending the email","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["mail_error"]}},"type":"object"}]},"EmailSignatureDoesNotExistException":{"description":"Email signature does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_signature_does_not_exist"]}},"type":"object"},"EmptyEmailSignatureIdException":{"description":"Email signature ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_email_signature_id"]}},"type":"object"},"EmptyHtmlTextException":{"description":"HTML and TEXT is empty. You must fill in one of the two options.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_html_text"]}},"type":"object"},"EmailSignatures.InvalidJsonTemplateException":{"description":"JSON template is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_signatures_invalid_json_template"]}},"type":"object"},"UnauthorizedEmailSignatureException":{"description":"Unauthorized email signature","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_email_signature"]}},"type":"object"},"EmptyDataException":{"description":"Data is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_data"]}},"type":"object"},"EmptyDataIdException":{"description":"Data ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_data_id"]}},"type":"object"},"EmptyFileException":{"description":"File is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_file"]}},"type":"object"},"EmptyFilenameException":{"description":"Filename is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_filename"]}},"type":"object"},"EmptyLevelException":{"description":"Level is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_level"]}},"type":"object"},"EmptyLocalFilenameException":{"description":"Local filename is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_local_filename"]}},"type":"object"},"EmptyNameException":{"description":"Name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_name"]}},"type":"object"},"EmptyPromptException":{"description":"Prompt is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_prompt"]}},"type":"object"},"EmptyQueryException":{"description":"Query is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_query"]}},"type":"object"},"EmptyUniqIdException":{"description":"Uniqid is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_uniqid"]}},"type":"object"},"Exceptions.EmptyUserIdException":{"description":"User ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_user_id"]}},"type":"object"},"EnrichBatchEmptyContactsException":{"description":"Enrich batch contacts list is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["enrich_batch_empty_contacts"]}},"type":"object"},"EnrichBatchNotFoundException":{"description":"Enrich batch not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["enrich_batch_not_found"]}},"type":"object"},"EnrichBatchTooManyContactsException":{"description":"Enrich batch cannot exceed 100 contacts","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["enrich_batch_too_many_contacts"]}},"type":"object"},"ErrorOccuredException":{"description":"An error has occurred","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["an_error_has_occurred"]}},"type":"object"}]},"ErrorOccuredNoLogException":{"description":"An error has occurred","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["an_error_has_occurred_no_log"]}},"type":"object"},"EmptyExternalAPiKeyIdException":{"description":"Empty external API key id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_external_api_key_id"]}},"type":"object"},"EmptyExternalApiKeyNameException":{"description":"Empty external API key name","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_external_api_key_name"]}},"type":"object"},"ExternalApiKeyDoesNotExistException":{"description":"The external API key does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["external_api_key_does_not_exist"]}},"type":"object"},"InvalidApiKeyException":{"description":"Invalid API key","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_api_key"]}},"type":"object"},"external_api_keys.invalid_type_key":{"description":"Invalid API key type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["external_api_keys.invalid_type_key"]}},"type":"object"},"UnauthorizedExternalApiKeyException":{"description":"Unauthorized external API key","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_external_api_key"]}},"type":"object"},"EmptyFileIdException":{"description":"File ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_file_id"]}},"type":"object"},"Files.FileDoesNotExistException":{"description":"File does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["file_does_not_exist"]}},"type":"object"},"FileSizeExceededException":{"description":"File size is exceeded. Maximum file size is 50mb.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["file_size_is_exceeded"]}},"type":"object"},"InvalidFileException":{"description":"Invalid file provided.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_file"]}},"type":"object"},"UnauthorizedFileException":{"description":"Unauthorized file","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_file"]}},"type":"object"},"UnauthorizedFileFormatException":{"description":"Authorized file format : JPG \/ JPEG \/ PNG \/ GIF \/ PDF \/ POT \/ POTX \/ PPT \/ PPTX \/ XLS \/ XLSX \/ HTML \/ DOC \/ DOCX","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_file_format"]}},"type":"object"},"EmptyFilterException":{"description":"One filter is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_filter"]}},"type":"object"},"ForbiddenFieldNameException":{"description":"Forbidden field name","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["forbidden_field_name"]}},"type":"object"},"InvalidFilterException":{"description":"Filter is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_filter"]}},"type":"object"},"InvalidPerPageException":{"description":"Per_page value is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_per_page"]}},"type":"object"},"InvalidSortException":{"description":"Sort is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_sort"]}},"type":"object"},"TooManyFiltersException":{"description":"Too many filters","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["too_many_filters"]}},"type":"object"},"TooManyRecursiveFiltersException":{"description":"Too many recursive filters","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["too_many_recursive_filters"]}},"type":"object"},"CannotCreateSubSubFolderException":{"description":"You cannot create a sub sub folder","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cannot_create_sub_sub_folder"]}},"type":"object"},"EmptyFolderIdException":{"description":"Empty folder id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_folder_id"]}},"type":"object"},"FolderDoesNotExistException":{"description":"The folder does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["folder_does_not_exist"]}},"type":"object"},"InvalidFolderIdException":{"description":"Invalid folder id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_folder_id"]}},"type":"object"},"InvalidTypeException":{"description":"The folder type does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_folder_type"]}},"type":"object"},"TypeDoesNotMatchException":{"description":"The folder type does not match","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["folder_type_does_not_match"]}},"type":"object"},"UnauthorizedFolderException":{"description":"Unauthorized folder","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_folder"]}},"type":"object"},"EmptyFormContactListIdException":{"description":"Empty form contact list id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_form_contact_list_id"]}},"type":"object"},"EmptyFormDataException":{"description":"Form data is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_form_data"]}},"type":"object"},"EmptyFormHTMLException":{"description":"HTML is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_form_html"]}},"type":"object"},"EmptyFormIdException":{"description":"Empty form id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_form_id"]}},"type":"object"},"EmptyFormNameException":{"description":"Empty form name","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_form_name"]}},"type":"object"},"FormDoesNotExistException":{"description":"The form does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["form_does_not_exist"]}},"type":"object"},"FormNotReadyException":{"description":"The form is not ready to be used","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["form_not_ready"]}},"type":"object"},"InvalidFormDataException":{"description":"Form data contains non-scalar values that cannot be cast to string, or identifiers or values that are not valid UTF-8.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_form_data"]}},"type":"object"},"InvalidIdentifiersFoundException":{"description":"Some identifiers in the form do not match the data fields.","required":["state","invalid_identifiers","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"invalid_identifiers":{"description":"The list of invalid identifiers found in the form.","type":"array","items":{"type":"string"},"nullable":false},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_identifiers_found"]}},"type":"object"},"MissingFormFieldsException":{"description":"The form contains no input, textarea, or select fields.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["missing_form_fields"]}},"type":"object"},"MissingFormTagException":{"description":"The form tag is missing or empty in the HTML document.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["missing_form_tag"]}},"type":"object"},"UnauthorizedFormException":{"description":"Unauthorized form","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_form"]}},"type":"object"},"GenericBadRequestException":{"description":"Bad request","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["bad_request"]}},"type":"object"},"ImportLimitExceededException":{"description":"Import limit exceeded","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["import_limit_exceeded"]}},"type":"object"},"InMaintenanceException":{"description":"Service is in maintenance","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["in_maintenance"]}},"type":"object"},"IncorrectDomainSaas2Exception":{"description":"Domain SAAS 2 is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_domain_saas2"]}},"type":"object"},"IncorrectDomainSaas3Exception":{"description":"Domain SAAS 3 is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_domain_saas3"]}},"type":"object"},"IncorrectDomainSaasException":{"description":"Domain SAAS is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_domain_saas"]}},"type":"object"},"IngressesDomainAlreadyExists":{"description":"Domain already exists","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ingresses_domain_already_exists"]}},"type":"object"},"IngressesDomainDoesNotExist":{"description":"Domain does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ingresses_domain_does_not_exist"]}},"type":"object"},"IngressesDomainInUse":{"description":"Domain is currently in use","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ingresses_domain_in_use"]}},"type":"object"},"DomainUsedForResellersException":{"description":"Domain is used for resellers","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_used_for_resellers"]}},"type":"object"},"IngressesEmptyDomain":{"description":"The domain is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ingresses_empty_domain"]}},"type":"object"},"IngressesEmptyStatus":{"description":"The status is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ingresses_empty_status"]}},"type":"object"},"IngressesIncorrectDomain":{"description":"Domain is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ingresses_incorrect_domain"]}},"type":"object"},"IngressesIncorrectStatus":{"description":"The status is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ingresses_incorrect_status"]}},"type":"object"},"InsuffisantLevelRequiredException":{"description":"You do not have the required level","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["insufficient_level_required"]}},"type":"object"},"IntegrationDoesNotExistException":{"description":"Integration account does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integration_does_not_exist"]}},"type":"object"},"IntegrationsEmail.AutodiscoverNotFoundException":{"description":"Autodiscover service not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["autodiscover_not_found"]}},"type":"object"},"IntegrationsEmail.AutodiscoverServiceException":{"description":"Error with the Autodiscover service","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["autodiscover_service_error"]}},"type":"object"},"BadImapCredentialsException":{"description":"IMAP credentials are not valid. We were unable to connect.","required":["state","error_details","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"error_details":{"description":"IMAP error details","type":"string","nullable":true},"state_message":{"description":"Details of the error","type":"string","enum":["bad_imap_credentials"]}},"type":"object"},"BadImapSecureException":{"description":"Possible values : tls\/ssl","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["bad_imap_secure"]}},"type":"object"},"BadMailgunCredentialsException":{"description":"Mailgun credentials are not valid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["bad_mailgun_credentials"]}},"type":"object"},"BadMailgunWebhookSignatureException":{"description":"Mailgun webhook signature is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["bad_mailgun_webhook_signature"]}},"type":"object"},"BadSmtpCredentialsException":{"description":"The SMTP credentials are not valid. We were unable to connect.","required":["state","error_details","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"error_details":{"description":"SMTP error details","type":"string","nullable":true},"state_message":{"description":"Details of the error","type":"string","enum":["bad_smtp_credentials"]}},"type":"object"},"BadSmtpSecureException":{"description":"Possible values : tls\/ssl","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["bad_smtp_secure"]}},"type":"object"},"CustomTrackingDomainUsedForResellersException":{"description":"Custom tracking domain is used for resellers","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["custom_tracking_domain_used_for_resellers"]}},"type":"object"},"EmailAccountDoesNotExistException":{"description":"Email account does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_account_does_not_exist"]}},"type":"object"},"IntegrationsEmail.EmailAccountNoLongerValidException":{"description":"Email account no longer valid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_account_no_longer_valid"]}},"type":"object"},"IntegrationsEmail.EmailAlreadyExistsOnThisAccountException":{"description":"Email already exists on this account","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_already_exists_on_this_account"]}},"type":"object"},"EmptyAfterDateException":{"description":"After date is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_after_date"]}},"type":"object"},"IntegrationsEmail.EmptyEmailAccountIdsException":{"description":"Email account IDs is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integrations_email_empty_email_account_ids"]}},"type":"object"},"IntegrationsEmail.EmptyEmailException":{"description":"Email address is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integrations_email_empty_email"]}},"type":"object"},"IntegrationsEmail.EmptyFinalRedirectUrlException":{"description":"Final redirect url is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_final_redirect_url"]}},"type":"object"},"EmptyImapHostException":{"description":"IMAP Host is empty (Is required if you have entered a value in another IMAP variable)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_imap_host"]}},"type":"object"},"EmptyImapPasswordException":{"description":"IMAP Password is empty (Is required if you have entered a value in another IMAP variable)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_imap_password"]}},"type":"object"},"EmptyImapPortException":{"description":"IMAP Port is empty (Is required if you have entered a value in another IMAP variable)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_imap_port"]}},"type":"object"},"EmptyImapSecureException":{"description":"IMAP Connection Security is empty (Is required if you have entered a value in another IMAP variable)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_imap_secure"]}},"type":"object"},"EmptyImapUsernameException":{"description":"IMAP Username is empty (Is required if you have entered a value in another IMAP variable)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_imap_username"]}},"type":"object"},"IntegrationsEmail.EmptyIntegrationIdException":{"description":"Integration ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integrations_email_empty_integration_id"]}},"type":"object"},"EmptyMailgunApiKeyException":{"description":"Mailgun API key is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_mailgun_api_key"]}},"type":"object"},"EmptyMailgunDomainException":{"description":"Mailgun domain is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_mailgun_domain"]}},"type":"object"},"EmptyMailgunFromEmailException":{"description":"Mailgun From email is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_mailgun_from_email"]}},"type":"object"},"EmptyMailgunRegionException":{"description":"Mailgun region is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_mailgun_region"]}},"type":"object"},"EmptyMailgunWebhookSigningKeyException":{"description":"Mailgun webhook signing key is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_mailgun_webhook_signing_key"]}},"type":"object"},"IntegrationsEmail.EmptyMessageException":{"description":"Message is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_empty_message"]}},"type":"object"},"EmptySenderNameException":{"description":"Sender name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_sender_name"]}},"type":"object"},"EmptySmtpHostException":{"description":"SMTP Host is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_smtp_host"]}},"type":"object"},"EmptySmtpPasswordException":{"description":"SMTP Password is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_smtp_password"]}},"type":"object"},"EmptySmtpPortException":{"description":"SMTP Port is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_smtp_port"]}},"type":"object"},"EmptySmtpSecureException":{"description":"SMTP Connection Security is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_smtp_secure"]}},"type":"object"},"EmptySmtpUsernameException":{"description":"SMTP Username is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_smtp_username"]}},"type":"object"},"IncorrectCustomTrackingDomainException":{"description":"Custom tracking domain is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_custom_tracking_domain"]}},"type":"object"},"IntegrationsEmail.IncorrectEmailException":{"description":"Email address is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integrations_email_incorrect_email"]}},"type":"object"},"IncorrectKeywordException":{"description":"Keyword is not correct, it will be two 5 letter words e.g apple-juice.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_keyword"]}},"type":"object"},"IncorrectMailgunDomainException":{"description":"Mailgun domain is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_mailgun_domain"]}},"type":"object"},"IncorrectMailgunFromEmailException":{"description":"Mailgun From email is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_mailgun_from_email"]}},"type":"object"},"IncorrectReplyToException":{"description":"Email(s) is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_reply_to"]}},"type":"object"},"IntegrationsEmail.InvalidAutodiscoverResponseException":{"description":"Invalid Autodiscover response","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_autodiscover_response"]}},"type":"object"},"IntegrationsEmail.InvalidEmailAccountException":{"description":"Invalid email account","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_email_account"]}},"type":"object"},"IntegrationsEmail.InvalidEmailAccountTypeException":{"description":"Invalid email account type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_email_account_type"]}},"type":"object"},"InvalidFinalRedirectUrlException":{"description":"The final redirect URL is invalid (incorrect format or placeholder missing)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["final_redirect_url"]}},"type":"object"},"InvalidNotValidatedUrlException":{"description":"The not validated url is invalid (incorrect format or placeholder missing)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_not_validated_url"]}},"type":"object"},"InvalidValidatedUrlException":{"description":"The validated url is invalid (incorrect format or placeholder missing)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_validated_url"]}},"type":"object"},"MailgunFromDomainMismatchException":{"description":"Mailgun From domain must match the Mailgun domain or one of its parent domains","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["mailgun_from_domain_mismatch"]}},"type":"object"},"IntegrationsEmail.NumberMassMailingAccountsReachedException":{"description":"Number of MassMailing accounts reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["number_of_massmailing_accounts_reached"]}},"type":"object"},"IntegrationsEmail.NumberSMTPAccountsReachedException":{"description":"Number of SMTP accounts reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["number_of_smtp_accounts_reached"]}},"type":"object"},"ProtectionDoesNotExistException":{"description":"The protection does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["protection_does_not_exist"]}},"type":"object"},"SmtpImapPasswordMismatchException":{"description":"SMTP and IMAP passwords do not match","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["smtp_imap_password_mismatch"]}},"type":"object"},"SmtpImapUsernameMismatchException":{"description":"SMTP and IMAP usernames do not match","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["smtp_imap_username_mismatch"]}},"type":"object"},"UnauthorizedEmailAccountException":{"description":"Unauthorized email account","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_email_account"]}},"type":"object"},"UnauthorizedForceValidationException":{"description":"Unauthorized to force validation","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_force_validation"]}},"type":"object"},"UnauthorizedIntegrationEmailSharingException":{"description":"Unauthorized integration email sharing","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_integration_email_sharing"]}},"type":"object"},"UnauthorizedProtectionException":{"description":"Unauthorized protection","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_protection"]}},"type":"object"},"UnauthorizedWarmupException":{"description":"Unauthorized to use Warmup","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_warmup"]}},"type":"object"},"IntegrationsEmail.WarmupValueOutOfRangeException":{"description":"Warmup parameter value out of acceptable range","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["warmup_value_out_of_range"]}},"type":"object"},"IntegrationsLinkedin.EmptyIntegrationIdException":{"description":"Integration ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integrations_linkedin_empty_integration_id"]}},"type":"object"},"EmptySessionCookieException":{"description":"LinkedIn session cookie is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_session_cookie"]}},"type":"object"},"IntegrationsLinkedin.InvalidCheckpoint":{"description":"Integration ID is empty","required":["state","state_message","error"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_checkpoint"]},"error":{"description":"Error message during checkpoint","type":"string"}},"type":"object"},"LinkedinAccountDisconnected":{"description":"LinkedIn account disconnected","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["Linkedin_account_disconnected"]}},"type":"object"},"LinkedinAccountDoesNotExistException":{"description":"LinkedIn account does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["linkedin_account_does_not_exist"]}},"type":"object"},"IntegrationsLinkedin.NumberLinkedinAccountsReachedException":{"description":"Number of Linkedin accounts reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["number_of_linkedin_accounts_reached"]}},"type":"object"},"UnauthorizedIntegrationLinkedinSharingException":{"description":"Unauthorized integration linkedin sharing","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_integration_linkedin_sharing"]}},"type":"object"},"UnauthorizedLinkedinAccountException":{"description":"Unauthorized LinkedIn account","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_linkedin_account"]}},"type":"object"},"InvalidJsonException":{"description":"JSON is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_json"]}},"type":"object"},"InvalidTemperatureException":{"description":"Invalid temperature: must be between 0 and 2.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_temperature"]}},"type":"object"},"InvalidTimezoneException":{"description":"Invalid timezone","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_timezone"]}},"type":"object"},"JobAlreadyStoppedException":{"description":"Job already stopped","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["job_already_stopped"]}},"type":"object"},"JobClassNotFoundException":{"description":"Job class not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["job_class_not_found"]}},"type":"object"},"JobNotFailedException":{"description":"Job is not in failed state","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["job_not_failed"]}},"type":"object"},"JobNotFoundException":{"description":"Job not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["job_not_found"]}},"type":"object"},"ResultClassNotFoundException":{"description":"Result class not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["result_class_not_found"]}},"type":"object"},"UnauthorizedJobException":{"description":"Job not allowed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_job"]}},"type":"object"},"EmptyJobTypeException":{"description":"Job Type is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_job_type"]}},"type":"object"},"MethodNotAllowedException":{"description":"Method not allowed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["method_not_allowed"]}},"type":"object"},"MissingFolderDefinitionException":{"description":"Missing folder definition","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["missing_folder_definition"]}},"type":"object"}]},"Models.EmptyModelIdException":{"description":"Model ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_model_id"]}},"type":"object"},"Models.EmptyTextException":{"description":"Text is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_text"]}},"type":"object"},"InvalidModelTypeException":{"description":"Invalid model type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_model_type"]}},"type":"object"},"ModelDoesNotExistException":{"description":"Model does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["model_does_not_exist"]}},"type":"object"},"UnauthorizedModelException":{"description":"Unauthorized model","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_model"]}},"type":"object"},"UnauthorizedModelGeneratorException":{"description":"Not authorized to generate models","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_model_generator"]}},"type":"object"},"AiModelsAreNotAllowedException":{"description":"AI models are not allowed","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ai_models_are_not_allowed"]}},"type":"object"},"EmptyAiLanguageException":{"description":"AI language is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_ai_language"]}},"type":"object"},"EmptyEmailsException":{"description":"Emails is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_emails"]}},"type":"object"},"EmptyHTMLException":{"description":"HTML is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_html"]}},"type":"object"},"EmptySubjectException":{"description":"Subject is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_subject"]}},"type":"object"},"IncorrectAiLanguageException":{"description":"AI language is not correct (ISO 6393 standard : 3 characters)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_ai_language"]}},"type":"object"},"IncorrectEmailsException":{"description":"Email(s) is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_emails"]}},"type":"object"},"IncorrectUrlException":{"description":"URL is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_url"]}},"type":"object"},"InvalidJsonTemplateException":{"description":"JSON template is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_json_template"]}},"type":"object"},"ModelsEmailEmptyUrlException":{"description":"URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["models_email_empty_url"]}},"type":"object"},"NotAiModelException":{"description":"The model is not an AI model","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["not_ai_model"]}},"type":"object"},"NotGeneratedModelException":{"description":"The model is not generated","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["not_generated_model"]}},"type":"object"},"ModelsEmail.NumberTestEmailsSentReached":{"description":"Number of test emails sent reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["number_of_test_emails_sent_reached"]}},"type":"object"},"SendTestEmailRestrictedException":{"description":"You can only send a test to your own email address","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["send_test_email_restricted"]}},"type":"object"},"SendingAiModelTestNotAllowedException":{"description":"Sending a test is not allowed for AI models","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["sending_ai_model_test_not_allowed"]}},"type":"object"},"InvalidTextException":{"description":"Text is invalid. An LinkedIn Invitation is limited to 300 characters.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_text"]}},"type":"object"},"UnauthorizedCreateModelsLinkedinInvitationException":{"description":"Unauthorized to create models LinkedIn invitation","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_create_models_linkedin_invitation"]}},"type":"object"},"UnauthorizedCreateModelsLinkedinMessageException":{"description":"Unauthorized to create models LinkedIn message","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_create_models_linkedin_message"]}},"type":"object"},"EmptySenderException":{"description":"Sender is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_sender"]}},"type":"object"},"InvalidSenderException":{"description":"Sender is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_sender"]}},"type":"object"},"UnauthorizedCreateModelsSmsException":{"description":"Unauthorized to create models SMS","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_create_models_sms"]}},"type":"object"},"EmptyVoiceFileException":{"description":"Voice file is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_voice_file"]}},"type":"object"},"ModelsSmv.FileDoesNotExistException":{"description":"File does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["file_not_exist"]}},"type":"object"},"InvalidVoiceFileException":{"description":"Voice file is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_voice_file"]}},"type":"object"},"VoiceFileIncorrectLengthException":{"description":"The voice file must be between 20 and 50 seconds","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["voice_file_incorrect_length"]}},"type":"object"},"AuthErrorException":{"description":"Oauth auth error","required":["state","domain","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"domain":{"description":"The domain_saas you have sent","type":"string","nullable":false},"state_message":{"description":"Details of the error","type":"string","enum":["oauth_auth_error"]}},"type":"object"},"MissingEmailException":{"description":"The email is missing on your profile","required":["state","domain","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"domain":{"description":"The domain_saas you have sent","type":"string","nullable":false},"state_message":{"description":"Details of the error","type":"string","enum":["oauth_missing_email"]}},"type":"object"},"UnknownProviderException":{"description":"The provider is unknown","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["oauth_unknown_provider"]}},"type":"object"},"AlreadyInOrganizationException":{"description":"Already in the organization","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["already_in_the_organization"]}},"type":"object"},"EmptyOrganizationCodeException":{"description":"Organization code is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_organization_code"]}},"type":"object"},"EmptyOrganizationIdException":{"description":"Organization ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_organization_id"]}},"type":"object"},"OrganizationCodeInvalidException":{"description":"Organization code is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["organization_code_invalid"]}},"type":"object"},"OrganizationDoesNotExistException":{"description":"Organization does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["organization_does_not_exist"]}},"type":"object"},"UnauthorizedOrganizationException":{"description":"Unauthorized organization","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_organization"]}},"type":"object"},"UserNotInOrganizationException":{"description":"The user is not in this organization","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_not_in_organization"]}},"type":"object"},"PRMCallDoesNotExistException":{"description":"The call does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["call_does_not_exist"]}},"type":"object"},"PRMCantDeleteAllFields":{"description":"You cannot delete all fields","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_cant_delete_all_fields"]}},"type":"object"},"PRMCantDeleteDefaultCustomStatusException":{"description":"You cannot delete the default custom statuses","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cant_delete_default_custom_status"]}},"type":"object"},"PRMContactAlreadyExistException":{"description":"Contact already exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_contact_already_exist"]}},"type":"object"},"PRMContactDoesNotExistException":{"description":"Contact does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_contact_does_not_exist"]}},"type":"object"},"PRMContactWithoutLinkedinUrlException":{"description":"Contact without linkedin url","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["contact_without_linkedin_url"]}},"type":"object"},"PRMCustomStatusDoesNotExistException":{"description":"The custom status does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["custom_status_does_not_exist"]}},"type":"object"},"PRMEmptyContactIdException":{"description":"Empty contact id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_empty_contact_id"]}},"type":"object"},"PRMEmptyContactIdsException":{"description":"Empty contact ids","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_empty_contact_ids"]}},"type":"object"},"PRMEmptyProperties":{"description":"Empty properties","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_empty_properties"]}},"type":"object"},"PRMExclusionIdDoesNotExistException":{"description":"The exclusion does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["exclusion_id_does_not_exist"]}},"type":"object"},"PRMIncorrectStatus":{"description":"Incorrect status","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_incorrect_status"]}},"type":"object"},"PRMInvalidCallType":{"description":"Invalid call type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_call_type"]}},"type":"object"},"PRMInvalidColorException":{"description":"Invalid color","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_invalid_color"]}},"type":"object"},"PRMInvalidHistoryTypeReply":{"description":"Invalid prm history type reply","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_history_type_reply"]}},"type":"object"},"PRMNoteDoesNotExistException":{"description":"The note does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["note_does_not_exist"]}},"type":"object"},"PRMNurturingDoesNotExist":{"description":"Nurturing does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["nurturing_does_not_exist"]}},"type":"object"},"PRMReplyDoesNotExistException":{"description":"The reply does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["reply_does_not_exist"]}},"type":"object"},"PRMStepDoesNotExistException":{"description":"Step does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["prm_step_does_not_exist"]}},"type":"object"},"PRMUnauthorizedCall":{"description":"Unauthorized call","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_call"]}},"type":"object"},"PRMUnauthorizedContactException":{"description":"Unauthorized contact","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_contact"]}},"type":"object"},"PRMUnauthorizedCustomStatus":{"description":"Unauthorized custom status","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_custom_status"]}},"type":"object"},"UnauthorizedExportPrmException":{"description":"Unauthorized to export PRM","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_export_prm"]}},"type":"object"},"UnauthorizedGenerateSuggestedAnswerAiException":{"description":"Unauthorized to generate suggested answer AI","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_generate_suggested_answer_ai"]}},"type":"object"},"PRMUnauthorizedNote":{"description":"Unauthorized note","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_note"]}},"type":"object"},"PRMUnauthorizedNurturing":{"description":"Unauthorized nurturing","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_nurturing"]}},"type":"object"},"PRMUnauthorizedPRMException":{"description":"Unauthorized prm","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_prm"]}},"type":"object"},"PRMUnauthorizedPersonInCharge":{"description":"Unauthorized person in charge","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_person_in_charge"]}},"type":"object"},"EmptyPermissionNameException":{"description":"Permission name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_permission_name"]}},"type":"object"},"Permissions.InvalidPermissionFormatException":{"description":"The permission format provided is invalid. Each permission must have a name and a value.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_permission_format"]}},"type":"object"},"InvalidPermissionValueException":{"description":"Invalid permission value","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_permission_value"]}},"type":"object"},"OnlyOwnerCanModifyThisPermissionValueException":{"description":"Only owner can modify this permission value","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["only_owner_can_modify_this_permission_value"]}},"type":"object"},"PermissionDoesNotExistException":{"description":"Permission does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["permission_does_not_exist"]}},"type":"object"},"Permissions.PermissionValueLimitReachedException":{"description":"Permission value limit reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["permission_value_limit_reached"]}},"type":"object"},"UnauthorizedPermissionException":{"description":"Unauthorized permission","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_permission"]}},"type":"object"},"UnauthorizedPermissionValueException":{"description":"You do not have the right to assign a permission greater than your own.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_permission_value"]}},"type":"object"},"EmptyPoolIdException":{"description":"Pool ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_pool_id"]}},"type":"object"},"EmptyTypeException":{"description":"Type is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_type"]}},"type":"object"},"IncorrectTypeException":{"description":"Type is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_type"]}},"type":"object"},"InvalidPoolIdException":{"description":"Invalid pool id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_pool_id"]}},"type":"object"},"MassMailingTypeNotAllowed":{"description":"Mass Mailing type not allowed. Only email types : SMTP\/Gmail\/Outlook","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["massmailing_type_not_allowed"]}},"type":"object"},"PoolDoesNotExistException":{"description":"Pool does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["pool_does_not_exist"]}},"type":"object"},"PoolTypeNotEmailException":{"description":"Pool Type is not Email","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["pool_type_not_email"]}},"type":"object"},"PoolTypeNotLinkedinException":{"description":"Pool Type is not LinkedIn","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["pool_type_not_linkedin"]}},"type":"object"},"UnauthorizedPoolException":{"description":"Unauthorized pool","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_pool"]}},"type":"object"},"QueryTooShortException":{"description":"Query is too short","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["query_too_short"]}},"type":"object"},"EmptyReportIdException":{"description":"Empty report id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_report_id"]}},"type":"object"},"InvalidChartTypeException":{"description":"Invalid chart type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_chart_type"]}},"type":"object"},"InvalidXAxisException":{"description":"Invalid x axis","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_x_axis"]}},"type":"object"},"InvalidYAxisException":{"description":"Invalid y axis","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_y_axis"]}},"type":"object"},"ReportDoesNotExistException":{"description":"Report does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["report_does_not_exist"]}},"type":"object"},"UnauthorizedReportException":{"description":"Unauthorized report","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_report"]}},"type":"object"},"DomainApiUsedException":{"description":"Domain API is already in use","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_api_used"]}},"type":"object"},"ResellersDomainDoesNotExist":{"description":"Domain does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_does_not_exist"]}},"type":"object"},"DomainFilesUsedException":{"description":"Domain Files is already in use","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_files_used"]}},"type":"object"},"DomainMustDifferentException":{"description":"Each domain name must be different","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_must_different"]}},"type":"object"},"DomainRedirectUsedException":{"description":"Domain Redirect is already in use","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_redirect_used"]}},"type":"object"},"DomainSaasDoesNotExistException":{"description":"Domain SAAS does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_saas_does_not_exist"]}},"type":"object"},"DomainSaasUsedException":{"description":"Domain SAAS is already in use","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["domain_saas_used"]}},"type":"object"},"Resellers.EmptyContentException":{"description":"Content is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["reseller_empty_content"]}},"type":"object"},"EmptyDomainException":{"description":"Domain is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_domain"]}},"type":"object"},"EmptyDomainSaasException":{"description":"Domain SAAS is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_domain_saas"]}},"type":"object"},"EmptyLogoException":{"description":"Logo is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_logo"]}},"type":"object"},"EmptyLogoMenuException":{"description":"Logo menu is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_logo_menu"]}},"type":"object"},"EmptyResellerIdException":{"description":"Reseller ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_reseller_id"]}},"type":"object"},"EmptyStatusException":{"description":"Status is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_status"]}},"type":"object"},"Resellers.EmptySubjectException":{"description":"Subject is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["reseller_empty_subject"]}},"type":"object"},"Resellers.EmptyVideoUrlException":{"description":"Video URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_video_url"]}},"type":"object"},"FaviconSizeExceededException":{"description":"Favicon size is exceeded. Maximum favicon size is 2mb.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["favicon_size_is_exceeded"]}},"type":"object"},"IncorrectBookDemoException":{"description":"The book demo must be a valid URL or email address.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_book_demo"]}},"type":"object"},"IncorrectContactSupportException":{"description":"The contact support must be a valid URL or email address.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_contact_support"]}},"type":"object"},"IncorrectDomainApiException":{"description":"Domain API is not correct (ex: api.domain.ext)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_domain_api"]}},"type":"object"},"IncorrectDomainFilesException":{"description":"Domain Files is not correct (ex: files.domain.ext)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_domain_files"]}},"type":"object"},"IncorrectDomainRedirectException":{"description":"Domain Redirect is not correct (ex: redirect.domain.ext)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_domain_redirect"]}},"type":"object"},"IncorrectEmailAccountTypeException":{"description":"Your email account must be an SMTP account and must belong to you.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_email_account_type"]}},"type":"object"},"IncorrectLinkChromeExtensionException":{"description":"The link to your Chrome extension seems to be incorrect.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_link_chrome_extension"]}},"type":"object"},"IncorrectMutedColorException":{"description":"The muted color code is not valid. It must be a valid hexadecimal color code.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_muted_color"]}},"type":"object"},"IncorrectPricingUrlException":{"description":"The pricing URL must be a valid URL","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_pricing_url"]}},"type":"object"},"IncorrectPrimaryColorException":{"description":"The primary color code is not valid. It must be a valid hexadecimal color code.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_primary_color"]}},"type":"object"},"IncorrectPrimaryTextColorException":{"description":"The primary text color code is not valid. It must be a valid hexadecimal color code.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_primary_text_color"]}},"type":"object"},"IncorrectSecondaryColorException":{"description":"The secondary color code is not valid. It must be a valid hexadecimal color code.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_secondary_color"]}},"type":"object"},"IncorrectSecondaryTextColorException":{"description":"The secondary text color code is not valid. It must be a valid hexadecimal color code.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_secondary_text_color"]}},"type":"object"},"IncorrectSsoAuthorizationUrlException":{"description":"The SSO authorization URL seems to be incorrect.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_sso_authorization_url"]}},"type":"object"},"IncorrectSsoTokenUrlException":{"description":"The SSO token URL seems to be incorrect.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_sso_token_url"]}},"type":"object"},"IncorrectSsoUserinfoUrlException":{"description":"The SSO userinfo URL seems to be incorrect.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_sso_userinfo_url"]}},"type":"object"},"IncorrectStatusException":{"description":"Status is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_incorrect_status"]}},"type":"object"},"Resellers.IncorrectVideoUrlException":{"description":"Video URL is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_video_url"]}},"type":"object"},"InvalidName":{"description":"Invalid name","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_invalid_name"]}},"type":"object"},"InvalidPrmDigestTableColumnsException":{"description":"Invalid PRM digest table columns configuration","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_prm_digest_table_columns"]}},"type":"object"},"InvalidTermsOfSaleFormatException":{"description":"Terms of sale must be a valid URL or a PDF file","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_terms_of_sale_format"]}},"type":"object"},"InvalidTutorialVideoThumbnailRequestException":{"description":"Cannot upload a tutorial video thumbnail when remove_thumbnail is true or when the video URL is empty.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_tutorial_video_thumbnail_request"]}},"type":"object"},"LevelDoesNotExistException":{"description":"Level does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["level_does_not_exist"]}},"type":"object"},"LogoMenuInvalidDimensionsException":{"description":"The dimensions of the image must be 100x50 pixels.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["logo_menu_invalid_dimensions"]}},"type":"object"},"LogoMenuSizeExceededException":{"description":"Logo menu size is exceeded. Maximum logo mennu size is 2mb.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["logo_menu_size_is_exceeded"]}},"type":"object"},"LogoSizeExceededException":{"description":"Logo size is exceeded. Maximum logo size is 2mb.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["logo_size_is_exceeded"]}},"type":"object"},"MissingMessagePlaceholders":{"description":"Missing message placeholders","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["resellers_missing_message_placeholders"]}},"type":"object"},"Resellers.NumberResellersReachedException":{"description":"Number of resellers reached","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["number_of_resellers_reached"]}},"type":"object"},"ResellerDoesNotExistException":{"description":"Reseller does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["reseller_does_not_exist"]}},"type":"object"},"TermsOfSalePdfTooLargeException":{"description":"PDF file size is exceeded. Maximum allowed size is 10MB.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["terms_of_sale_pdf_too_large"]}},"type":"object"},"TransactionalMessageDoesNotExistException":{"description":"Transactional message template does not exist. You must create it first via saveTransactionnalMessage.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["transactional_message_does_not_exist"]}},"type":"object"},"TutorialVideoThumbnailSizeExceededException":{"description":"Tutorial video thumbnail size is exceeded. Maximum tutorial video thumbnail size is 2mb.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["tutorial_video_thumbnail_size_is_exceeded"]}},"type":"object"},"UnauthorizedFaviconFormatException":{"description":"Authorized favicon format : ICO","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_favicon_format"]}},"type":"object"},"UnauthorizedLogoFormatException":{"description":"Authorized logo format : JPG \/ JPEG \/ PNG \/ SVG","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_logo_format"]}},"type":"object"},"UnauthorizedLogoMenuFormatException":{"description":"Authorized logo menu format : JPG \/ JPEG \/ PNG \/ SVG","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_logo_menu_format"]}},"type":"object"},"UnauthorizedPersonalizeTransactionalEmailsException":{"description":"Unauthorized personalization of transactional emails","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_personalize_transactional_emails"]}},"type":"object"},"UnauthorizedResellerException":{"description":"Unauthorized reseller","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_reseller"]}},"type":"object"},"UnauthorizedResellerSetDefaultUserPermissionsException":{"description":"Unauthorized reseller set default user permissions","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_reseller_set_default_user_permissions"]}},"type":"object"},"UnauthorizedTutorialVideoThumbnailFormatException":{"description":"Authorized tutorial video thumbnail format : JPG \/ JPEG \/ PNG \/ SVG","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_tutorial_video_thumbnail_format"]}},"type":"object"},"UserNotInResellerException":{"description":"The user is not in this reseller","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_not_in_reseller"]}},"type":"object"},"EmptyRoleIdException":{"description":"Role ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_role_id"]}},"type":"object"},"RoleDoesNotExistException":{"description":"Role does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["role_does_not_exist"]}},"type":"object"},"UnauthorizedRoleException":{"description":"Unauthorized role","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_role"]}},"type":"object"},"SMSErrorException":{"description":"An error occurred while sending the SMS","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["sms_error"]}},"type":"object"}]},"SMVErrorException":{"description":"An error occurred while sending the SMV","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["smv_error"]}},"type":"object"}]},"SearchIdNotExistingException":{"description":"Search ID not existing","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["search_id_not_existing"]}},"type":"object"},"CantChangeSharingTypeException":{"description":"You can't change the sharing type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cant_change_sharing_type"]}},"type":"object"},"InvalidSharingArgumentException":{"description":"Sharing argument is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_sharing_argument"]}},"type":"object"},"InvalidSharingIdsListException":{"description":"Sharing ids list is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_sharing_ids_list"]}},"type":"object"},"InvalidSharingNameException":{"description":"Sharing name is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_sharing_name"]}},"type":"object"},"InvalidSharingPermissionException":{"description":"Sharing permission is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_sharing_permission"]}},"type":"object"},"InvalidSharingTypeToException":{"description":"Sharing type to is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_sharing_type_to"]}},"type":"object"},"OnlyOwnerCanModifySharingException":{"description":"Only owner can modify sharing","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["only_owner_can_modify_sharing"]}},"type":"object"},"SharingDoesNotExistException":{"description":"Sharing does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["sharing_does_not_exist"]}},"type":"object"},"SharingReadPermissionMustBeTrueException":{"description":"Sharing read permission must be true","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["sharing_read_permission_must_be_true"]}},"type":"object"},"TooManySharesException":{"description":"Too many shares","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["too_many_shares"]}},"type":"object"},"UnauthorizedSharingException":{"description":"Unauthorized sharing","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_sharing"]}},"type":"object"},"RangeTooLarge":{"description":"The range is too large","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["range_too_large"]}},"type":"object"},"ActiveSubscriptionExistsException":{"description":"An active subscription already exists","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["active_subscription_exists"]}},"type":"object"},"Subscriptions.EmptyCancelUrlException":{"description":"Cancel URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_cancel_url"]}},"type":"object"},"EmptyInvoicesListException":{"description":"Invoices list is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_invoices_list"]}},"type":"object"},"EmptyPaymentMethodException":{"description":"The payment method is empty or not provided","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_payment_method"]}},"type":"object"},"EmptyProductsListException":{"description":"Products lists is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_products_lists"]}},"type":"object"},"EmptySubscribeItemsException":{"description":"Items is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_subscribe_items"]}},"type":"object"},"Subscriptions.EmptySuccessUrlException":{"description":"Success URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_success_url"]}},"type":"object"},"EndDateInPastException":{"description":"The end_date must be greater than today's date","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["end_date_in_past"]}},"type":"object"},"InvalidCancelUrlException":{"description":"The cancel URL is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_cancel_url"]}},"type":"object"},"InvalidSubscribeItemsException":{"description":"Items is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_subscribe_items"]}},"type":"object"},"InvalidSuccessUrlException":{"description":"The success URL is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_success_url"]}},"type":"object"},"InvoiceDownloadLinkException":{"description":"Failed to generate or download the invoice link","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invoice_download_link_error"]}},"type":"object"},"InvoiceNotFoundException":{"description":"The specified invoice was not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invoice_not_found"]}},"type":"object"},"ItemDoesNotExistException":{"description":"Item does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["item_does_not_exist"]}},"type":"object"},"ItemIsNotAnOptionException":{"description":"Item is not an option","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["item_is_not_an_option"]}},"type":"object"},"LinkedinAccountsRemovalRequiredException":{"description":"You must remove LinkedIn accounts","required":["state","accounts_to_remove","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"accounts_to_remove":{"description":"Number of accounts to remove","type":"integer"},"state_message":{"description":"Details of the error","type":"string","enum":["linkedin_accounts_removal_required"]}},"type":"object"},"MinimumOptionQuantityException":{"description":"Cannot remove options. The subscription has reached the minimum allowed option quantity.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["minimum_option_quantity_reached"]}},"type":"object"},"MismatchedBillingIntervalException":{"description":"All items must have the same billing interval type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["mismatched_billing_interval"]}},"type":"object"},"NoSubscriptionExistsException":{"description":"No subscription exists","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_subscription_exists"]}},"type":"object"},"PaymentMethodNotFoundException":{"description":"The specified payment method was not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["payment_method_not_found"]}},"type":"object"},"RequireValidLinkedinIntegrationOrSubscriptionException":{"description":"You need a valid linkedin integration or a subscription","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["require_valid_linkedin_integration_or_subscription"]}},"type":"object"},"SmtpAccountsRemovalRequiredException":{"description":"You must remove SMTP accounts","required":["state","accounts_to_remove","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"accounts_to_remove":{"description":"Number of accounts to remove","type":"integer"},"state_message":{"description":"Details of the error","type":"string","enum":["smtp_accounts_removal_required"]}},"type":"object"},"UnauthorizedSubscribeUserException":{"description":"Unauthorized to subscribe user","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_subscribe_user"]}},"type":"object"},"EmptyTagIdException":{"description":"Tag ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_tag_id"]}},"type":"object"},"InvalidTagIdException":{"description":"Invalid tag id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_tag_id"]}},"type":"object"},"TagDoesNotExistException":{"description":"Tag does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["tag_does_not_exist"]}},"type":"object"},"UnauthorizedTagException":{"description":"Unauthorized tag","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_tag"]}},"type":"object"},"NameTooShortException":{"description":"The name must be at least 3 characters long.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["name_too_short"]}},"type":"object"},"EmptyContactListIdNameException":{"description":"Contact list name and id is empty. You must fill in one of the two options.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_contact_list_id_name"]}},"type":"object"},"EmptyFiltersException":{"description":"Filters is empty.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_filters"]}},"type":"object"},"EmptyGoogleMapsSearchQueryException":{"description":"Google Maps search query is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_google_maps_search_query"]}},"type":"object"},"EmptyGoogleMapsSearchUrlException":{"description":"Google Maps Search URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_google_maps_search_url"]}},"type":"object"},"EmptyLinkedinCompanySearchUrlException":{"description":"LinkedIn company search URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_company_search_url"]}},"type":"object"},"EmptyLinkedinJobSearchUrlException":{"description":"LinkedIn job search URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_job_search_url"]}},"type":"object"},"EmptyLinkedinPeopleSearchUrlException":{"description":"LinkedIn people search URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_people_search_url"]}},"type":"object"},"EmptyLinkedinPostUrlException":{"description":"LinkedIn post URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_post_url"]}},"type":"object"},"EmptyLinkedinSalesNavigatorSearchUrlException":{"description":"LinkedIn Sales Navigator search URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_sales_navigator_search_url"]}},"type":"object"},"EmptyLinkedinUrlException":{"description":"LinkedIn URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_url"]}},"type":"object"},"FilterLimitExceededException":{"description":"The number of filters applied exceeds the maximum limit of 200 allowed. Please reduce the number of filters and try again.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["filter_limit_exceeded"]}},"type":"object"},"InvalidFiltersException":{"description":"Filters is invalid.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_filters"]}},"type":"object"},"InvalidGoogleMapsSearchUrlException":{"description":"Google Maps Search URL is invalid (The URL must start with https:\/\/www.google.com\/maps\/search\/)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_google_maps_search_url"]}},"type":"object"},"InvalidLinkedinCompanySearchUrlException":{"description":"LinkedIn company search URL is invalid (The URL must start with https:\/\/www.linkedin.com\/search\/results\/companies\/)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_linkedin_company_search_url"]}},"type":"object"},"InvalidLinkedinJobSearchUrlException":{"description":"LinkedIn URL of the job search is invalid (The URL must start with https:\/\/www.linkedin.com\/jobs\/search\/)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_linkedin_job_search_url"]}},"type":"object"},"InvalidLinkedinPeopleSearchUrlException":{"description":"LinkedIn people search URL is invalid (The URL must start with https:\/\/www.linkedin.com\/search\/results\/people\/)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_linkedin_people_search_url"]}},"type":"object"},"InvalidLinkedinPostUrlException":{"description":"LinkedIn URL of the post is invalid (The URL must start with https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity: OR https:\/\/www.linkedin.com\/posts\/)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_linkedin_post_url"]}},"type":"object"},"InvalidLinkedinSalesNavigatorSearchUrlException":{"description":"Sales Navigator search URL is invalid (The URL must start with https:\/\/www.linkedin.com\/sales\/search\/people)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_linkedin_sales_navigator_search_url"]}},"type":"object"},"InvalidLinkedinUrlException":{"description":"LinkedIn URL is invalid for the requested targeting action","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_linkedin_url"]}},"type":"object"},"EmptyLinkedinSearchUrlParametersException":{"description":"LinkedIn search url parameters are empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_linkedin_search_url_parameters"]}},"type":"object"},"LinkedinUrlTooLongException":{"description":"The url is too long for linkedin","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["linkedin_url_too_long"]}},"type":"object"},"NoGoogleMapsSearchExtractionFoundException":{"description":"No Google Maps Search extraction found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_google_maps_search_extraction_found"]}},"type":"object"},"NoGoogleMapsSearchExtractionWithErrorsFoundException":{"description":"No Google Maps Search extraction with errors found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_google_maps_search_extraction_with_errors_found"]}},"type":"object"},"NoLinkedinExtractionWithErrorsFoundException":{"description":"No LinkedIn extraction with errors found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_linkedin_extraction_with_errors_found"]}},"type":"object"},"NoMatchingContactFoundException":{"description":"No contact matches the search criteria. Please adjust your search parameters and try again.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["no_matching_contact_found"]}},"type":"object"},"TargetingLinkedinNotFoundException":{"description":"Targeting LinkedIn not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["targeting_linkedin_not_found"]}},"type":"object"},"UnauthorizedSearchAIException":{"description":"Unauthorized search with AI","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_search_ai"]}},"type":"object"},"UnauthorizedTargetingAlternativeException":{"description":"You are not authorised to use the alternate targeting","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_targeting_alternative"]}},"type":"object"},"UnauthorizedTargetingDatabaseException":{"description":"Unauthorized targeting database","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_targeting_database"]}},"type":"object"},"AlreadyInTheTeamException":{"description":"Already in the team","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["already_in_the_team"]}},"type":"object"},"EmptyTeamCodeException":{"description":"Team code is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_team_code"]}},"type":"object"},"EmptyTeamIdException":{"description":"Team ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_team_id"]}},"type":"object"},"TeamCodeInvalidException":{"description":"Team code invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["team_code_invalid"]}},"type":"object"},"TeamDoesNotExistException":{"description":"Team does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["team_does_not_exist"]}},"type":"object"},"UnauthorizedTeamException":{"description":"Unauthorized team","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_team"]}},"type":"object"},"UserNotInTeamException":{"description":"The user is not in this team","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_not_in_team"]}},"type":"object"},"TooManyAttemptsException":{"description":"Too many attempts, please wait a few minutes","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["too_many_attempts"]}},"type":"object"},"TooManyRequestsException":{"description":"Too many requests, please wait a few minutes","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["too_many_requests"]}},"type":"object"},"EmptyShortenedUrlIdException":{"description":"Shortened URL ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_shortened_url_id"]}},"type":"object"},"EmptyUrlCodeException":{"description":"URL code is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_url_code"]}},"type":"object"},"EmptyUrlException":{"description":"URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["url_shortener_empty_url"]}},"type":"object"},"ShortenedUrlDoesNotExistException":{"description":"Shortened URL does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["shortened_url_does_not_exist"]}},"type":"object"},"UnauthorizedShortenedUrlException":{"description":"Unauthorized shortened URL","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_shortened_url"]}},"type":"object"},"UrlCodeDoesNotExistException":{"description":"URL code does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["url_code_does_not_exist"]}},"type":"object"},"UnexpectedException":{"description":"An error has occurred","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unexpected_exception"]}},"type":"object"},"UnknownAppTypeException":{"description":"Unknown app type","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unknown_app_type"]}},"type":"object"}]},"UnknownFileTypeException":{"description":"Unknown file type. Only CSV at the moment","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unknown_file_type"]}},"type":"object"},"EmptyUnsubscriberIdException":{"description":"Unsubscriber ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_unsubscriber_id"]}},"type":"object"},"UnauthorizedUnsubscriberException":{"description":"Unauthorized unsubscriber","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_unsubscriber"]}},"type":"object"},"UnsubscriberDoesNotExistException":{"description":"Unsubscriber does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unsubscriber_does_not_exist"]}},"type":"object"},"UserAccountDisabledException":{"description":"User account is disabled","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_account_disabled"]}},"type":"object"},"UserAccountLockedException":{"description":"User account is locked","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_account_locked"]}},"type":"object"},"AdminAccountDeletionException":{"description":"Admin account cannot be deleted","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["admin_account_cannot_be_deleted"]}},"type":"object"},"AvatarSizeExceededException":{"description":"Avatar size is exceeded. Maximum avatar size is 2mb.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["avatar_size_is_exceeded"]}},"type":"object"},"CannotModifyTimezoneException":{"description":"You can only set once the timezone. Ask support to change it again","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cannot_modify_timezone"]}},"type":"object"},"Users.DeleteUseMeEndpointException":{"description":"Use \/users\/me endpoint to delete your own account","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["users_delete_use_me_endpoint"]}},"type":"object"},"EmailAlreadyValidatedException":{"description":"Email already validated","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_already_validated"]}},"type":"object"},"EmailNotValidatedException":{"description":"Email not validated","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_not_validated"]}},"type":"object"},"EmailUsedException":{"description":"Email is already in use","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_used"]}},"type":"object"},"EmptyCodeException":{"description":"Code is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_code"]}},"type":"object"},"EmptyCountryException":{"description":"Country is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_country"]}},"type":"object"},"EmptyCurrentPasswordException":{"description":"Current password is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_current_password"]}},"type":"object"},"Users.EmptyEmailException":{"description":"Email is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["users_empty_email"]}},"type":"object"},"EmptyEmailValidatedUniqidException":{"description":"Email validated uniqid is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_email_validated_uniqid"]}},"type":"object"},"EmptyFirstNameException":{"description":"First name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_first_name"]}},"type":"object"},"EmptyLanguageException":{"description":"Language is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_language"]}},"type":"object"},"EmptyLastNameException":{"description":"Last name is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_last_name"]}},"type":"object"},"EmptyMobilePhoneCountryException":{"description":"Mobile phone country is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_mobile_phone_country"]}},"type":"object"},"EmptyMobilePhoneException":{"description":"Mobile phone is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_mobile_phone"]}},"type":"object"},"EmptyPasswordException":{"description":"Password is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_password"]}},"type":"object"},"EmptyRefreshTokenException":{"description":"Refresh token is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_refresh_token"]}},"type":"object"},"EmptySexException":{"description":"Sex is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_sex"]}},"type":"object"},"Users.EmptyUserIdException":{"description":"User ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["users_empty_user_id"]}},"type":"object"},"IncorrectCodeException":{"description":"Code is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_code"]}},"type":"object"},"IncorrectColumnEntryNotificationDigestTimeException":{"description":"Send PRM column entry mail digest time is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_send_prm_column_entry_mail_digest_time"]}},"type":"object"},"IncorrectColumnEntryNotificationFrequencyException":{"description":"Send PRM column entry mail frequency is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_send_prm_column_entry_mail_frequency"]}},"type":"object"},"IncorrectContactListCountryException":{"description":"Contact list country is not correct (ISO 3166 standard : 2 characters)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_contact_list_country"]}},"type":"object"},"IncorrectContactListLanguageException":{"description":"Contact list language is not correct (ISO 6393 standard : 3 characters)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_contact_list_language"]}},"type":"object"},"IncorrectCountryException":{"description":"Country is not correct (ISO 3166 standard : 2 characters)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_country"]}},"type":"object"},"Users.IncorrectCurrentPasswordException":{"description":"Current password is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["users_incorrect_current_password"]}},"type":"object"},"Users.IncorrectEmailException":{"description":"Email is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["users_incorrect_email"]}},"type":"object"},"IncorrectEmailOrPasswordException":{"description":"Email or password is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_email_or_password"]}},"type":"object"},"IncorrectEmailValidationUrlErrorException":{"description":"The error validation URL of the email is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_email_validation_url_error"]}},"type":"object"},"IncorrectEmailValidationUrlSuccessException":{"description":"The success validation URL of the email is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_email_validation_url_success"]}},"type":"object"},"IncorrectLanguageException":{"description":"Language is not correct (ISO 6393 standard : 3 characters)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_language"]}},"type":"object"},"IncorrectLevelException":{"description":"Level is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_level"]}},"type":"object"},"IncorrectMobilePhoneCountryException":{"description":"Mobile phone country is not correct (ISO 3166 standard : 2 characters)","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_mobile_phone_country"]}},"type":"object"},"IncorrectMobilePhoneException":{"description":"Mobile phone country is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_mobile_phone"]}},"type":"object"},"IncorrectPasswordResetMethodException":{"description":"Password reset method is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_password_reset_method"]}},"type":"object"},"IncorrectSexException":{"description":"Sex is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_sex"]}},"type":"object"},"IncorrectSourceException":{"description":"Source is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_source"]}},"type":"object"},"IncorrectTableDensityException":{"description":"Table density is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_table_density"]}},"type":"object"},"IncorrectTimezoneException":{"description":"The timezone is incorrect","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_timezone"]}},"type":"object"},"LinkClickScoreCannotBeEmptyException":{"description":"The score for link click cannot be empty if you define scores for specific links","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["link_click_score_cannot_be_empty"]}},"type":"object"},"MobilePhoneUsedException":{"description":"Mobile phone is already in use","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["mobile_phone_used"]}},"type":"object"},"PasswordNotStrongException":{"description":"Password should be at least 8 characters in length and should include at least one lower case letter, one upper case letter, one number, and one special character","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["password_not_strong"]}},"type":"object"},"RefreshTokenAlreadyUsedException":{"description":"Refresh token is already used","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["refresh_token_already_used"]}},"type":"object"},"RefreshTokenDoesNotExistException":{"description":"Refresh token does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["refresh_token_does_not_exist"]}},"type":"object"},"RefreshTokenExpiredException":{"description":"Refresh token has expired","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["refresh_token_expired"]}},"type":"object"},"SmsNotValidatedException":{"description":"SMS not validated","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["sms_not_validated"]}},"type":"object"},"UnauthorizedAnswerAiMarkPositiveException":{"description":"Unauthorized setting of answer ai mark positive","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_answer_ai_mark_positive"]}},"type":"object"},"UnauthorizedAvatarFormatException":{"description":"Authorized avatar format : JPG \/ JPEG \/ PNG","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_avatar_format"]}},"type":"object"},"UnauthorizedProfileException":{"description":"Unauthorized profile","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_profile"]}},"type":"object"},"UnauthorizedSwitchException":{"description":"Unauthorized to switch to user","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_switch"]}},"type":"object"},"UserDoesNotExistException":{"description":"User does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["user_does_not_exist"]}},"type":"object"},"ValidationException":{"description":"Error during the validation of the input parameters","required":["state","state_message","errors"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["validation_exception"]},"errors":{"description":"List of errors","type":"array","items":{"type":"string"}}},"type":"object"},"EmptyDateEventException":{"description":"Date event is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_date_event"]}},"type":"object"},"EmptyIPAddressException":{"description":"IP Address is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_ip_address"]}},"type":"object"},"WebhookAmtaEmptyStatusException":{"description":"Status is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["webhook_amta_empty_status"]}},"type":"object"},"EmptyURLException":{"description":"URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_url"]}},"type":"object"},"EmptyUserAgentException":{"description":"User agent is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_user_agent"]}},"type":"object"},"WebhookResoluEmptyContactIdsException":{"description":"Contact ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["webhook_resolu_empty_contact_id"]}},"type":"object"},"WebhookResoluEmptyContactIdException":{"description":"Contact list ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["webhook_resolu_empty_contact_list_id"]}},"type":"object"},"EmptyQueueIdException":{"description":"Queue ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_queue_id"]}},"type":"object"},"EmptyUserUniqidException":{"description":"User uniqid is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_user_uniqid"]}},"type":"object"},"WebhookRetryRequiredException":{"description":"A retry for the webhook is required","required":["state","state_message"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UnexpectedException"},{"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["webhook_retry_required"]}},"type":"object"}]},"Webhooks.InvalidEventTypeException":{"description":"Invalid event type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["webhooks_invalid_event_type"]}},"type":"object"},"InvalidWebhookUrlException":{"description":"Invalid webhook url","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_webhook_url"]}},"type":"object"},"UnauthorizedWebhookException":{"description":"Unauthorized webhook","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_webhook"]}},"type":"object"},"WebhookDoesNotExistException":{"description":"The webhook does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["webhook_does_not_exist"]}},"type":"object"},"AbProportionEmptyException":{"description":"you should fill ab proportion if ab subject is filled","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["ab_proportion_empty"]}},"type":"object"},"ActionTypeDoesNotMatchContactTypeException":{"description":"This workflow programmation step is not an action","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["action_type_does_not_match_contact_type"]}},"type":"object"},"CantDeleteWorkflowWithProgrammationException":{"description":"You can't delete a workflow which have programmations","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cant_delete_workflow_with_programmation"]}},"type":"object"},"CantRemoveStepWithContactException":{"description":"You can't remove a step which already received contacts","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cant_remove_step_with_contact"]}},"type":"object"},"CantSetBothPoolAndIntegrationException":{"description":"You can't set both pool id and integration id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cant_set_both_pool_and_integration"]}},"type":"object"},"CantUpdateWorkflowSharingWithProgrammationException":{"description":"You can't modify a workflow sharing which have programmations","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["cant_update_workflow_sharing_with_programmation"]}},"type":"object"},"DateStopShouldBeAfterDateStartException":{"required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["date_stop_should_be_after_date_start"]}},"type":"object"},"DummyActionCanOnlyBeInitialException":{"description":"The dummy action can only be an initial step","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["dummy_action_can_only_be_initial"]}},"type":"object"},"DuplicateStepIdException":{"description":"Duplicate step ID","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["duplicate_step_id"]}},"type":"object"},"EmailReplyNotFoundException":{"description":"Email reply not found","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["email_reply_not_found"]}},"type":"object"},"Workflow.EmptyContactListIdsException":{"required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_empty_contact_list_ids"]}},"type":"object"},"EmptyImageFileException":{"description":"Image file is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_image_file"]}},"type":"object"},"EmptyRecipientException":{"description":"Recipient is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_recipient"]}},"type":"object"},"EmptyRecipientsException":{"description":"Recipients is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_recipients"]}},"type":"object"},"EmptyStepsException":{"description":"No steps provided","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_steps"]}},"type":"object"},"EmptyWorkflowIdException":{"description":"Workflow ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_workflow_id"]}},"type":"object"},"EmptyWorkflowProgrammationIdException":{"description":"Workflow programmation ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_workflow_programmation_id"]}},"type":"object"},"ForbiddenModificationOfAStartedStepException":{"description":"You can't update certain fields of a step that is started","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["forbidden_modification_of_a_started_step"]}},"type":"object"},"ForbiddenParentModificationOfAStartedStepException":{"description":"You can't remove the relation to a parent step which have been started","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["forbidden_parent_modification_of_a_started_step"]}},"type":"object"},"ImageSizeExceededException":{"description":"Image size is exceeded. Maximum image size is 2mb.","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["image_size_is_exceeded"]}},"type":"object"},"IncorrectCcRecipientsException":{"description":"CC Recipients is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_cc_recipients"]}},"type":"object"},"IncorrectRecipientException":{"description":"Recipient is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_recipient"]}},"type":"object"},"IncorrectRecipientsException":{"description":"Recipients is not correct","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["incorrect_recipients"]}},"type":"object"},"IntegrationIdDoesNotMatchActionTypeException":{"description":"The integration is not compatible with the action type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["integration_id_does_not_match_action_type"]}},"type":"object"},"Workflow.InvalidAiAgentWorkflowConfigurationException":{"description":"AI agent rules cannot satisfy the requested workflow nature","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_ai_agent_invalid_configuration"]}},"type":"object"},"InvalidContactTypeException":{"description":"Invalid contact type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_contact_type"]}},"type":"object"},"InvalidStepIdInStepException":{"description":"Invalid step id in step","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_step_id_in_step"]}},"type":"object"},"LinkNotInMessageException":{"description":"The link you're trying to track is not on your message","required":["state","state_message","step_id","link"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["link_not_in_message"]},"step_id":{"$ref":"#\/components\/schemas\/StepId"},"link":{"type":"string"}},"type":"object"},"MissingEventTypeException":{"description":"Missing event type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["missing_event_type"]}},"type":"object"},"MissingIntegrationIdOrPoolIdException":{"description":"Missing integration id or pool id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["missing_integration_id_or_pool_id"]}},"type":"object"},"MissingModelIdException":{"description":"Missing model id","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["missing_model_id"]}},"type":"object"},"ModelIdDoesNotMatchActionTypeException":{"description":"The model is not compatible with the action type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["model_id_does_not_match_action_type"]}},"type":"object"},"MustSpecifyWhichProspectsToShareException":{"description":"You should fill ab proportion if ab subject is filled","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["must_specify_which_prospects_to_share"]}},"type":"object"},"ParentActionDoesNotMatchEventException":{"description":"The parent action type does not match the event type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["parent_action_does_not_match_event"]}},"type":"object"},"ParentStepIdDoesNotExistException":{"description":"The parent step id does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["parent_step_id_does_not_exist"]}},"type":"object"},"PoolIdDoesNotMatchActionTypeException":{"description":"The pool is not compatible with the action type","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["pool_id_does_not_match_action_type"]}},"type":"object"},"ResponderEventWithAutoRemoveRespondersException":{"description":"You cannot use a responder event if you auto remove responders","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["responder_event_with_auto_remove_responders"]}},"type":"object"},"SameConsecutiveStepException":{"description":"There can't be the same kind of steps consecutively","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["same_consecutive_step"]}},"type":"object"},"ShouldAllowAtLeastOneDayException":{"description":"You should allow at least one day on the workflow programmation","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["should_allow_at_least_one_day"]}},"type":"object"},"SomeEventMustHaveHigherWhenMinutesException":{"description":"The when_minutes for events not_active, sms_not_got and smv_not_got must be at least 1 day","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["some_event_must_have_higher_when_minutes_exception"]}},"type":"object"},"SplitContactsEventCantHaveFilterException":{"description":"The event split_contacts cannot have a filter","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["split_contacts_event_cant_have_filter"]}},"type":"object"},"SplitContactsEventCantHaveMultipleParentsException":{"description":"The event split_contacts cannot have multiple parents","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["split_contacts_event_cant_have_multiple_parents"]}},"type":"object"},"StartHourShouldBeBeforeEndHourException":{"required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["start_hour_should_be_before_end_hour"]}},"type":"object"},"StepCantHaveItselfAsParentException":{"description":"A step can's have itself as parent","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["step_cant_have_itself_as_parent"]}},"type":"object"},"ThereMustBeOneInitialStepAtRootException":{"description":"There must be exactly one initial step at the root","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["there_must_be_one_initial_step_at_root"]}},"type":"object"},"TooManyLevelsOfStepsException":{"description":"Too many levels of steps","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["too_many_levels_of_steps"]}},"type":"object"},"TooManyStepsException":{"description":"Too many steps","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["too_many_steps"]}},"type":"object"},"UnauthorizedImageFormatException":{"description":"Authorized image format : PNG, SVG","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_image_format"]}},"type":"object"},"UnauthorizedPriorityEmailException":{"description":"Unauthorized priority email","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_priority_email"]}},"type":"object"},"UnauthorizedWorkflowException":{"description":"Unauthorized workflow","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_workflow"]}},"type":"object"},"UnauthorizedWorkflowProgrammationException":{"description":"Unauthorized workflow programmation","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_workflow_programmation"]}},"type":"object"},"WorkflowDoesNotExistException":{"description":"Workflow does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_does_not_exist"]}},"type":"object"},"WorkflowProgrammationAlreadyArchivedException":{"description":"Workflow programmation already archived","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_already_archived"]}},"type":"object"},"WorkflowProgrammationAlreadyRunningException":{"description":"Workflow programmation already running","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_already_running"]}},"type":"object"},"WorkflowProgrammationAlreadyStoppedException":{"description":"Workflow programmation already stopped","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_already_stopped"]}},"type":"object"},"WorkflowProgrammationAlreadyUnarchivedException":{"description":"Workflow programmation already unarchived","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_already_unarchived"]}},"type":"object"},"WorkflowProgrammationDoesNotExistException":{"description":"Workflow programmation does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_does_not_exist"]}},"type":"object"},"WorkflowProgrammationFieldNoUpdateStartedException":{"description":"You can't update some fields of the workflow programmation once it has started","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_field_no_update_started"]}},"type":"object"},"WorkflowProgrammationStepAlreadyRunningException":{"description":"Workflow programmation step already running","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_step_already_running"]}},"type":"object"},"WorkflowProgrammationStepAlreadyStoppedException":{"description":"Workflow programmation step already stopped","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_step_already_stopped"]}},"type":"object"},"WorkflowProgrammationStepDoesNotExistException":{"description":"Workflow programmation step does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_step_does_not_exist"]}},"type":"object"},"WorkflowProgrammationStepNotActionException":{"description":"This workflow programmation step is not an action","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["workflow_programmation_step_not_action"]}},"type":"object"},"YouAreAdminException":{"description":"You are admin","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["you_are_admin"]}},"type":"object"},"EmptyZapierFilterException":{"description":"Zapier flter is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_zapier_filter"]}},"type":"object"},"EmptyZapierHookIdException":{"description":"Zapier hook ID is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_zapier_hook_id"]}},"type":"object"},"EmptyZapierUrlException":{"description":"Zapier URL is empty","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["empty_zapier_url"]}},"type":"object"},"InvalidEventException":{"description":"Event is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_event"]}},"type":"object"},"InvalidPostDataException":{"description":"PostData is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_postdata"]}},"type":"object"},"InvalidSourceException":{"description":"Source is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_source"]}},"type":"object"},"InvalidZapierUrlException":{"description":"Zapier URL is invalid","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["invalid_zapier_url"]}},"type":"object"},"UnauthorizedZapierHookException":{"description":"Unauthorized zapier hook","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["unauthorized_zapier_hook"]}},"type":"object"},"ZapierHookDoesNotExistException":{"description":"Zapier hook does not exist","required":["state","state_message"],"properties":{"state":{"description":"Failure","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string","enum":["zapier_hook_does_not_exist"]}},"type":"object"},"ExportFileType":{"type":"string","enum":["csv","xlsx","json"]},"Filter":{"required":["mode","values"],"properties":{"mode":{"$ref":"#\/components\/schemas\/Mode"},"values":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"},{"$ref":"#\/components\/schemas\/Value"}]}}},"type":"object","example":{"mode":"or","values":[{"field_name":"3","type":"equals","value":"Moreau"},{"field_name":"3","type":"start_with","value":"Durand"},{"mode":"and","values":[{"field_name":"3","type":"end_with","value":"Lefebvre"},{"field_name":"4","type":"contains","value":"Claude"},{"field_name":"4","type":"not_contains","value":"Patrick"},{"field_name":"4","type":"not_equals","value":"Martin"}]}]}},"Mode":{"type":"string","enum":["and","or"]},"PaginationOptions":{"required":["mode","values"],"properties":{"per_page":{"description":"Number of results per page (max 200)","type":"integer","example":100,"default":100},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true},"sort":{"oneOf":[{"$ref":"#\/components\/schemas\/Sort"}],"nullable":true}},"type":"object"},"PRMPaginationOptionsUserIds":{"required":["user_ids"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"user_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}]},"Sort":{"required":["field_name","sort_direction"],"properties":{"field_name":{"type":"string"},"sort_direction":{"$ref":"#\/components\/schemas\/SortDirection"}},"type":"object"},"SortDirection":{"type":"string","enum":["asc","desc"]},"Type":{"type":"string","enum":["start_with","end_with","equals","not_equals","contains","not_contains","more_than","more_or_equal_than","less_than","less_or_equal_than","does_exist","does_not_exist"]},"Value":{"required":["field_name","type","value"],"properties":{"field_name":{"type":"string"},"type":{"$ref":"#\/components\/schemas\/Type"},"value":{"example":"My value","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"type":"object"},"Level":{"type":"string","enum":["user","admin","super_admin"]},"message":{"required":["key","translation","number","replacements"],"properties":{"key":{"type":"string"},"translation":{"type":"string"},"number":{"type":"integer","nullable":true},"replacements":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]}}},"type":"object"},"ApiInfo":{"required":["name","domain_saas","domain_saas2","domain_saas3","domain_files","domain_redirect","domain_api","logo_url","logo_menu_url","favicon_url","color_primary","color_secondary","color_muted","color_primary_text","color_secondary_text","link_chrome_extension","book_demo","pricing_url","contact_support","terms_of_sale","prm_default_custom_statuses","tags_default","videos","options"],"properties":{"name":{"type":"string"},"domain_saas":{"type":"string"},"domain_saas2":{"type":"string"},"domain_saas3":{"type":"string"},"domain_files":{"type":"string"},"domain_redirect":{"type":"string"},"domain_api":{"type":"string"},"logo_url":{"type":"string"},"logo_menu_url":{"type":"string"},"favicon_url":{"type":"string"},"color_primary":{"type":"string"},"color_secondary":{"type":"string"},"color_muted":{"type":"string"},"color_primary_text":{"type":"string"},"color_secondary_text":{"type":"string"},"link_chrome_extension":{"type":"string"},"book_demo":{"type":"string","nullable":true},"pricing_url":{"type":"string","nullable":true},"contact_support":{"type":"string","nullable":true},"terms_of_sale":{"type":"string","nullable":true},"prm_default_custom_statuses":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMDefaultCustomStatus"},"nullable":true},"tags_default":{"type":"array","items":{"type":"string"},"nullable":true},"videos":{"type":"array","items":{"$ref":"#\/components\/schemas\/Video"},"nullable":true},"options":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResellerOption"},"nullable":true}},"type":"object"},"APIKeyCreated":{"required":["api_key_id","token","name"],"properties":{"api_key_id":{"type":"integer","example":1},"token":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz"},"name":{"type":"string","example":"My API Key"}},"type":"object"},"APIKeyItem":{"description":"Displays the API Key profile detail","required":["id","token","name","created_on"],"properties":{"id":{"type":"integer","example":1},"token":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz"},"name":{"type":"string","example":"My API Key"},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"}},"type":"object"},"APIKeyResultItem":{"required":["id","token","name","created_on"],"properties":{"id":{"type":"integer","example":1},"token":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz"},"name":{"type":"string","example":"My API Key"},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"}},"type":"object"},"APIKeyUpdate":{"properties":{"name":{"type":"string","example":"My API Key","nullable":true}},"type":"object"},"AiAgentsActionType":{"description":"Allowed workflow action. The unknown value is deprecated and is accepted only for temporary backward compatibility.","type":"string","enum":["unknown","email","linkedin_invitation","linkedin_message"]},"AgentCreate":{"properties":{"name":{"description":"AI agent name. Effectively required: when omitted, the name is derived from first_name and last_name, and the request is rejected if both are also empty.","type":"string","example":"Outbound SDR Agent","nullable":true,"maxLength":255},"description":{"description":"AI agent description","type":"string","example":"Handles cold outreach for SaaS leads","nullable":true,"maxLength":65535},"active":{"description":"Whether the AI agent is active","type":"boolean","example":true,"nullable":true},"activity_description":{"description":"Description of the business activity used by the AI agent","type":"string","example":"B2B software for sales teams","nullable":true,"maxLength":65535},"website_url":{"description":"Website URL used as context by the AI agent","type":"string","example":"https:\/\/example.com","nullable":true,"maxLength":512},"brief":{"description":"Generated or custom brief for the AI agent","type":"string","example":"Focus on discovery questions before proposing a demo","nullable":true,"maxLength":65535},"first_name":{"description":"Agent persona first name. Used to derive the agent name when name is omitted; either name or first_name\/last_name must be provided.","type":"string","example":"Alex","nullable":true,"maxLength":100},"last_name":{"description":"Agent persona last name. Used to derive the agent name when name is omitted; either name or first_name\/last_name must be provided.","type":"string","example":"Martin","nullable":true,"maxLength":100},"gender":{"description":"Agent persona gender","example":"male","nullable":true},"spoken_language":{"description":"Spoken language code used by the AI agent","type":"string","example":"eng","nullable":true,"maxLength":16},"bio":{"description":"Short biography of the agent persona","type":"string","example":"Sales specialist with 10 years of experience","nullable":true,"maxLength":65535},"avatar":{"description":"Free-form avatar for the AI agent","type":"string","example":"sales-avatar-01","nullable":true,"maxLength":65535},"integration_id":{"description":"Linked integration identifier","type":"integer","example":1,"nullable":true},"linkedin_integration_id":{"description":"LinkedIn integration identifier","type":"integer","example":2,"nullable":true},"email_signature_id":{"description":"Email signature identifier used by the AI agent","type":"integer","example":1,"nullable":true},"agent_type":{"description":"Type of AI agent","example":"fictional","nullable":true},"referent_name":{"description":"Referent display name","type":"string","example":"Nina Johnson","nullable":true,"maxLength":255},"referent_integration_id":{"description":"Referent integration identifier","type":"integer","example":2,"nullable":true},"tone":{"description":"Conversation tone used by the AI agent","type":"string","example":"professional and concise","nullable":true,"maxLength":65535},"main_objective":{"description":"Main objective of the AI agent","example":"meeting","nullable":true},"objective_link":{"description":"Objective URL used in AI agent messages","type":"string","example":"https:\/\/example.com\/book-a-demo","nullable":true,"maxLength":512},"objective_link_type":{"description":"Type of objective link","type":"string","example":"calendar","nullable":true,"maxLength":100},"additional_instructions":{"description":"Additional instructions for the AI agent","type":"string","example":"Never mention discounts in first contact","nullable":true,"maxLength":65535},"scheduling_status":{"description":"Scheduling status for AI agent activities","example":"pending","nullable":true},"sharing":{"description":"Sharing rules to apply to the agent","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"example":[{"sharing_type_to":"user","read_permission":true,"write_permission":false,"delete_permission":false,"ids_list":[2],"name":"Share to sales team"}],"nullable":true},"tags_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"folder_id":{"type":"integer","nullable":true},"value_propositions":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentValuePropositionUpsert"},"nullable":true,"maxItems":50},"targets":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentTargetUpsert"},"nullable":true,"maxItems":50},"rules":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentRuleUpsert"},"nullable":true,"maxItems":50}},"type":"object"},"AgentGenerateBrief":{"properties":{"activity_description":{"description":"Optional business context used to generate the brief. Provide the company offer, target customers, sales process, channels, positioning, or any useful constraints. At least one source is required: activity_description or website_url. When both are provided, this field complements the website analysis.","type":"string","example":"A B2B sales automation platform for prospecting teams. It helps users build enriched prospect lists, launch email, LinkedIn and SMS sequences, track interactions, analyze campaign performance and nurture leads until conversion.","nullable":true,"maxLength":65535},"website_url":{"description":"Optional company website URL used for web-based analysis during brief generation. At least one source is required: activity_description or website_url. When both are provided, the URL is used as the primary website source and the activity description is used as complementary context.","type":"string","example":"https:\/\/example.com","nullable":true,"maxLength":512}},"type":"object"},"AgentRuleUpsert":{"required":["action_type","sorting"],"properties":{"action_type":{"$ref":"#\/components\/schemas\/AiAgentsActionType"},"sorting":{"description":"Display order of the rule","type":"integer","example":0,"maximum":65535,"minimum":0},"active":{"description":"Whether the rule is active. Omit or pass null to enable it by default.","type":"boolean","example":true,"nullable":true}},"type":"object"},"AgentTargetUpsert":{"required":["value","sorting"],"properties":{"value":{"description":"Target segment label","type":"string","example":"Head of Sales in B2B SaaS","maxLength":255},"sorting":{"description":"Display order of the target","type":"integer","example":0,"maximum":65535,"minimum":0},"active":{"description":"Whether the target is active. Omit or pass null to enable it by default.","type":"boolean","example":true,"nullable":true}},"type":"object"},"AgentUpdate":{"properties":{"name":{"description":"AI agent name","type":"string","example":"Outbound SDR Agent","nullable":true,"maxLength":255},"description":{"description":"AI agent description","type":"string","example":"Handles cold outreach for SaaS leads","nullable":true,"maxLength":65535},"active":{"description":"Whether the AI agent is active","type":"boolean","example":true,"nullable":true},"activity_description":{"description":"Description of the business activity used by the AI agent","type":"string","example":"B2B software for sales teams","nullable":true,"maxLength":65535},"website_url":{"description":"Website URL used as context by the AI agent","type":"string","example":"https:\/\/example.com","nullable":true,"maxLength":512},"brief":{"description":"Generated or custom brief for the AI agent","type":"string","example":"Focus on discovery questions before proposing a demo","nullable":true,"maxLength":65535},"first_name":{"description":"Agent persona first name","type":"string","example":"Alex","nullable":true,"maxLength":100},"last_name":{"description":"Agent persona last name","type":"string","example":"Martin","nullable":true,"maxLength":100},"gender":{"description":"Agent persona gender","example":"male","nullable":true},"spoken_language":{"description":"Spoken language code used by the AI agent","type":"string","example":"eng","nullable":true,"maxLength":16},"bio":{"description":"Short biography of the agent persona","type":"string","example":"Sales specialist with 10 years of experience","nullable":true,"maxLength":65535},"avatar":{"description":"Free-form avatar for the AI agent","type":"string","example":"sales-avatar-01","nullable":true,"maxLength":65535},"integration_id":{"description":"Linked integration identifier","type":"integer","example":1,"nullable":true},"linkedin_integration_id":{"description":"LinkedIn integration identifier","type":"integer","example":2,"nullable":true},"email_signature_id":{"description":"Email signature identifier used by the AI agent","type":"integer","example":1,"nullable":true},"agent_type":{"description":"Type of AI agent","example":"fictional","nullable":true},"referent_name":{"description":"Referent display name","type":"string","example":"Nina Johnson","nullable":true,"maxLength":255},"referent_integration_id":{"description":"Referent integration identifier","type":"integer","example":2,"nullable":true},"tone":{"description":"Conversation tone used by the AI agent","type":"string","example":"professional and concise","nullable":true,"maxLength":65535},"main_objective":{"description":"Main objective of the AI agent","example":"meeting","nullable":true},"objective_link":{"description":"Objective URL used in AI agent messages","type":"string","example":"https:\/\/example.com\/book-a-demo","nullable":true,"maxLength":512},"objective_link_type":{"description":"Type of objective link","type":"string","example":"calendar","nullable":true,"maxLength":100},"additional_instructions":{"description":"Additional instructions for the AI agent","type":"string","example":"Never mention discounts in first contact","nullable":true,"maxLength":65535},"scheduling_status":{"description":"Scheduling status for AI agent activities","example":"pending","nullable":true},"sharing":{"description":"Updated sharing rules for the AI agent","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"example":[{"sharing_type_to":"team","read_permission":true,"write_permission":false,"delete_permission":false,"ids_list":[1],"name":"Share to sales team"}],"nullable":true},"tags_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"folder_id":{"type":"integer","nullable":true},"value_propositions":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentValuePropositionUpsert"},"nullable":true,"maxItems":50},"targets":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentTargetUpsert"},"nullable":true,"maxItems":50},"rules":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentRuleUpsert"},"nullable":true,"maxItems":50}},"type":"object"},"AgentValuePropositionUpsert":{"required":["value","sorting"],"properties":{"value":{"description":"Value proposition content","type":"string","example":"Save 30% of prospecting time","maxLength":255},"sorting":{"description":"Display order of the value proposition","type":"integer","example":0,"maximum":65535,"minimum":0},"active":{"description":"Whether the value proposition is active. Omit or pass null to enable it by default.","type":"boolean","example":true,"nullable":true}},"type":"object"},"AgentGenerateBriefResponse":{"required":["activity_understanding","value_propositions","targets","tone","additional_instructions","bio"],"properties":{"activity_understanding":{"description":"Concise summary of what the company appears to offer, who it helps, which business problem it addresses and the expected outcome. This value can be used as the agent brief or activity understanding.","type":"string","example":"The company appears to offer a B2B sales automation platform for teams that need to structure outbound prospecting. It helps centralize prospect lists, multichannel sequences and campaign tracking. The expected outcome is a more organized prospecting workflow and better follow-up from first contact to conversion.","maxLength":65535},"value_propositions":{"description":"Generated sales value propositions. Each item should be a short, distinct benefit that can be reused in outreach messages or campaign positioning.","type":"array","items":{"type":"string","maxLength":255},"example":["Centralize prospecting actions in one workflow","Automate multichannel follow-up across email, LinkedIn and SMS"],"maxItems":50},"targets":{"description":"Generated prospecting targets. Each item should be an actionable buyer role, team, company segment or B2B audience for campaign setup.","type":"array","items":{"type":"string","maxLength":255},"example":["Sales directors in B2B software companies","Growth managers responsible for outbound acquisition"],"maxItems":50},"tone":{"description":"Recommended communication style for the AI agent, including formality, personalization level, concision, commercial posture and follow-up pressure.","type":"string","example":"Professional, direct and personalized. Messages should stay concise, focus on the prospect business problem and avoid aggressive follow-ups.","maxLength":65535},"additional_instructions":{"description":"Operational instructions for the AI agent, covering personalization, outreach angle, qualification questions, objection handling, call to action and follow-up style.","type":"string","example":"Personalize each message with the prospect role, company context and likely prospecting challenge. Qualify current tools, outbound volume, target markets and decision process. Propose a short discovery call or tailored demo as the main call to action. Keep follow-ups light, useful and spaced out.","maxLength":65535},"bio":{"description":"Short third-person biography for the AI sales persona. It should describe the agent mission and commercial posture without inventing a real identity, career history or quantified results.","type":"string","example":"The agent represents the company commercial team. It helps B2B prospects understand how the offer can improve their prospecting workflow. It asks focused questions and guides qualified prospects toward a relevant next step.","maxLength":65535}},"type":"object"},"AgentItem":{"required":["id","uniqid","name","description","active","created_on","updated_on","created_by","from_sharing","sharing","tags","permission","folder","activity_description","website_url","brief","first_name","last_name","gender","spoken_language","bio","avatar","integration_id","linkedin_integration_id","email_signature_id","agent_type","referent_name","referent_integration_id","tone","main_objective","objective_link","objective_link_type","additional_instructions","scheduling_status","value_propositions","targets","rules"],"properties":{"id":{"description":"AI agent identifier","type":"integer","example":1},"uniqid":{"description":"AI agent uniqid","type":"string","example":"AIAGENT123456"},"name":{"description":"AI agent name","type":"string","example":"Outbound SDR Agent","maxLength":255},"description":{"description":"AI agent description","type":"string","example":"Handles cold outreach for SaaS leads","nullable":true,"maxLength":65535},"active":{"description":"Whether the AI agent is active","type":"boolean","example":true},"created_on":{"description":"Creation datetime in RFC3339 format","type":"string","example":"2026-04-21T10:00:00+00:00"},"updated_on":{"description":"Last update datetime in RFC3339 format","type":"string","example":"2026-04-21T10:00:00+00:00"},"created_by":{"description":"Creator user identifier","type":"integer","example":1},"from_sharing":{"description":"Whether or not someone is sharing you this AI agent","type":"boolean"},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"activity_description":{"description":"Business activity description used by the AI agent","type":"string","example":"B2B software for sales teams","nullable":true,"maxLength":65535},"website_url":{"description":"Website URL used by the AI agent","type":"string","example":"https:\/\/example.com","nullable":true,"maxLength":512},"brief":{"description":"Generated or custom brief","type":"string","example":"Focus on qualifying prospects before proposing a call","nullable":true,"maxLength":65535},"first_name":{"description":"Agent persona first name","type":"string","example":"Alex","maxLength":100},"last_name":{"description":"Agent persona last name","type":"string","example":"Martin","maxLength":100},"gender":{"description":"Agent persona gender","example":"male","nullable":true},"spoken_language":{"description":"Spoken language code","type":"string","example":"eng","nullable":true,"maxLength":3},"bio":{"description":"Short biography for the AI persona","type":"string","example":"Sales specialist with 10 years of experience","nullable":true,"maxLength":65535},"avatar":{"description":"Free-form avatar for the AI agent","type":"string","example":"sales-avatar-01","nullable":true,"maxLength":65535},"integration_id":{"description":"Linked integration identifier","type":"integer","example":1,"nullable":true},"linkedin_integration_id":{"description":"LinkedIn integration identifier","type":"integer","example":2,"nullable":true},"email_signature_id":{"description":"Linked email signature identifier","type":"integer","example":1,"nullable":true},"agent_type":{"description":"Type of AI agent","example":"fictional"},"referent_name":{"description":"Referent display name","type":"string","example":"Nina Johnson","nullable":true,"maxLength":255},"referent_integration_id":{"description":"Referent integration identifier","type":"integer","example":2,"nullable":true},"tone":{"description":"Conversation tone","type":"string","example":"professional and concise","nullable":true,"maxLength":65535},"main_objective":{"description":"Main objective of the AI agent","example":"meeting","nullable":true},"objective_link":{"description":"Objective URL used by the AI agent","type":"string","example":"https:\/\/example.com\/book-a-demo","nullable":true,"maxLength":512},"objective_link_type":{"description":"Objective link type","type":"string","example":"calendar","nullable":true,"maxLength":100},"additional_instructions":{"description":"Additional instructions for the AI agent","type":"string","example":"Do not mention pricing in the first message","nullable":true,"maxLength":65535},"scheduling_status":{"description":"Scheduling status of AI activities","example":"pending"},"value_propositions":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentValuePropositionItem"}},"targets":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentTargetItem"}},"rules":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentRuleItem"}}},"type":"object"},"AgentListResponse":{"required":["agents"],"properties":{"agents":{"description":"List of AI agents","type":"array","items":{"$ref":"#\/components\/schemas\/AgentResultItem"}}},"type":"object"},"AgentResponse":{"required":["agent"],"properties":{"agent":{"$ref":"#\/components\/schemas\/AgentItem"}},"type":"object"},"AgentResultItem":{"required":["id","uniqid","name","description","active","from_sharing","read_permission","write_permission","delete_permission","created_by","tags","sharing","created_on","updated_on","folder","activity_description","website_url","brief","first_name","last_name","gender","spoken_language","bio","avatar","integration_id","linkedin_integration_id","email_signature_id","agent_type","referent_name","referent_integration_id","tone","main_objective","objective_link","objective_link_type","additional_instructions","scheduling_status","value_propositions","targets","rules"],"properties":{"id":{"description":"AI agent identifier","type":"integer","example":1},"uniqid":{"description":"AI agent uniqid","type":"string","example":"AIAGENT123456"},"name":{"description":"AI agent name","type":"string","example":"Outbound SDR Agent","maxLength":255},"description":{"description":"AI agent description","type":"string","example":"Handles cold outreach for SaaS leads","nullable":true,"maxLength":65535},"active":{"description":"Whether the AI agent is active","type":"boolean","example":true},"from_sharing":{"description":"Whether or not someone is sharing you this AI agent","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"Creator user identifier","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"activity_description":{"description":"Business activity description used by the AI agent","type":"string","example":"B2B software for sales teams","nullable":true,"maxLength":65535},"website_url":{"description":"Website URL used by the AI agent","type":"string","example":"https:\/\/example.com","nullable":true,"maxLength":512},"brief":{"description":"Generated or custom brief","type":"string","example":"Focus on qualifying prospects before proposing a call","nullable":true,"maxLength":65535},"first_name":{"description":"Agent persona first name","type":"string","example":"Alex","maxLength":100},"last_name":{"description":"Agent persona last name","type":"string","example":"Martin","maxLength":100},"gender":{"description":"Agent persona gender","example":"male","nullable":true},"spoken_language":{"description":"Spoken language code","type":"string","example":"eng","nullable":true,"maxLength":3},"bio":{"description":"Short biography for the AI persona","type":"string","example":"Sales specialist with 10 years of experience","nullable":true,"maxLength":65535},"avatar":{"description":"Free-form avatar for the AI agent","type":"string","example":"sales-avatar-01","nullable":true,"maxLength":65535},"integration_id":{"description":"Linked integration identifier","type":"integer","example":1,"nullable":true},"linkedin_integration_id":{"description":"LinkedIn integration identifier","type":"integer","example":2,"nullable":true},"email_signature_id":{"description":"Linked email signature identifier","type":"integer","example":1,"nullable":true},"agent_type":{"description":"Type of AI agent","example":"fictional"},"referent_name":{"description":"Referent display name","type":"string","example":"Nina Johnson","nullable":true,"maxLength":255},"referent_integration_id":{"description":"Referent integration identifier","type":"integer","example":2,"nullable":true},"tone":{"description":"Conversation tone","type":"string","example":"professional and concise","nullable":true,"maxLength":65535},"main_objective":{"description":"Main objective of the AI agent","example":"meeting","nullable":true},"objective_link":{"description":"Objective URL used by the AI agent","type":"string","example":"https:\/\/example.com\/book-a-demo","nullable":true,"maxLength":512},"objective_link_type":{"description":"Objective link type","type":"string","example":"calendar","nullable":true,"maxLength":100},"additional_instructions":{"description":"Additional instructions for the AI agent","type":"string","example":"Do not mention pricing in the first message","nullable":true,"maxLength":65535},"scheduling_status":{"description":"Scheduling status of AI activities","example":"pending"},"value_propositions":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentValuePropositionItem"}},"targets":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentTargetItem"}},"rules":{"type":"array","items":{"$ref":"#\/components\/schemas\/AgentRuleItem"}}},"type":"object"},"AgentRuleItem":{"properties":{"id":{"description":"Rule identifier","type":"integer","example":1},"ai_agent_id":{"description":"AI agent identifier","type":"integer","example":1},"action_type":{"$ref":"#\/components\/schemas\/AiAgentsActionType"},"sorting":{"description":"Display order of the rule","type":"integer","example":0,"maximum":65535,"minimum":0},"active":{"description":"Whether the rule is active","type":"boolean","example":true}},"type":"object"},"AgentTargetItem":{"properties":{"id":{"description":"Target identifier","type":"integer","example":1},"ai_agent_id":{"description":"AI agent identifier","type":"integer","example":1},"value":{"description":"Target segment label","type":"string","example":"Head of Sales in B2B SaaS","maxLength":255},"sorting":{"description":"Display order of the target","type":"integer","example":0,"maximum":65535,"minimum":0},"active":{"description":"Whether the target is active","type":"boolean","example":true}},"type":"object"},"AgentValuePropositionItem":{"properties":{"id":{"description":"Value proposition identifier","type":"integer","example":1},"ai_agent_id":{"description":"AI agent identifier","type":"integer","example":1},"value":{"description":"Value proposition content","type":"string","example":"Save 30% of prospecting time","maxLength":255},"sorting":{"description":"Display order of the value proposition","type":"integer","example":0,"maximum":65535,"minimum":0},"active":{"description":"Whether the value proposition is active","type":"boolean","example":true}},"type":"object"},"AiModelStyleChannel":{"type":"string","enum":["email","linkedin_invitation","linkedin_message"]},"AiModelStyleLearningJob":{"required":["uniqid","state","queued_date","start_date","end_date","percent","error","source_counts","profiles"],"properties":{"uniqid":{"type":"string"},"state":{"$ref":"#\/components\/schemas\/State"},"queued_date":{"type":"string","format":"date-time"},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"percent":{"type":"number","format":"float"},"error":{"type":"string","nullable":true},"source_counts":{"properties":{"email":{"type":"integer"},"linkedin_invitation":{"type":"integer"},"linkedin_message":{"type":"integer"}},"type":"object"},"profiles":{"properties":{"email":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevision"}]},"linkedin_invitation":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevision"}]},"linkedin_message":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevision"}]}},"type":"object"}},"type":"object"},"AiModelStyleProfileContent":{"required":["style_summary","tone","structure","cta_style","personalization_style","formatting_rules","preferred_patterns","avoid_patterns","subject_style","wording_patterns","opening_patterns","cta_patterns","placeholder_rules","forbidden_patterns","target_min_characters","target_max_characters"],"properties":{"style_summary":{"type":"string"},"tone":{"type":"string"},"structure":{"type":"string"},"cta_style":{"type":"string"},"personalization_style":{"type":"string"},"formatting_rules":{"type":"array","items":{"type":"string"}},"preferred_patterns":{"type":"array","items":{"type":"string"}},"avoid_patterns":{"type":"array","items":{"type":"string"}},"subject_style":{"type":"string"},"wording_patterns":{"type":"array","items":{"type":"string"}},"opening_patterns":{"type":"array","items":{"type":"string"}},"cta_patterns":{"type":"array","items":{"type":"string"}},"placeholder_rules":{"type":"array","items":{"type":"string"}},"forbidden_patterns":{"type":"array","items":{"type":"string"}},"target_min_characters":{"type":"integer","nullable":true},"target_max_characters":{"type":"integer","nullable":true}},"type":"object"},"AiModelStyleProfileRevision":{"required":["channel","version","active","source_count","created_at","admin_note","profile"],"properties":{"channel":{"$ref":"#\/components\/schemas\/AiModelStyleChannel"},"version":{"type":"integer"},"active":{"type":"boolean"},"source_count":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"admin_note":{"type":"string","nullable":true},"profile":{"$ref":"#\/components\/schemas\/AiModelStyleProfileContent"}},"type":"object"},"AiModelStyleProfileRevisionsPagination":{"required":["current_page","per_page","total","number_of_pages","previous_page","next_page"],"properties":{"current_page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"},"number_of_pages":{"type":"integer"},"previous_page":{"type":"integer","nullable":true},"next_page":{"type":"integer","nullable":true}},"type":"object"},"AiModelStyleProfileRevisionsResponse":{"required":["revisions","pagination"],"properties":{"revisions":{"type":"array","items":{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevision"}},"pagination":{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevisionsPagination"}},"type":"object"},"AiModelStyleProfilesResponse":{"required":["email","linkedin_invitation","linkedin_message"],"properties":{"email":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevision"}]},"linkedin_invitation":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevision"}]},"linkedin_message":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/AiModelStyleProfileRevision"}]}},"type":"object"},"AiModelStyleQueuedJob":{"required":["uniqid","state"],"properties":{"uniqid":{"type":"string"},"state":{"$ref":"#\/components\/schemas\/State"}},"type":"object"},"JobResultExtractCompaniesSearch":{"required":["company_name","description","short_description","followers","linkedin_company_url","linkedin_company_id","linkedin_company_handle"],"properties":{"company_name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"short_description":{"type":"string","nullable":true},"followers":{"type":"string","nullable":true},"linkedin_company_url":{"type":"string","nullable":true},"linkedin_company_id":{"type":"string","nullable":true},"linkedin_company_handle":{"type":"string","nullable":true}},"type":"object"},"JobResultExtractPeoplesSearch":{"required":["full_name","first_name","last_name","job_title","company_name","headline","location","linkedin_profile_url","image_url","profile_id","id","connection_degree","current_title","handle","current_company","profile_url","start_url","extracted_at"],"properties":{"full_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"job_title":{"type":"string","nullable":true},"company_name":{"type":"string","nullable":true},"headline":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"linkedin_profile_url":{"type":"string","nullable":true},"image_url":{"type":"string","nullable":true},"profile_id":{"type":"integer","nullable":true},"id":{"type":"string","nullable":true},"connection_degree":{"type":"string","nullable":true},"current_title":{"type":"string","nullable":true},"handle":{"type":"string","nullable":true},"current_company":{"type":"string","nullable":true},"profile_url":{"type":"string","nullable":true},"start_url":{"type":"string","nullable":true},"extracted_at":{"type":"string","nullable":true}},"type":"object"},"JobResultExtractSearchContent":{"required":["author_name","content_text","headline","linkedin_post_url","linkedin_post_id","linkedin_profile_url","comment_count","reaction_count","repost_count","published_time","published_date","profile_image_url","linkedin_profile_handle","content_image_url","linkedin_job_url","linkedin_profile_id","linkedin_company_id","linkedin_company_url"],"properties":{"author_name":{"type":"string","nullable":true},"content_text":{"type":"string","nullable":true},"headline":{"type":"string","nullable":true},"linkedin_post_url":{"type":"string"},"linkedin_post_id":{"type":"string"},"linkedin_profile_url":{"type":"string","nullable":true},"published_time":{"type":"string","nullable":true},"published_date":{"type":"string"},"profile_image_url":{"type":"string","nullable":true},"linkedin_profile_handle":{"type":"string"},"content_image_url":{"type":"string","nullable":true},"linkedin_job_url":{"type":"string","nullable":true},"linkedin_profile_id":{"type":"integer","nullable":true},"linkedin_company_id":{"type":"integer","nullable":true},"linkedin_company_url":{"type":"string","nullable":true},"comment_count":{"type":"integer"},"reaction_count":{"type":"integer"},"repost_count":{"type":"integer"}},"type":"object"},"WarmupSettings":{"description":"Displays the warmup settings","required":["warmup_enabled","total_warmup_per_day","daily_rampup","reply_rate_percentage","keyword"],"properties":{"warmup_enabled":{"description":"Enable or disable warmup. When enabled, the system gradually increases the number of emails sent to warm up the email account.","type":"boolean","example":true},"total_warmup_per_day":{"description":"Total number of warmup emails permitted per day. Can be set up to a maximum of 50 emails per day.","type":"integer","example":35},"daily_rampup":{"description":"Daily increase in the number of warmup emails. This number indicates how many additional emails will be sent each day during the warmup period, up to a maximum of 50 emails.","type":"integer","example":2},"reply_rate_percentage":{"description":"Target reply rate percentage during the warmup phase. This is the desired percentage of replies to the emails sent, which helps in establishing the account's reputation.","type":"integer","example":30},"keyword":{"description":"Use this keyword to filter out any warmup emails from your inbox.","type":"string","example":"apple-juice","nullable":true}},"type":"object"},"WarmupStats":{"description":"Provides statistical data on email warmup performance, including details on sent emails, classification into spam or inbox, and the reception of warmup emails.","required":["sent_count","spam_count","inbox_count","warmup_email_received_count","stats_per_day"],"properties":{"sent_count":{"description":"The total number of emails sent during the warmup process.","type":"integer","example":15,"nullable":true},"spam_count":{"description":"The number of emails that were marked as spam by the recipients email providers.","type":"integer","example":5,"nullable":true},"inbox_count":{"description":"The number of emails that successfully landed in the recipients inbox.","type":"integer","example":10,"nullable":true},"warmup_email_received_count":{"description":"The count of emails received back from the sent addresses during the warmup process.","type":"integer","example":40,"nullable":true},"stats_per_day":{"type":"array","items":{"$ref":"#\/components\/schemas\/WarmupStatsPerDay"},"nullable":true}},"type":"object"},"WarmupStatsPerDay":{"description":"Provides statistical data on email warmup performance, including emails sent, replies received, and saves from spam actions for a given date.","required":["date","sent_count","reply_count","save_from_spam_count"],"properties":{"date":{"description":"The date these statistics cover, formatted as YYYY-MM-DD.","type":"string","example":"2023-04-01"},"sent_count":{"description":"Total number of emails sent on this date as part of the warmup process.","type":"integer","example":100},"reply_count":{"description":"Number of replies received from the sent emails, used to measure engagement and effectiveness of the warmup.","type":"integer","example":5},"save_from_spam_count":{"description":"Number of times emails were marked as spam but then moved to the inbox, indicating successful engagement from recipients.","type":"integer","example":2}},"type":"object"},"BlacklistCreate":{"required":["name"],"properties":{"name":{"type":"string","example":"My blacklist"},"sharing":{"description":"The sharing currently configured for this blacklist.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"contains_match":{"description":"If true, blacklist matching uses \"contains\" instead of exact match. For example, if the blacklist contains \"@gmail.com\" for email, it will match any email containing \"@gmail.com\".","type":"boolean","example":false,"default":false}},"type":"object"},"BlacklistData":{"required":["id","data_field_id","blacklist_id","value"],"properties":{"id":{"type":"integer","example":1},"data_field_id":{"type":"integer","example":1},"blacklist_id":{"type":"integer","example":1},"value":{"type":"string","example":"name@example.com"}},"type":"object"},"BlacklistDataExtra":{"required":["id","data_field_id","blacklist_id","blacklist_name","value"],"properties":{"id":{"type":"integer","example":1},"data_field_id":{"type":"integer","example":1},"blacklist_id":{"type":"integer","example":1},"blacklist_name":{"type":"string","example":"My blacklist"},"value":{"type":"string","example":"name@example.com"}},"type":"object"},"BlacklistDataToImport":{"required":["data_field_id","value"],"properties":{"data_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"myemail@example.com"}},"type":"object"},"BlacklistItem":{"description":"Displays the blacklist profile detail","required":["id","name","number_of_data","from_sharing","sharing","created_by","permission","created_on","automatic_identifier","stats","contains_match"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My blacklist"},"number_of_data":{"type":"integer"},"from_sharing":{"description":"Whether or not someone is sharing you this blacklist","type":"boolean"},"sharing":{"description":"The sharing currently configured for this blacklist. Null if you are not the admin of this list","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this blacklist","type":"integer","example":1,"nullable":true},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"automatic_identifier":{"description":"An automatic identifier, if the blacklist is generated automatically","type":"string","nullable":true},"stats":{"type":"array","items":{"$ref":"#\/components\/schemas\/Blacklists.Stats"},"nullable":true},"contains_match":{"description":"If true, blacklist matching uses \"contains\" instead of exact match. For example, if the blacklist contains \"@gmail.com\" for email, it will match any email containing \"@gmail.com\".","type":"boolean","example":false,"default":false}},"type":"object"},"BlacklistListed":{"required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My blacklist"}},"type":"object"},"BlacklistResultItem":{"required":["id","name","number_of_data","from_sharing","read_permission","write_permission","delete_permission","created_by","sharing","created_on","automatic_identifier","contains_match"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My blacklist"},"number_of_data":{"type":"integer"},"from_sharing":{"description":"Whether or not someone is sharing you this blacklist","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this blacklist","type":"integer","example":1,"nullable":true},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"automatic_identifier":{"description":"An automatic identifier, if the blacklist is generated automatically","type":"string","nullable":true},"contains_match":{"description":"If true, blacklist matching uses \"contains\" instead of exact match. For example, if the blacklist contains \"@gmail.com\" for email, it will match any email containing \"@gmail.com\".","type":"boolean","example":false,"default":false}},"type":"object"},"BlacklistUpdate":{"properties":{"name":{"type":"string","example":"My blacklist","nullable":true},"sharing":{"description":"The sharing currently configured for this blacklist.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"contains_match":{"description":"If true, blacklist matching uses \"contains\" instead of exact match. For example, if the blacklist contains \"@gmail.com\" for email, it will match any email containing \"@gmail.com\".","type":"boolean","example":false,"nullable":true,"default":false}},"type":"object"},"BlacklistedCount":{"required":["blacklist_id","count"],"properties":{"blacklist_id":{"type":"integer","example":1},"count":{"type":"integer","example":1}},"type":"object"},"Blacklists.DatasSelection":{"required":["filter","data_ids","excluded_data_ids"],"properties":{"filter":{"$ref":"#\/components\/schemas\/Filter"},"data_ids":{"type":"array","items":{"type":"integer"}},"excluded_data_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"},"ImportBlacklistDataResponse":{"required":["data_ignored","data_imported","data_already_existing"],"properties":{"data_ignored":{"description":"Number of data ignored due to being invalid","type":"integer","example":1},"data_imported":{"description":"Number of data imported","type":"integer","example":1},"data_already_existing":{"description":"Number of data not imported because it is already existing","type":"integer","example":1}},"type":"object"},"Blacklists.Stats":{"required":["datafield_id","count"],"properties":{"datafield_id":{"type":"integer","example":1},"count":{"type":"integer"}},"type":"object"},"Contact":{"description":"Displays the contact profile detail","required":["id","contact_list_id","created_on","properties"],"properties":{"id":{"type":"integer","readOnly":true,"example":1},"contact_list_id":{"type":"integer","readOnly":true,"example":1,"nullable":true},"created_on":{"type":"string","format":"date-time","readOnly":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/ContactProperty"}}},"type":"object"},"ContactDatabase":{"description":"Displays the contact profile detail","required":["properties"],"properties":{"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/ContactProperty"}}},"type":"object"},"ContactExtra":{"required":["id","contact_list_id","contact_list_name","properties"],"properties":{"id":{"type":"integer","readOnly":true,"example":1},"contact_list_id":{"type":"integer","readOnly":true,"example":1},"contact_list_name":{"type":"string","readOnly":true,"example":"My contact list"},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/ContactProperty"}}},"type":"object"},"ContactImport":{"description":"Contact to import in contact list","required":["properties"],"properties":{"id":{"description":"Put a id to update a specific contact or null to create a new contact","type":"integer","example":1,"nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/ContactProperty"}}},"type":"object"},"ContactListInfo":{"required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My contact list"}},"type":"object"},"ContactListItem":{"description":"Displays the contact list profile detail","required":["id","name","number_of_contacts","number_of_emails","number_of_linkedin_url","state","state_details","from_sharing","sharing","created_by","tags","permission","created_on","folder","refreshable_targeting","urls_used","usedInProgrammations","number_of_companies","language","country","targeting_database_filters","pin","original_urls_used","list_type"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My contact list"},"number_of_contacts":{"type":"integer"},"number_of_emails":{"type":"integer"},"number_of_linkedin_url":{"type":"integer"},"number_of_companies":{"type":"integer"},"state":{"oneOf":[{"$ref":"#\/components\/schemas\/State"}],"nullable":true},"state_details":{"type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}},"from_sharing":{"description":"Whether or not someone is sharing you this contact list","type":"boolean"},"sharing":{"description":"The sharing currently configured for this contact list. Null if you are not the admin of this list","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this contact list","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"refreshable_targeting":{"description":"If the contact list has been used by Targeting, the field will be set to \"true\". This makes it possible to re-execute any Targeting previously done.","type":"boolean"},"urls_used":{"description":"Lists the URLs used to create the contact list","type":"array","items":{"type":"string","example":"http:\/\/my-url.ext"}},"usedInProgrammations":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowProgrammationListed"}},"language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"targeting_database_filters":{"description":"Filters used to create the contact list. These filters are used to target specific contacts in the database.","type":"array","items":{"$ref":"#\/components\/schemas\/DatabaseFilter"},"nullable":true},"pin":{"type":"boolean"},"original_urls_used":{"description":"Lists the original LinkedIn URLs used to create the contact list","type":"array","items":{"type":"string","example":"http:\/\/linkedin.com\/in\/example"},"nullable":true},"list_type":{"description":"Type of the contact list","type":"string","nullable":true,"enum":["linkedin","google_maps","imported"]}},"type":"object"},"ContactListNameResultItem":{"required":["id","name","number_of_contacts","number_of_emails","number_of_linkedin_url","number_of_companies","used_in_programmations","list_type"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My contact list"},"number_of_contacts":{"type":"integer"},"number_of_emails":{"type":"integer"},"number_of_linkedin_url":{"type":"integer"},"number_of_companies":{"type":"integer"},"from_sharing":{"description":"Whether or not someone is sharing you this contact list","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this contact list","type":"integer","example":1,"nullable":true},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"used_in_programmations":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowProgrammationListed"}},"list_type":{"nullable":true,"enum":["linkedin","google_maps","imported"]}},"type":"object"},"ContactListResultItem":{"required":["id","name","number_of_contacts","number_of_emails","number_of_linkedin_url","state","state_details","from_sharing","read_permission","write_permission","delete_permission","created_by","tags","sharing","created_on","folder","refreshable_targeting","urls_used","number_of_companies","language","country","targeting_database_filters","pin","usedInProgrammations","list_type"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My contact list"},"number_of_contacts":{"type":"integer"},"number_of_emails":{"type":"integer"},"number_of_linkedin_url":{"type":"integer"},"number_of_companies":{"type":"integer"},"state":{"oneOf":[{"$ref":"#\/components\/schemas\/State"}],"nullable":true},"state_details":{"type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}},"from_sharing":{"description":"Whether or not someone is sharing you this contact list","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this contact list","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"refreshable_targeting":{"description":"If the contact list has been used by Targeting, the field will be set to \"true\". This makes it possible to re-execute any Targeting previously done.","type":"boolean"},"urls_used":{"description":"Lists the URLs used to create the contact list","type":"array","items":{"type":"string","example":"http:\/\/my-url.ext"}},"usedInProgrammations":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowProgrammationListed"}},"language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"targeting_database_filters":{"description":"Filters used to create the contact list. These filters are used to target specific contacts in the database.","type":"array","items":{"$ref":"#\/components\/schemas\/DatabaseFilter"},"nullable":true},"pin":{"type":"boolean"},"list_type":{"description":"Type of the contact list","type":"string","nullable":true,"enum":["linkedin","google_maps","imported"]}},"type":"object"},"ContactProperty":{"required":["data_field_id","value"],"properties":{"data_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"myemail@example.com"}},"type":"object"},"ContactLists.ContactsSelection":{"required":["filter","contact_ids","excluded_contact_ids"],"properties":{"filter":{"$ref":"#\/components\/schemas\/Filter"},"contact_ids":{"type":"array","items":{"type":"integer"}},"excluded_contact_ids":{"type":"array","items":{"type":"integer"}},"reverse_selection":{"type":"boolean","default":false}},"type":"object"},"CopyContactsResponse":{"required":["contacts_added","contacts_updated","contacts_deleted","contacts_not_found","contacts_in_error"],"properties":{"contacts_added":{"description":"Number of contacts added","type":"integer","example":1},"contacts_updated":{"description":"Number of contacts updated","type":"integer","example":1},"contacts_deleted":{"description":"Number of contacts deleted","type":"integer","example":1},"contacts_not_found":{"description":"Number of contacts not found","type":"integer","example":1},"contacts_in_error":{"description":"Number of contacts in error","type":"integer","example":1}},"type":"object"},"contactlists.enrichexternalapi":{"type":"string","enum":["kaspr","dropcontact","contactout"]},"ImportContactsResponse":{"required":["contacts_added","contacts_updated","contacts_deleted","contacts_ignored","contacts_with_ignored_fields"],"properties":{"contacts_added":{"description":"Number of contacts added","type":"integer","example":1},"contacts_updated":{"description":"Number of contacts updated","type":"integer","example":1},"contacts_deleted":{"description":"Number of contacts deleted","type":"integer","example":1},"contacts_ignored":{"description":"If ignore_errors is true, this is the number of contacts ignored because all of their data is invalid","type":"integer","example":1},"contacts_with_ignored_fields":{"description":"If ignore_errors is true, this is the number of contacts that contains at least one ignored field","type":"integer","example":1}},"type":"object"},"SearchResultsContacts":{"required":["number_of_contacts","number_of_emails","number_of_linkedin_url"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SearchResults"},{"properties":{"number_of_contacts":{"description":"Number of contacts in the contact list","type":"integer","example":1},"number_of_emails":{"description":"Number of contacts with an email in the contact list","type":"integer","example":1},"number_of_linkedin_url":{"description":"Number of contacts with a linkedin url in the contact list","type":"integer","example":1}},"type":"object"}]},"cron_arguments":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListsCopyToBlacklist"},{"$ref":"#\/components\/schemas\/ContactListsCopyToUnsubscribers"},{"$ref":"#\/components\/schemas\/PrmSynchroniseWithMake"},{"$ref":"#\/components\/schemas\/ContactListsCopyContactListToMyPrm"},{"$ref":"#\/components\/schemas\/RefreshLinkedinTargetingContactList"}]},"ContactListsCopyContactListToMyPrm":{"required":["type","from_contact_list_id","status"],"properties":{"type":{"type":"string","enum":["contactlists_copy_contact_list_to_my_prm"]},"from_contact_list_id":{"type":"integer"},"status":{"$ref":"#\/components\/schemas\/PRMContactStatus"},"custom_status":{"type":"integer","nullable":true},"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true}},"type":"object"},"ContactListsCopyToBlacklist":{"required":["type","from_contact_list_id","blacklist_id","datafield_ids"],"properties":{"type":{"type":"string","enum":["contactlists_copy_to_blacklist"]},"from_contact_list_id":{"type":"integer"},"blacklist_id":{"type":"integer"},"datafield_ids":{"type":"array","items":{"type":"integer"}},"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true}},"type":"object"},"ContactListsCopyToUnsubscribers":{"required":["type","from_contact_list_id","datafield_ids"],"properties":{"type":{"type":"string","enum":["contactlists_copy_to_unsubscribers"]},"from_contact_list_id":{"type":"integer"},"organization_id":{"type":"integer","nullable":true},"datafield_ids":{"type":"array","items":{"type":"integer"}},"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactLists.ContactsSelection"}],"nullable":true}},"type":"object"},"PrmSynchroniseWithMake":{"required":["type","prm_user_id","datafield_ids","hook_url","resend_synchronized_contacts"],"properties":{"type":{"type":"string","enum":["prm_synchronise_with_make"]},"prm_user_id":{"type":"integer"},"datafield_ids":{"type":"array","items":{"type":"integer"}},"contacts_selection":{"oneOf":[{"$ref":"#\/components\/schemas\/prm.ContactsSelection"}],"nullable":true},"hook_url":{"type":"string","example":"https:\/\/hook.eu2.make.com\/abcdef"},"resend_synchronized_contacts":{"type":"boolean"}},"type":"object"},"RefreshLinkedinTargetingContactList":{"required":["type","linkedin_account_id","contactlist_id"],"properties":{"type":{"type":"string","enum":["refresh_linkedin_targeting_contact_list"]},"linkedin_account_id":{"type":"integer"},"contactlist_id":{"type":"integer"}},"type":"object"},"CronItem":{"required":["id","name","created_by","created_on","type","arguments","ran_at","execution_time_seconds","frequency","enabled","state","state_details"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My cron"},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date-time"},"type":{"$ref":"#\/components\/schemas\/crons.type"},"arguments":{"$ref":"#\/components\/schemas\/cron_arguments"},"ran_at":{"type":"string","format":"date-time","nullable":true},"execution_time_seconds":{"type":"number","format":"float","nullable":true},"frequency":{"$ref":"#\/components\/schemas\/crons.frequency"},"enabled":{"type":"boolean"},"state":{"oneOf":[{"$ref":"#\/components\/schemas\/State"}],"nullable":true},"state_details":{"type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}}},"type":"object"},"CronResultItem":{"required":["id","name","created_by","created_on","type","ran_at","execution_time_seconds","frequency","enabled"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My cron"},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date-time"},"type":{"$ref":"#\/components\/schemas\/crons.type"},"ran_at":{"type":"string","format":"date-time","nullable":true},"execution_time_seconds":{"type":"number","format":"float","nullable":true},"frequency":{"$ref":"#\/components\/schemas\/crons.frequency"},"enabled":{"type":"boolean"}},"type":"object"},"crons.frequency":{"type":"string","enum":["weekly","daily","every12hour","every6hour","everyhour","manual"]},"PrmContactSyncResponse":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","synced_contacts"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"synced_contacts":{"type":"integer","nullable":true}},"type":"object"}]},"crons.type":{"type":"string","enum":["contactlists_copy_to_blacklist","contactlists_copy_to_unsubscribers","prm_synchronise_with_make","contactlists_copy_contact_list_to_my_prm","refresh_linkedin_targeting_contact_list"]},"DataFieldItem":{"required":["id","name","identifier","identifier_placeholder","from_sharing","sharing","created_by","permission","created_on","readonly","possible_values","ai_prompt","ai_language","ai_temperature"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My data field"},"identifier":{"type":"string","example":"my_data_field"},"identifier_placeholder":{"type":"string","example":"%1_my_data_field%"},"from_sharing":{"type":"boolean"},"sharing":{"description":"The sharing currently configured for this data field. Null if you are not the admin of this data field","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this data field","type":"integer","example":1,"nullable":true},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"readonly":{"description":"Tells if the field on a contact can be modified","type":"boolean"},"possible_values":{"description":"The list of possible values if you want to limit them","type":"array","items":{"type":"string"},"nullable":true},"ai_prompt":{"description":"Prompt previously used to generate datafield content","type":"string","nullable":true},"ai_language":{"description":"Language previously used to generate datafield content","type":"string","nullable":true},"ai_temperature":{"description":"Temperature previously used to generate datafield content","type":"number","format":"float","nullable":true}},"type":"object"},"DataFieldResultItem":{"required":["id","name","identifier","identifier_placeholder","from_sharing","read_permission","write_permission","delete_permission","created_by","sharing","created_on","sorting","readonly","possible_values","ai_prompt","ai_language","ai_temperature","default_datafield_replacement"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My data field"},"identifier":{"type":"string","example":"my_data_field"},"identifier_placeholder":{"type":"string","example":"%1_my_data_field%"},"from_sharing":{"description":"Whether or not someone is sharing you this data field","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this data field","type":"integer","example":1,"nullable":true},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"sorting":{"type":"integer"},"created_on":{"type":"string","format":"date-time"},"readonly":{"description":"Tells if the field on a contact can be modified","type":"boolean"},"possible_values":{"description":"The list of possible values if you want to limit them","type":"array","items":{"type":"string"},"nullable":true},"ai_prompt":{"description":"Prompt previously used to generate datafield content","type":"string","nullable":true},"ai_language":{"description":"Language previously used to generate datafield content","type":"string","nullable":true},"ai_temperature":{"description":"Temperature previously used to generate datafield content","type":"number","format":"float","nullable":true},"default_datafield_replacement":{"description":"If empty, it will be replaced by this value that you configured on your profile","type":"string","nullable":true}},"type":"object"},"BounceType":{"type":"string","enum":["Blocked","Autoreply","Soft","Hard","Temporary","Generic"]},"EmailSignatureItem":{"description":"Displays the email signature profile detail","required":["id","name","html","text","json_template","is_template","from_sharing","sharing","created_by","permission","created_on","pin","links"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Email signature name"},"html":{"type":"string","example":"HTML version of the email signature"},"text":{"type":"string","example":"TEXT version of the email signature"},"json_template":{"type":"string","example":"[]"},"is_template":{"type":"boolean","example":"Is designed on the template editor ?"},"from_sharing":{"description":"Whether or not someone is sharing you this email signature","type":"boolean"},"sharing":{"description":"The sharing currently configured for this email signature. Null if you are not the admin of this email signature","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this email signature","type":"integer","example":1,"nullable":true},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"pin":{"type":"boolean"},"links":{"description":"List of links contained in your HTML","type":"array","items":{"type":"string","example":"https:\/\/example.com\/"},"example":"[]"}},"type":"object"},"EmailSignatureResultItem":{"required":["id","name","is_template","from_sharing","read_permission","write_permission","delete_permission","created_by","sharing","created_on","pin","links"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Email signature name"},"is_template":{"type":"boolean","example":"Is designed on the template editor ?"},"from_sharing":{"description":"Whether or not someone is sharing you this email signature","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this email signature","type":"integer","example":1,"nullable":true},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"pin":{"type":"boolean"},"links":{"description":"List of links contained in your HTML","type":"array","items":{"type":"string","example":"https:\/\/example.com\/"},"example":"[]"}},"type":"object"},"EmailSignatureShortItem":{"required":["id","name","from_sharing","sharing","created_by","permission","created_on","pin"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Email signature name"},"from_sharing":{"description":"Whether or not someone is sharing you this email signature","type":"boolean"},"sharing":{"description":"The sharing currently configured for this email signature. Null if you are not the admin of this email signature","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this email signature","type":"integer","example":1,"nullable":true},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"pin":{"type":"boolean"}},"type":"object"},"AdminUsageStatistic":{"required":["user_id","resolve_urls_count","edges_count","enrich_count","enrich_email_count"],"properties":{"user_id":{"type":"integer","example":1},"resolve_urls_count":{"type":"integer","example":12},"edges_count":{"type":"integer","example":9},"enrich_count":{"type":"integer","example":8},"enrich_email_count":{"type":"integer","example":3}},"type":"object"},"AdminUsageStatistics":{"required":["statistics","totals"],"properties":{"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/AdminUsageStatistic"}},"totals":{"$ref":"#\/components\/schemas\/AdminUsageTotals"}},"type":"object"},"AdminUsageTotals":{"required":["resolve_urls_count","edges_count","enrich_count","enrich_email_count"],"properties":{"resolve_urls_count":{"type":"integer","example":12},"edges_count":{"type":"integer","example":9},"enrich_count":{"type":"integer","example":8},"enrich_email_count":{"type":"integer","example":3}},"type":"object"},"EnrichBatchContactEnrichmentStatus":{"type":"string","enum":["pending","enriched","not_enriched","error"]},"EnrichBatchCreate":{"required":["contacts","linkedin_account_id"],"properties":{"contacts":{"description":"List of contacts to enrich (1-100)","type":"array","items":{"type":"array","items":{"$ref":"#\/components\/schemas\/EnrichContactField"}},"maxItems":100,"minItems":1},"global_enrich":{"description":"Enable global enrichment. This must be enabled when generate_email is true.","type":"boolean","example":false},"generate_email":{"description":"Generate an email through global enrichment. Requires global_enrich to be true; otherwise the API returns HTTP 400.","type":"boolean","example":false},"linkedin_account_id":{"type":"integer","example":1}},"type":"object"},"EnrichBatchProviderErrorSource":{"type":"string","enum":["enrich_batch","linkedin_extract_profile"]},"EnrichBatchPublicError":{"required":["source","code","message","retry_after"],"properties":{"source":{"type":"string","enum":["enrich_batch","linkedin_extract_profile"]},"code":{"type":"string","example":"LIMIT_REACHED"},"message":{"type":"string","example":"LinkedIn daily limit reached for this account."},"retry_after":{"type":"string","example":"2026-07-02T07:45:41.914Z","nullable":true}},"type":"object"},"EnrichContactField":{"required":["data_field_id","value"],"properties":{"data_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"myemail@example.com"}},"type":"object"},"EnrichedContactsResponse":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","enriched_contacts"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"enriched_contacts":{"type":"integer","nullable":true}},"type":"object"}]},"ExternalApiKeyItem":{"description":"Displays external API key profile details","required":["id","api_key","api_secret","consumer_key","type","name","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My API Key"},"type":{"$ref":"#\/components\/schemas\/externalapikeys.type"},"api_key":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz"},"api_secret":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"consumer_key":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"is_valid":{"type":"boolean"}},"type":"object"},"ExternalApiKeyResultItem":{"required":["id","api_key","api_secret","consumer_key","name","type","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My API Key"},"type":{"$ref":"#\/components\/schemas\/externalapikeys.type"},"api_key":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz"},"api_secret":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"consumer_key":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"is_valid":{"type":"boolean"}},"type":"object"},"ExternalApiKeyUpdate":{"properties":{"name":{"type":"string","example":"My API Key","nullable":true},"api_key":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"api_secret":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true},"consumer_key":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","nullable":true}},"type":"object"},"externalapikeys.type":{"type":"string","enum":["openai","datagma","fullenrich","kaspr","pipedrive","ovh","dropcontact","contactout"]},"FileCreated":{"required":["file_id","file_url"],"properties":{"file_id":{"description":"Display the file ID","type":"integer","example":1},"file_url":{"description":"Display the file URL for download","type":"string","example":"http:\/\/www.example.com\/file"},"thumbnail":{"description":"Base64 thumbnail (if an image)","type":"string","nullable":true}},"type":"object"},"FileItem":{"description":"Displays the Files profile detail","required":["id","name","file_size","file_url","from_sharing","sharing","created_by","permission","created_on","folder"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My file"},"file_size":{"type":"string"},"file_url":{"type":"string"},"thumbnail":{"description":"Base64 thumbnail (if an image)","type":"string","nullable":true},"from_sharing":{"description":"Whether or not someone is sharing you this file","type":"boolean"},"sharing":{"description":"The sharing currently configured for this file. Null if you are not the admin of this file","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this file","type":"integer","example":1,"nullable":true},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true}},"type":"object"},"FileResultItem":{"required":["id","name","file_size","file_url","from_sharing","read_permission","write_permission","created_by","sharing","created_on","folder"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My file"},"file_size":{"type":"string"},"file_url":{"type":"string"},"thumbnail":{"description":"Base64 thumbnail (if an image)","type":"string","nullable":true},"from_sharing":{"description":"Whether or not someone is sharing you this file","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this file","type":"integer","example":1,"nullable":true},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true}},"type":"object"},"FileSearchItem":{"required":["id","name","file_size","file_url","from_sharing","created_by","created_on","folder"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My file"},"file_size":{"type":"string"},"file_url":{"type":"string"},"thumbnail":{"description":"Base64 thumbnail (if an image)","type":"string","nullable":true},"from_sharing":{"description":"Whether or not someone is sharing you this file","type":"boolean"},"created_by":{"description":"The user id of the person that has created this file","type":"integer","example":1,"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true}},"type":"object"},"FolderListed":{"required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My folder"}},"type":"object"},"FolderProfile":{"description":"Displays the contact list profile detail","required":["id","name","type","created_on","created_by","number_of_items","items","parent_id"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My folder"},"type":{"$ref":"#\/components\/schemas\/FolderType"},"created_on":{"type":"string","format":"date-time"},"created_by":{"type":"integer","example":1},"number_of_items":{"type":"integer","example":1},"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/AbstractModelItemOpenApi"}},"parent_id":{"type":"integer","example":1,"nullable":true}},"type":"object"},"FolderResultItem":{"required":["id","name","type","created_on","number_of_items","parent_id"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My folder"},"type":{"$ref":"#\/components\/schemas\/FolderType"},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"number_of_items":{"type":"integer","example":1},"parent_id":{"type":"integer","example":1,"nullable":true}},"type":"object"},"FolderType":{"type":"string","enum":["ContactList","Model","File","Workflow","AiAgent","PRM"]},"FormItem":{"description":"Displays form profile details","required":["id","name","domain","created_by","created_on","updated_on","domain_info","html","contact_list_id","is_ready"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My form"},"domain":{"type":"string","example":"http:\/\/form.example.org","nullable":true},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"updated_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"domain_info":{"oneOf":[{"$ref":"#\/components\/schemas\/ingressesDomainInfo"}],"nullable":true},"html":{"type":"string","example":"HTML form content","nullable":true},"contact_list_id":{"type":"integer","example":1,"nullable":true},"is_ready":{"type":"boolean","example":true}},"type":"object"},"FormResultItem":{"required":["id","name","domain","created_by","created_on","updated_on","domain_info","html","contact_list_id","is_ready"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My form"},"domain":{"type":"string","example":"http:\/\/form.example.org","nullable":true},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"updated_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"domain_info":{"oneOf":[{"$ref":"#\/components\/schemas\/ingressesDomainInfo"}],"nullable":true},"html":{"type":"string","example":"HTML form content","nullable":true},"contact_list_id":{"type":"integer","example":1,"nullable":true},"is_ready":{"type":"boolean","example":true}},"type":"object"},"FormUpdate":{"properties":{"name":{"type":"string","example":"My form","nullable":true},"domain":{"type":"string","example":"http:\/\/form.example.org","nullable":true}},"type":"object"},"ingressesDomainInfo":{"required":["domain","status","status_date"],"properties":{"domain":{"type":"string","example":"example.domain.ext"},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/ingressesDomainStatus"}],"nullable":true,"example":"active"},"status_date":{"type":"string","format":"date-time","nullable":true}},"type":"object"},"ingressesDomainStatus":{"description":"DomainStatus","type":"string","enum":["new","waiting_dns","active","dns_failure","invalid"]},"IntegrationType":{"type":"string","enum":["Email","Linkedin"]},"IntegrationsResultItem":{"required":["id","name","type","account_type_email","is_valid","from_sharing","read_permission","write_permission","delete_permission","created_by","created_on","last_use","first_use"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Name"},"type":{"$ref":"#\/components\/schemas\/IntegrationType"},"account_type_email":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"}],"nullable":true},"is_valid":{"type":"boolean"},"from_sharing":{"description":"Whether or not someone is sharing you this","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this","type":"integer","example":1,"nullable":true},"created_on":{"type":"string","format":"date-time"},"last_use":{"description":"Date of the last use","type":"string","format":"date-time","nullable":true},"first_use":{"description":"Date of the first use","type":"string","format":"date-time","nullable":true}},"type":"object"},"AbstractIntegrationsEmailItem":{"properties":{"id":{"type":"integer","example":1},"sender":{"type":"string","example":"My sender name"},"from_sharing":{"description":"Whether or not someone is sharing you this email","type":"boolean"},"sharing":{"description":"The sharing currently configured for this email. Null if you are not the admin of this email","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this email","type":"integer","example":1,"nullable":true},"created_on":{"type":"string","format":"date-time"},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1,"nullable":true},"email_signatures_profile":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureShortItem"}],"nullable":true},"last_use":{"description":"Date of the last use","type":"string","format":"date-time","nullable":true},"first_use":{"description":"Date of the first use","type":"string","format":"date-time","nullable":true},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"custom_tracking_domain_status":{"oneOf":[{"$ref":"#\/components\/schemas\/ingressesDomainStatus"}],"nullable":true},"custom_tracking_domain_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"mailgun_domain":{"description":"Mailgun sending domain","type":"string","example":"mg.example.com","nullable":true},"mailgun_region":{"oneOf":[{"$ref":"#\/components\/schemas\/mailgunRegion"}],"nullable":true,"description":"Mailgun API region","example":"EU"},"mailgun_from_email":{"description":"From email used when sending through Mailgun","type":"string","example":"sales@example.com","nullable":true},"mailgun_webhook_url":{"description":"Public Mailgun webhook URL to configure in Mailgun","type":"string","nullable":true},"has_mailgun_api_key":{"description":"Whether a Mailgun API key is stored","type":"boolean"},"has_mailgun_webhook_signing_key":{"description":"Whether a Mailgun webhook signing key is stored","type":"boolean"},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","default":false}},"type":"object"},"IntegrationsEmailAccountType":{"type":"string","enum":["MassMailing","SMTP","Gmail","Outlook"]},"AddGmailReturn":{"properties":{"id":{"type":"integer","example":1},"redirect_url":{"description":"Redirect URL to add your Gmail account","type":"string"}},"type":"object"},"AddOutlookReturn":{"properties":{"id":{"type":"integer","example":1},"redirect_url":{"description":"Redirect URL to add your Outlook account","type":"string"}},"type":"object"},"DiscoverSettings":{"description":"Displays the email server settings discovered by Autodiscover","required":["SMTP","IMAP"],"properties":{"smtp_host":{"type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"type":"integer","example":587,"nullable":true},"smtp_secure":{"type":"string","example":"ssl\/tls","nullable":true},"imap_host":{"type":"string","example":"imap.example.com","nullable":true},"imap_port":{"type":"integer","example":993,"nullable":true},"imap_secure":{"type":"string","example":"ssl\/tls","nullable":true}},"type":"object"},"EmailGmailAdd":{"required":["name"],"properties":{"name":{"description":"Email account name","type":"string","example":"My email","nullable":true},"sender":{"description":"Sender name","type":"string","example":"My email sender","nullable":true},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"enable_tracking":{"description":"If TRUE, the openers\/clickers tracking will be active.\n        <br \/>If FALSE, opener\/clicker tracking will be inactive.","type":"boolean","example":true,"nullable":true,"default":true},"sending_frequency_start":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":200,"nullable":true},"sending_frequency_end":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":300,"nullable":true},"warm_up":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmUp"}],"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"final_redirect_url":{"description":"The url to redirect the user when he has finished the process. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/%id%"},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","nullable":true,"default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","nullable":true,"default":false}},"type":"object"},"EmailGmailUpdate":{"properties":{"name":{"description":"Email account name","type":"string","example":"My email","nullable":true},"sender":{"description":"Sender name","type":"string","example":"My email sender","nullable":true},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"enable_tracking":{"description":"If TRUE, the openers\/clickers tracking will be active.\n        <br \/>If FALSE, opener\/clicker tracking will be inactive.","type":"boolean","example":true,"nullable":true},"sending_frequency_start":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":200,"nullable":true},"sending_frequency_end":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":300,"nullable":true},"warm_up":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmUp"}],"nullable":true},"smtp_username":{"description":"SMTP Username (usually your email address). Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override. When the SMTP override is used and this value is a valid email address, it is used as the From address and the Gmail account email is added as Reply-To.","type":"string","example":"me@example.com","nullable":true},"smtp_password":{"description":"SMTP Password. Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"string","example":"abcdefg","nullable":true},"smtp_host":{"description":"SMTP Host (Example: smtp.domain.ext). Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"description":"SMTP Port (Example: 25 \/ 465 \/ 587). Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"integer","example":587,"nullable":true},"smtp_secure":{"description":"SMTP Connection Security. Possible values: tls\/ssl. Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"string","example":"tls","nullable":true},"mailgun_domain":{"description":"Mailgun sending domain. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"mg.example.com","nullable":true},"mailgun_region":{"oneOf":[{"$ref":"#\/components\/schemas\/mailgunRegion"}],"nullable":true,"description":"Mailgun API region. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","example":"EU"},"mailgun_api_key":{"description":"Mailgun API key. This secret is never returned by the API. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"key-example","nullable":true},"mailgun_from_email":{"description":"From email used when sending through Mailgun. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"sales@example.com","nullable":true},"mailgun_webhook_signing_key":{"description":"Mailgun webhook signing key. This secret is never returned by the API. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"signing-key-example","nullable":true},"connection_test":{"description":"If TRUE, test the effective SMTP credentials, including stored credentials when no SMTP field is sent.\n        <br \/>If FALSE, do not test the SMTP connection.","type":"boolean","example":true,"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"final_redirect_url":{"description":"The url to redirect the user when he has finished the process. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/%id%"},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","nullable":true,"default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","nullable":true,"default":false}},"type":"object"},"EmailOutlookAdd":{"required":["name"],"properties":{"name":{"description":"Email account name","type":"string","example":"My email","nullable":true},"sender":{"description":"Sender name","type":"string","example":"My email sender","nullable":true},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"enable_tracking":{"description":"If TRUE, the openers\/clickers tracking will be active.\n        <br \/>If FALSE, opener\/clicker tracking will be inactive.","type":"boolean","example":true,"nullable":true,"default":true},"sending_frequency_start":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":200,"nullable":true},"sending_frequency_end":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":300,"nullable":true},"warm_up":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmUp"}],"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"final_redirect_url":{"description":"The url to redirect the user when he has finished the process. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/%id%"},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","nullable":true,"default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","nullable":true,"default":false}},"type":"object"},"EmailOutlookUpdate":{"properties":{"name":{"description":"Email account name","type":"string","example":"My email","nullable":true},"sender":{"description":"Sender name","type":"string","example":"My email sender","nullable":true},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"enable_tracking":{"description":"If TRUE, the openers\/clickers tracking will be active.\n        <br \/>If FALSE, opener\/clicker tracking will be inactive.","type":"boolean","example":true,"nullable":true},"sending_frequency_start":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":200,"nullable":true},"sending_frequency_end":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":300,"nullable":true},"warm_up":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmUp"}],"nullable":true},"smtp_username":{"description":"SMTP Username (usually your email address). Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override. When the SMTP override is used and this value is a valid email address, it is used as the From address and the Outlook account email is added as Reply-To.","type":"string","example":"me@example.com","nullable":true},"smtp_password":{"description":"SMTP Password. Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"string","example":"abcdefg","nullable":true},"smtp_host":{"description":"SMTP Host (Example: smtp.domain.ext). Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"description":"SMTP Port (Example: 25 \/ 465 \/ 587). Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"integer","example":587,"nullable":true},"smtp_secure":{"description":"SMTP Connection Security. Possible values: tls\/ssl. Omit this field to keep the current value. Send all SMTP fields as null to remove the SMTP override.","type":"string","example":"tls","nullable":true},"mailgun_domain":{"description":"Mailgun sending domain. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"mg.example.com","nullable":true},"mailgun_region":{"oneOf":[{"$ref":"#\/components\/schemas\/mailgunRegion"}],"nullable":true,"description":"Mailgun API region. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","example":"EU"},"mailgun_api_key":{"description":"Mailgun API key. This secret is never returned by the API. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"key-example","nullable":true},"mailgun_from_email":{"description":"From email used when sending through Mailgun. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"sales@example.com","nullable":true},"mailgun_webhook_signing_key":{"description":"Mailgun webhook signing key. This secret is never returned by the API. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"signing-key-example","nullable":true},"connection_test":{"description":"If TRUE, test the effective SMTP credentials, including stored credentials when no SMTP field is sent.\n        <br \/>If FALSE, do not test the SMTP connection.","type":"boolean","example":true,"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"final_redirect_url":{"description":"The url to redirect the user when he has finished the process. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/%id%"},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","nullable":true,"default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","nullable":true,"default":false}},"type":"object"},"EmailSmtpAdd":{"required":["name","email"],"properties":{"name":{"description":"Email account name","type":"string","example":"My email"},"email":{"description":"Email address","type":"string","example":"me@example.com"},"sender":{"description":"Sender name","type":"string","example":"My email sender","nullable":true},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"smtp_username":{"description":"SMTP Username (This is usually your email address)","type":"string","example":"me@example.com","nullable":true},"smtp_password":{"description":"SMTP Password","type":"string","example":"abcdefg","nullable":true},"smtp_host":{"description":"SMTP Host (Example : smtp.domain.ext)","type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"description":"SMTP Port (Example : 25 \/ 465 \/ 587)","type":"integer","example":587,"nullable":true},"smtp_secure":{"description":"SMTP Connection Security. Possible values : tls\/ssl","type":"string","example":"tls","nullable":true},"mailgun_domain":{"description":"Mailgun sending domain","type":"string","example":"mg.example.com","nullable":true},"mailgun_region":{"oneOf":[{"$ref":"#\/components\/schemas\/mailgunRegion"}],"nullable":true,"description":"Mailgun API region","example":"EU"},"mailgun_api_key":{"description":"Mailgun API key. This secret is never returned by the API.","type":"string","example":"key-example","nullable":true},"mailgun_from_email":{"description":"From email used when sending through Mailgun","type":"string","example":"sales@example.com","nullable":true},"mailgun_webhook_signing_key":{"description":"Mailgun webhook signing key. This secret is never returned by the API.","type":"string","example":"signing-key-example","nullable":true},"imap_username":{"description":"IMAP Username (This is usually your email address)","type":"string","example":"me@example.com","nullable":true},"imap_password":{"description":"IMAP Password","type":"string","example":"abcdefg","nullable":true},"imap_host":{"description":"IMAP Host (Example : imap.domain.ext)","type":"string","example":"imap.example.com","nullable":true},"imap_port":{"description":"IMAP Port (Example : 143 or 993)","type":"integer","example":993,"nullable":true},"imap_secure":{"description":"IMAP Connection Security. Possible values : tls\/ssl","type":"string","example":"ssl","nullable":true},"enable_tracking":{"description":"If TRUE, the openers\/clickers tracking will be active.\n        <br \/>If FALSE, opener\/clicker tracking will be inactive.","type":"boolean","example":true,"nullable":true,"default":true},"sending_frequency_start":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":200,"nullable":true},"sending_frequency_end":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":300,"nullable":true},"warm_up":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmUp"}],"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","nullable":true,"default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","nullable":true,"default":false}},"type":"object"},"EmailSmtpUpdate":{"properties":{"name":{"description":"Email account name","type":"string","example":"My email","nullable":true},"email":{"description":"Email address","type":"string","example":"me@example.com","nullable":true},"sender":{"description":"Sender name","type":"string","example":"My email sender","nullable":true},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"smtp_username":{"description":"SMTP Username (This is usually your email address)","type":"string","example":"me@example.com","nullable":true},"smtp_password":{"description":"SMTP Password","type":"string","example":"abcdefg","nullable":true},"smtp_host":{"description":"SMTP Host (Example : smtp.domain.ext)","type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"description":"SMTP Port (Example : 25 \/ 465 \/ 587)","type":"integer","example":587,"nullable":true},"smtp_secure":{"description":"SMTP Connection Security. Possible values : tls\/ssl","type":"string","example":"tls","nullable":true},"mailgun_domain":{"description":"Mailgun sending domain. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"mg.example.com","nullable":true},"mailgun_region":{"oneOf":[{"$ref":"#\/components\/schemas\/mailgunRegion"}],"nullable":true,"description":"Mailgun API region. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","example":"EU"},"mailgun_api_key":{"description":"Mailgun API key. This secret is never returned by the API. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"key-example","nullable":true},"mailgun_from_email":{"description":"From email used when sending through Mailgun. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"sales@example.com","nullable":true},"mailgun_webhook_signing_key":{"description":"Mailgun webhook signing key. This secret is never returned by the API. Omit this field to keep the current value. Send all Mailgun fields as null to remove Mailgun.","type":"string","example":"signing-key-example","nullable":true},"imap_username":{"description":"IMAP Username (This is usually your email address)","type":"string","example":"me@example.com","nullable":true},"imap_password":{"description":"IMAP Password","type":"string","example":"abcdefg","nullable":true},"imap_host":{"description":"IMAP Host (Example : imap.domain.ext)","type":"string","example":"imap.example.com","nullable":true},"imap_port":{"description":"IMAP Port (Example : 143 or 993)","type":"integer","example":993,"nullable":true},"imap_secure":{"description":"IMAP Connection Security. Possible values : tls\/ssl","type":"string","example":"ssl","nullable":true},"enable_tracking":{"description":"If TRUE, the openers\/clickers tracking will be active.\n        <br \/>If FALSE, opener\/clicker tracking will be inactive.","type":"boolean","example":true,"nullable":true},"sending_frequency_start":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":200,"nullable":true},"sending_frequency_end":{"description":"Time lapse between two sendings (in seconds).\n        <br \/>[start] = Between X seconds\n        <br \/>[end] = And X seconds","type":"integer","example":300,"nullable":true},"warm_up":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmUp"}],"nullable":true},"sharing":{"description":"Sharing configuration","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pools_ids":{"description":"Pools ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1},"connection_test":{"description":"If TRUE, we will test the connection to your SMTP account.\n        <br \/>If FALSE, we do not test the connection to your SMTP account.","type":"boolean","example":true,"nullable":true},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","nullable":true,"default":false},"add_sender_as_recipient_in_replies":{"description":"Automatically add sender email as recipient when replying to a lead","type":"boolean","nullable":true,"default":false}},"type":"object"},"IntegrationsEmailGmailItem":{"required":["id","from_sharing","name","email","sender","account_type","enable_tracking","sending_frequency_start","sending_frequency_end","warm_up","sharing","created_by","is_valid","pools","permission","created_on","auth_url","final_redirect_url","email_signatures_id","email_signatures_profile","last_use","first_use","api_gmail_id","reply_to","smtp_username","smtp_host","smtp_port","smtp_secure","custom_tracking_domain","custom_tracking_domain_status","custom_tracking_domain_status_date","read_autoresponse","add_sender_as_recipient_in_replies","mailgun_domain","mailgun_region","mailgun_from_email","mailgun_webhook_url","has_mailgun_api_key","has_mailgun_webhook_signing_key"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractIntegrationsEmailItem"},{"properties":{"name":{"type":"string","example":"Email name"},"email":{"type":"string","example":"me@example.com"},"account_type":{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"},"enable_tracking":{"type":"boolean"},"sending_frequency_start":{"type":"integer","nullable":true},"sending_frequency_end":{"type":"integer","nullable":true},"warm_up":{"$ref":"#\/components\/schemas\/WarmUp"},"pools":{"type":"array","items":{"$ref":"#\/components\/schemas\/Pool"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"auth_url":{"description":"If a URL is filled in, you must access it to re-authenticate your account.","type":"string","nullable":true},"final_redirect_url":{"description":"The url to redirect the user when he has finished the process.","type":"string","nullable":true},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1,"nullable":true},"email_signatures_profile":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureShortItem"}],"nullable":true},"api_gmail_id":{"type":"integer","nullable":true},"smtp_username":{"type":"string","example":"me@example.com","nullable":true},"smtp_host":{"type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"type":"integer","example":587,"nullable":true},"smtp_secure":{"type":"string","example":"tls","nullable":true}},"type":"object"}]},"IntegrationsEmailMassMailingItem":{"required":["id","from_sharing","name","email","sender","reply_to","account_type","is_valid","sharing","created_by","pools","permission","validated_url","not_validated_url","created_on","email_signatures_id","email_signatures_profile","last_use","first_use","read_autoresponse","add_sender_as_recipient_in_replies","mailgun_domain","mailgun_region","mailgun_from_email","mailgun_webhook_url","has_mailgun_api_key","has_mailgun_webhook_signing_key"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractIntegrationsEmailItem"},{"properties":{"mailgun_domain":{"description":"Mailgun sending domain","type":"string","example":"mg.example.com","nullable":true},"mailgun_region":{"oneOf":[{"$ref":"#\/components\/schemas\/mailgunRegion"}],"nullable":true,"description":"Mailgun API region","example":"EU"},"mailgun_from_email":{"description":"From email used when sending through Mailgun","type":"string","example":"sales@example.com","nullable":true},"mailgun_webhook_url":{"description":"Public Mailgun webhook URL to configure in Mailgun","type":"string","nullable":true},"has_mailgun_api_key":{"description":"Whether a Mailgun API key is stored","type":"boolean"},"has_mailgun_webhook_signing_key":{"description":"Whether a Mailgun webhook signing key is stored","type":"boolean"},"name":{"type":"string","example":"Email mass mailing name"},"email":{"type":"string","example":"myemail@gmail.com"},"account_type":{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"},"pools":{"type":"array","items":{"$ref":"#\/components\/schemas\/Pool"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"validated_url":{"description":"The url to redirect user when he has validated his email. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/validated\/%id%"},"not_validated_url":{"description":"The url to redirect user when he has failed validation of his email. Must include the placeholder %id% that will be replaced with the integration id","type":"string","example":"https:\/\/example.org\/not-validated\/%id%"},"created_on":{"type":"string","format":"date-time"},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1,"nullable":true},"email_signatures_profile":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureShortItem"}],"nullable":true}},"type":"object"}]},"IntegrationsEmailOutlookItem":{"required":["id","from_sharing","name","email","sender","account_type","enable_tracking","sending_frequency_start","sending_frequency_end","warm_up","sharing","created_by","is_valid","pools","permission","created_on","auth_url","final_redirect_url","email_signatures_id","email_signatures_profile","last_use","first_use","api_outlook_id","reply_to","smtp_username","smtp_host","smtp_port","smtp_secure","custom_tracking_domain","custom_tracking_domain_status","custom_tracking_domain_status_date","read_autoresponse","add_sender_as_recipient_in_replies","mailgun_domain","mailgun_region","mailgun_from_email","mailgun_webhook_url","has_mailgun_api_key","has_mailgun_webhook_signing_key"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractIntegrationsEmailItem"},{"properties":{"name":{"type":"string","example":"Email name"},"email":{"type":"string","example":"me@example.com"},"account_type":{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"},"enable_tracking":{"type":"boolean"},"sending_frequency_start":{"type":"integer","nullable":true},"sending_frequency_end":{"type":"integer","nullable":true},"warm_up":{"$ref":"#\/components\/schemas\/WarmUp"},"pools":{"type":"array","items":{"$ref":"#\/components\/schemas\/Pool"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"auth_url":{"description":"If a URL is filled in, you must access it to re-authenticate your account.","type":"string","nullable":true},"final_redirect_url":{"description":"The url to redirect the user when he has finished the process.","type":"string","nullable":true},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1,"nullable":true},"email_signatures_profile":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureShortItem"}],"nullable":true},"api_outlook_id":{"type":"integer","nullable":true},"smtp_username":{"type":"string","example":"me@example.com","nullable":true},"smtp_host":{"type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"type":"integer","example":587,"nullable":true},"smtp_secure":{"type":"string","example":"tls","nullable":true}},"type":"object"}]},"IntegrationsEmailResultItem":{"required":["id","name","email","sender","reply_to","account_type","is_valid","from_sharing","read_permission","write_permission","delete_permission","created_by","pools","sharing","created_on","auth_url","final_redirect_url","email_signatures_id","email_signatures_profile","last_use","first_use","enable_tracking","can_read_responses","reputation","warmup_settings","custom_tracking_domain","custom_tracking_domain_status","custom_tracking_domain_status_date","smtp_username","smtp_host","smtp_port","smtp_secure","imap_username","imap_host","imap_secure","add_sender_as_recipient_in_replies","read_autoresponse","mailgun_domain","mailgun_region","mailgun_from_email","mailgun_webhook_url","has_mailgun_api_key","has_mailgun_webhook_signing_key"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Email name"},"email":{"type":"string","example":"myemail@gmail.com"},"reply_to":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"sender":{"type":"string","example":"My sender name"},"account_type":{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"},"is_valid":{"type":"boolean"},"from_sharing":{"description":"Whether or not someone is sharing you this email","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this email","type":"integer","example":1,"nullable":true},"pools":{"type":"array","items":{"$ref":"#\/components\/schemas\/Pool"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"auth_url":{"description":"If a URL is filled in, you must access it to re-authenticate your account.","type":"string","nullable":true},"final_redirect_url":{"description":"The url to redirect the user when he has finished the process.","type":"string","nullable":true},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1,"nullable":true},"email_signatures_profile":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureShortItem"}],"nullable":true},"last_use":{"description":"Date of the last use","type":"string","format":"date-time","nullable":true},"first_use":{"description":"Date of the first use","type":"string","format":"date-time","nullable":true},"enable_tracking":{"type":"boolean"},"can_read_responses":{"description":"You can read responses for all account types if tracking is enabled, but for SMTP you also need to have imap configured","type":"boolean"},"reputation":{"description":"The reputation score of the email account, which is a measure of the account's credibility and trustworthiness.","type":"integer","example":100,"nullable":true},"warmup_settings":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmupSettings"}],"nullable":true},"custom_tracking_domain":{"description":"Custom tracking domain. Underscores not allowed","type":"string","example":"http:\/\/tracking.example.org","nullable":true},"custom_tracking_domain_status":{"oneOf":[{"$ref":"#\/components\/schemas\/ingressesDomainStatus"}],"nullable":true},"custom_tracking_domain_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"smtp_username":{"type":"string","example":"me@example.com","nullable":true},"smtp_host":{"type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"type":"integer","example":587,"nullable":true},"smtp_secure":{"type":"string","example":"tls","nullable":true},"imap_username":{"type":"string","nullable":true},"imap_host":{"type":"string","nullable":true},"imap_port":{"type":"integer","nullable":true},"imap_secure":{"type":"string","nullable":true},"add_sender_as_recipient_in_replies":{"type":"boolean"},"read_autoresponse":{"description":"Allow to read autoresponses from your mailbox","type":"boolean","default":false},"mailgun_domain":{"description":"Mailgun sending domain","type":"string","example":"mg.example.com","nullable":true},"mailgun_region":{"oneOf":[{"$ref":"#\/components\/schemas\/mailgunRegion"}],"nullable":true,"description":"Mailgun API region","example":"EU"},"mailgun_from_email":{"description":"From email used when sending through Mailgun","type":"string","example":"sales@example.com","nullable":true},"mailgun_webhook_url":{"description":"Public Mailgun webhook URL to configure in Mailgun","type":"string","nullable":true},"has_mailgun_api_key":{"description":"Whether a Mailgun API key is stored","type":"boolean"},"has_mailgun_webhook_signing_key":{"description":"Whether a Mailgun webhook signing key is stored","type":"boolean"}},"type":"object"},"IntegrationsEmailSmtpItem":{"required":["id","from_sharing","name","email","sender","account_type","smtp_username","smtp_password","smtp_host","smtp_port","smtp_secure","imap_username","imap_password","imap_host","imap_secure","enable_tracking","sending_frequency_start","sending_frequency_end","warm_up","sharing","created_by","is_valid","pools","permission","created_on","email_signatures_id","email_signatures_profile","last_use","first_use","reply_to","reputation","warmup_settings","custom_tracking_domain","custom_tracking_domain_status","custom_tracking_domain_status_date","read_autoresponse","add_sender_as_recipient_in_replies","mailgun_domain","mailgun_region","mailgun_from_email","mailgun_webhook_url","has_mailgun_api_key","has_mailgun_webhook_signing_key"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractIntegrationsEmailItem"},{"properties":{"name":{"type":"string","example":"Email smtp name"},"email":{"type":"string","example":"me@example.com"},"account_type":{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"},"smtp_username":{"type":"string","example":"me@example.com","nullable":true},"smtp_password":{"type":"string","example":"abcdefg","nullable":true},"smtp_host":{"type":"string","example":"smtp.example.com","nullable":true},"smtp_port":{"type":"integer","example":587,"nullable":true},"smtp_secure":{"type":"string","example":"tls","nullable":true},"imap_username":{"type":"string","nullable":true},"imap_password":{"type":"string","nullable":true},"imap_host":{"type":"string","nullable":true},"imap_port":{"type":"integer","nullable":true},"imap_secure":{"type":"string","nullable":true},"enable_tracking":{"type":"boolean"},"sending_frequency_start":{"type":"integer","nullable":true},"sending_frequency_end":{"type":"integer","nullable":true},"warm_up":{"$ref":"#\/components\/schemas\/WarmUp"},"pools":{"type":"array","items":{"$ref":"#\/components\/schemas\/Pool"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"email_signatures_id":{"description":"ID of your email signature","type":"integer","example":1,"nullable":true},"email_signatures_profile":{"oneOf":[{"$ref":"#\/components\/schemas\/EmailSignatureShortItem"}],"nullable":true},"reputation":{"description":"The reputation score of the email account, which is a measure of the account's credibility and trustworthiness.","type":"integer","example":100,"nullable":true},"warmup_settings":{"oneOf":[{"$ref":"#\/components\/schemas\/WarmupSettings"}],"nullable":true}},"type":"object"}]},"IntegrationsEmailSmtpValidityTestResponse":{"required":["accounts_valid","accounts_not_found","accounts_in_error"],"properties":{"accounts_valid":{"description":"Number of accounts validated","type":"integer","example":1},"accounts_not_found":{"description":"Number of accounts not found","type":"integer","example":1},"accounts_in_error":{"description":"Number of accounts in error","type":"integer","example":1}},"type":"object"},"mailgunRegion":{"description":"Mailgun API region","type":"string","enum":["US","EU"]},"Protection":{"required":["id","integration_id","message_id","handled","date_received","from","subject","link"],"properties":{"id":{"type":"integer"},"integration_id":{"type":"integer","nullable":true},"message_id":{"type":"string"},"handled":{"type":"boolean"},"date_received":{"type":"string","format":"date-time"},"from":{"type":"string"},"subject":{"type":"string"},"link":{"type":"string"}},"type":"object"},"WarmUp":{"description":"Warm up your email account during the first 15 days by limiting the number of email sent per day since first use. 0 means no limit.","required":["day_1","day_2","day_3","day_4","day_5","day_6","day_7","day_8","day_9","day_10","day_11","day_12","day_13","day_14","day_15"],"properties":{"day_1":{"type":"integer","example":10,"nullable":true},"day_2":{"type":"integer","example":15,"nullable":true},"day_3":{"type":"integer","example":20,"nullable":true},"day_4":{"type":"integer","example":25,"nullable":true},"day_5":{"type":"integer","example":30,"nullable":true},"day_6":{"type":"integer","example":35,"nullable":true},"day_7":{"type":"integer","example":40,"nullable":true},"day_8":{"type":"integer","example":45,"nullable":true},"day_9":{"type":"integer","example":50,"nullable":true},"day_10":{"type":"integer","example":55,"nullable":true},"day_11":{"type":"integer","example":60,"nullable":true},"day_12":{"type":"integer","example":70,"nullable":true},"day_13":{"type":"integer","example":80,"nullable":true},"day_14":{"type":"integer","example":90,"nullable":true},"day_15":{"description":"Will be applied also to the days after the 15th","type":"integer","example":100,"nullable":true}},"type":"object"},"IntegrationsLinkedinItem":{"description":"Displays the LinkedIn account profile detail","required":["id","name","session_cookie","session_cookie_sn","is_sales_navigator_account","signature","is_valid","from_sharing","sharing","created_by","pools","permission","created_on","last_use","first_use","accept_received_invitations","withdraw_pending_invitations","withdraw_pending_invitations_number","withdraw_pending_invitations_oldest","linkedin_data","user_agent","accept_received_invitations_message","username","checkpoint_required","validity_tested"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"LinkedIn account name"},"session_cookie":{"type":"string","example":"LinkedIn session cookie (li_at)","nullable":true},"session_cookie_sn":{"type":"string","example":"LinkedIn session cookie Sales Navigator (li_a)","nullable":true},"username":{"type":"string","example":"LinkedIn username","nullable":true},"is_sales_navigator_account":{"type":"boolean","example":"Is a Sales Navigator account ?"},"signature":{"type":"string","example":"Your signature"},"max_conversations_messages_extractor":{"type":"integer","example":"Number of LinkedIn conversations to extract (default 100, max 100)"},"accept_received_invitations":{"type":"boolean","example":"Automatically accept LinkedIn invitations"},"accept_received_invitations_message":{"type":"string","example":"Message to be sent when invitations are accepted","nullable":true},"withdraw_pending_invitations":{"type":"boolean","example":"Withdraw LinkedIn invitations weekly"},"withdraw_pending_invitations_number":{"type":"integer","example":"Withdraw how many LinkedIn invites (default 100, max 1000)"},"withdraw_pending_invitations_oldest":{"type":"boolean","example":"Start with the oldest LinkedIn invitations"},"is_valid":{"type":"boolean","example":"Your LinkedIn account is valid ? validity_tested needs to be true also"},"validity_tested":{"type":"boolean","example":"Determine if the validity of the account has been tested online. It is tested when used"},"from_sharing":{"description":"Whether or not someone is sharing you this LinkedIn account","type":"boolean"},"sharing":{"description":"The sharing currently configured for this LinkedIn account. Null if you are not the admin of this LinkedIn account","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this LinkedIn account","type":"integer","example":1,"nullable":true},"pools":{"type":"array","items":{"$ref":"#\/components\/schemas\/Pool"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"linkedin_data":{"$ref":"#\/components\/schemas\/LinkedinData"},"user_agent":{"type":"string"},"last_use":{"description":"Date of the last use","type":"string","format":"date-time","nullable":true},"first_use":{"description":"Date of the first use","type":"string","format":"date-time","nullable":true},"checkpoint_required":{"description":"Tell you if you must solve a checkpoint","type":"boolean"}},"type":"object"},"IntegrationsLinkedinResultItem":{"required":["id","name","session_cookie","is_sales_navigator_account","signature","is_valid","from_sharing","read_permission","write_permission","delete_permission","created_by","pools","sharing","created_on","last_use","first_use","session_cookie_sn","max_conversations_messages_extractor","accept_received_invitations","withdraw_pending_invitations","withdraw_pending_invitations_number","withdraw_pending_invitations_oldest","linkedin_data","user_agent","accept_received_invitations_message","username","checkpoint_required","validity_tested"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"LinkedIn account name"},"session_cookie":{"type":"string","example":"LinkedIn session cookie (li_at)","nullable":true},"session_cookie_sn":{"type":"string","example":"LinkedIn session cookie Sales Navigator (li_a)","nullable":true},"username":{"type":"string","example":"LinkedIn username","nullable":true},"is_sales_navigator_account":{"type":"boolean","example":"Is a Sales Navigator account ?"},"signature":{"type":"string","example":"Your signature"},"max_conversations_messages_extractor":{"type":"integer","example":"Number of LinkedIn conversations to extract (default 100, max 100)"},"accept_received_invitations":{"type":"boolean","example":"Automatically accept LinkedIn invitations"},"accept_received_invitations_message":{"type":"string","example":"Message to be sent when invitations are accepted","nullable":true},"withdraw_pending_invitations":{"type":"boolean","example":"Withdraw LinkedIn invitations weekly"},"withdraw_pending_invitations_number":{"type":"integer","example":"Withdraw how many LinkedIn invites (default 100, max 1000)"},"withdraw_pending_invitations_oldest":{"type":"boolean","example":"Start with the oldest LinkedIn invitations"},"is_valid":{"type":"boolean","example":"Your LinkedIn account is valid ? validity_tested needs to be true also"},"validity_tested":{"type":"boolean","example":"Determine if the validity of the account has been tested online. It is tested when used"},"from_sharing":{"description":"Whether or not someone is sharing you this email","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this email","type":"integer","example":1,"nullable":true},"pools":{"type":"array","items":{"$ref":"#\/components\/schemas\/Pool"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"linkedin_data":{"$ref":"#\/components\/schemas\/LinkedinData"},"user_agent":{"type":"string"},"last_use":{"description":"Date of the last use","type":"string","format":"date-time","nullable":true},"first_use":{"description":"Date of the first use","type":"string","format":"date-time","nullable":true},"checkpoint_required":{"description":"Tell you if you must solve a checkpoint","type":"boolean"}},"type":"object"},"LinkedinData":{"required":["handle","full_name","image_url"],"properties":{"handle":{"type":"string","nullable":true},"full_name":{"type":"string","nullable":true},"image_url":{"type":"string","nullable":true}},"type":"object"},"JobsBlacklistResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","import_contacts_response"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"import_contacts_response":{"oneOf":[{"$ref":"#\/components\/schemas\/ImportBlacklistDataResponse"}],"nullable":true}},"type":"object"}]},"JobsContactListDeleteResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","contacts_deleted"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"contacts_deleted":{"type":"integer","nullable":true}},"type":"object"}]},"JobsContactListResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","import_contacts_response"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"import_contacts_response":{"oneOf":[{"$ref":"#\/components\/schemas\/ImportContactsResponse"}],"nullable":true}},"type":"object"}]},"JobsPRMImportBulkResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","import_contacts_response"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"import_contacts_response":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMImportContactsBulkResponse"}],"nullable":true}},"type":"object"}]},"JobsPRMImportResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","import_contacts_response"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"import_contacts_response":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMImportContactsResponse"}],"nullable":true}},"type":"object"}]},"JobsResult":{"required":["uniqid","target_id","target_type","type","state","queued_date","start_date","end_date","percent","error"],"properties":{"uniqid":{"type":"string"},"target_id":{"type":"integer"},"type":{"$ref":"#\/components\/schemas\/JobType"},"state":{"$ref":"#\/components\/schemas\/State"},"queued_date":{"type":"string","format":"date-time"},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"percent":{"type":"number","format":"float","example":100},"error":{"type":"string","nullable":true},"arguments":{"type":"object","nullable":true}},"type":"object"},"State":{"type":"string","enum":["InProgress","InQueue","Completed","Failed","Cancelled"]},"JobsTargetingResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","contacts_extracted"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"contacts_extracted":{"type":"integer","nullable":true}},"type":"object"}]},"JobType":{"type":"string","enum":["Copy","CopyTo","CopyToBlacklist","CopyToUnsubscribers","Split","Import","ImportPreProcess","Merge","Enrich","EnrichExternalApi","EnrichExternalApiPRM","ConvertLinkedinLinks","IceBreaker","Translate","DatafieldAi","DatafieldEnrich","EnrichLinkedinUrl","EnrichMobilePhone","EnrichLinkedinData","LinkedinExtractPublishersJobOffers","LinkedinExtractPostLikers","LinkedinExtractPostCommenters","LinkedinExtractProfileViewers","LinkedinExtractEventAttendees","LinkedinExtractCompanyViewers","LinkedinExtractGroupMembers","LinkedinExtractPeopleCommentActivity","LinkedinExtractPeoplePostActivity","LinkedinExtractPeopleReactionActivity","LinkedinExtractPostReposters","LinkedinExtractSalesNavigatorPeoplesSearch","LinkedinExtractSalesNavigatorPeoplesSearchAlternative","LinkedinExtractSalesNavigatorCompaniesSearch","LinkedinExtractSalesNavigatorCompaniesSearchAlternative","LinkedinExtractPeoplesSearch","LinkedinExtractPeoplesSearchAlternative","LinkedinExtractConnections","LinkedinExtractSearchContent","GoogleExtractMapsSearch","ContactListCopyContactListToPrm","ZapierSendDataPrm","ZapierSendDataStatistics","DatabaseExtractContacts","CronExecute","DeleteContactsContactListFromBlacklist","DeleteContactsContactListFromUnsubscribers","DeleteContactsContactListFromContactList","OvhAddDomainStep1","OvhAddDomainStep2","OvhAddEmailStep1","OvhAddEmailStep2","OvhAddEmailStep3","OvhAddEmailStep4","OvhSyncAssets","PrmColumnEntryInstant","EnrichBatch","CopyProgrammationToContactList","WorkflowAiAgentGenerate","AiModelStyleProfileAnalyze"]},"JobsUnsubscribersResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","error","import_contacts_response"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"import_contacts_response":{"oneOf":[{"$ref":"#\/components\/schemas\/ImportUnsubscribersDataResponse"}],"nullable":true}},"type":"object"}]},"JobsWorkflowAiAgentGenerateResult":{"required":["uniqid","target_type","type","state","queued_date","start_date","end_date","percent","current_step","error","preview","preview_expires_at"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/JobsResult"},{"properties":{"current_step":{"$ref":"#\/components\/schemas\/WorkflowAiAgentGenerationStep"},"preview":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowAiAgentPreview"}]},"preview_expires_at":{"type":"string","format":"date-time","nullable":true}},"type":"object"}]},"AbstractModelItemOpenApi":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListItem"},{"$ref":"#\/components\/schemas\/FileItem"},{"$ref":"#\/components\/schemas\/ModelsEmailItem"},{"$ref":"#\/components\/schemas\/ModelsLinkedinInvitationItem"},{"$ref":"#\/components\/schemas\/ModelsLinkedinMessageItem"},{"$ref":"#\/components\/schemas\/ModelsSmsItem"},{"$ref":"#\/components\/schemas\/ModelsSmvItem"}]},"ModelType":{"type":"string","enum":["Email","SMV","SMS","LinkedinMessage","LinkedinInvitation"]},"ModelsEmailItem":{"description":"Displays the model profile detail","required":["id","name","subject","text","html","links","json_template","is_template","from_sharing","sharing","created_by","tags","permission","created_on","folder","model_type","is_generated","prompt","is_ai","ai_number_paragraphs","ai_language","ai_temperature","pin"],"properties":{"id":{"type":"integer","example":1},"model_type":{"$ref":"#\/components\/schemas\/ModelType"},"name":{"type":"string","example":"Model name"},"subject":{"type":"string","example":"Email subject","nullable":true},"text":{"type":"string","example":"Text content of your email","nullable":true},"html":{"type":"string","example":"HTML content of your email","nullable":true},"links":{"description":"List of links contained in your HTML","type":"array","items":{"type":"string","example":"https:\/\/example.com\/"},"example":"[]"},"json_template":{"type":"string","example":"[]"},"is_template":{"type":"boolean","example":"Is designed on the template editor ?"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"sharing":{"description":"The sharing currently configured for this model. Null if you are not the admin of this model","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"is_generated":{"type":"boolean","example":"Is the content generated by AI ?"},"prompt":{"type":"string","example":"AI prompt used to generate the model (max 10000 characters)","nullable":true},"is_ai":{"type":"boolean","example":"Is content generated by AI based on contacts ?"},"ai_number_paragraphs":{"description":"How many paragraphs should the AI generate for the content of your email ? (max 4)","type":"integer","example":2,"nullable":true},"ai_language":{"description":"Code of the language in which model email must be written by AI - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"ai_temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0},"pin":{"type":"boolean"}},"type":"object"},"ModelsEmailResultItem":{"required":["id","name","subject","links","is_template","from_sharing","read_permission","write_permission","delete_permission","created_by","tags","sharing","created_on","folder","is_generated","prompt","is_ai","ai_number_paragraphs","ai_language","ai_temperature","pin"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Model name"},"subject":{"type":"string","example":"Email subject","nullable":true},"links":{"description":"List of links contained in your HTML","type":"array","items":{"type":"string","example":"https:\/\/example.com\/"},"example":"[]"},"is_template":{"type":"boolean","example":"Is designed on the template editor ?"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"is_generated":{"type":"boolean","example":"Is the content generated by AI ?"},"prompt":{"type":"string","example":"AI prompt used to generate the model (max 10000 characters)","nullable":true},"is_ai":{"type":"boolean","example":"Is content generated by AI based on contacts ?"},"ai_number_paragraphs":{"description":"How many paragraphs should the AI generate for the content of your email ? (max 4)","type":"integer","example":2,"nullable":true},"ai_language":{"description":"Code of the language in which model email must be written by AI - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"ai_temperature":{"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0},"pin":{"type":"boolean"}},"type":"object"},"ModelsLinkedinInvitationItem":{"description":"Displays the model profile detail","required":["id","name","text","from_sharing","sharing","created_by","tags","permission","created_on","folder","model_type","pin","is_ai"],"properties":{"id":{"type":"integer","example":1},"model_type":{"$ref":"#\/components\/schemas\/ModelType"},"name":{"type":"string","example":"Model name"},"text":{"type":"string","example":"My LinkedIn invitation"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"sharing":{"description":"The sharing currently configured for this model. Null if you are not the admin of this model","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"pin":{"type":"boolean"},"is_ai":{"type":"boolean","example":"Is content generated by AI based on contacts ?"},"prompt":{"type":"string","example":"AI prompt used to generate the model","nullable":true},"ai_language":{"description":"Code of the language in which the model must be written by AI - ISO 639-3 standard","type":"string","example":"FRA","nullable":true},"ai_temperature":{"description":"Controls randomness.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0},"ai_max_characters":{"type":"integer","example":170,"nullable":true}},"type":"object"},"ModelsLinkedinInvitationResultItem":{"required":["id","name","from_sharing","read_permission","write_permission","delete_permission","created_by","tags","sharing","created_on","folder","pin"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Model name"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"pin":{"type":"boolean"}},"type":"object"},"ModelsLinkedinMessageItem":{"description":"Displays the model profile detail","required":["id","name","text","from_sharing","sharing","created_by","tags","permission","created_on","folder","model_type","pin","file_id","is_ai"],"properties":{"id":{"type":"integer","example":1},"model_type":{"$ref":"#\/components\/schemas\/ModelType"},"name":{"type":"string","example":"Model name"},"text":{"type":"string","example":"My LinkedIn message"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"sharing":{"description":"The sharing currently configured for this model. Null if you are not the admin of this model","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"pin":{"type":"boolean"},"file_id":{"type":"integer","nullable":true},"is_ai":{"type":"boolean","example":"Is content generated by AI based on contacts ?"},"prompt":{"type":"string","example":"AI prompt used to generate the model","nullable":true},"ai_number_paragraphs":{"description":"How many paragraphs should the AI generate for the content ?","type":"integer","example":2,"nullable":true},"ai_language":{"description":"Code of the language in which the model must be written by AI - ISO 639-3 standard","type":"string","example":"FRA","nullable":true},"ai_temperature":{"description":"Controls randomness.","type":"number","format":"float","example":1,"nullable":true,"maximum":1,"minimum":0}},"type":"object"},"ModelsLinkedinMessageResultItem":{"required":["id","name","from_sharing","read_permission","write_permission","delete_permission","created_by","tags","sharing","created_on","folder","pin","file_id"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Model name"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"pin":{"type":"boolean"},"file_id":{"type":"integer","nullable":true}},"type":"object"},"ModelsSmsItem":{"description":"Displays the model profile detail","required":["id","name","sender","text","from_sharing","sharing","created_by","tags","permission","created_on","folder","model_type","pin"],"properties":{"id":{"type":"integer","example":1},"model_type":{"$ref":"#\/components\/schemas\/ModelType"},"name":{"type":"string","example":"Model name"},"sender":{"description":"Empty string when the SMS model sends without sender","type":"string","example":"Sender name"},"text":{"type":"string","example":"Content of your SMS"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"sharing":{"description":"The sharing currently configured for this model. Null if you are not the admin of this model","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"pin":{"type":"boolean"}},"type":"object"},"ModelsSmsResultItem":{"required":["id","name","sender","from_sharing","read_permission","write_permission","delete_permission","created_by","tags","sharing","created_on","folder","pin"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Model name"},"sender":{"description":"Empty string when the SMS model sends without sender","type":"string","example":"Sender name"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"pin":{"type":"boolean"}},"type":"object"},"ModelsSmvItem":{"description":"Displays the model profile detail","required":["id","name","duration","voice_file_url","from_sharing","sharing","created_by","tags","permission","created_on","folder","model_type"],"properties":{"id":{"type":"integer","example":1},"model_type":{"$ref":"#\/components\/schemas\/ModelType"},"name":{"type":"string","example":"Model name"},"duration":{"type":"integer","example":"Duration"},"voice_file_url":{"type":"string","example":"Voice file URL"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"sharing":{"description":"The sharing currently configured for this model. Null if you are not the admin of this model","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true}},"type":"object"},"ModelsSmvResultItem":{"required":["id","name","duration","voice_file_url","from_sharing","read_permission","write_permission","delete_permission","created_by","tags","sharing","created_on","folder"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Model name"},"duration":{"type":"integer","example":"Duration"},"voice_file_url":{"type":"string","example":"Voice file URL"},"from_sharing":{"description":"Whether or not someone is sharing you this model","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this model","type":"integer","example":1,"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true}},"type":"object"},"AdminOrganizationProfile":{"description":"Displays the organization profile detail","required":["id","name","organization_code","company_name","created_by","user_email"],"properties":{"id":{"type":"integer","example":1},"name":{"description":"Organization name","type":"string","example":"ExempleOrg"},"organization_code":{"type":"string","example":"abc123"},"company_name":{"description":"Organization legal name","type":"string","example":"ExempleLegal"},"created_by":{"description":"User ID of the organization creator","type":"integer","example":"1","nullable":true},"user_email":{"description":"User email of the organization creator","type":"string","example":"me@domain.ext","nullable":true}},"type":"object"},"OrganizationCreate":{"required":["name"],"properties":{"name":{"description":"Organization name","type":"string","example":"ExempleOrg"},"company_name":{"description":"Organization legal name","type":"string","example":"ExempleLegal"},"address":{"description":"Organization address","type":"string","example":"1 Rue Fictive"},"zip_code":{"description":"Organization zip code","type":"string","example":"75001"},"city":{"description":"Organization city","type":"string","example":"Paris"},"country":{"description":"Organization country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"head_office_address":{"description":"Head office address","type":"string","example":"1 Rue Fictive"},"head_office_zip_code":{"description":"Head office zip code","type":"string","example":"75001"},"head_office_city":{"description":"Head office city","type":"string","example":"Paris"},"head_office_country":{"description":"Head office country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"register_ident":{"description":"Organization register identification (In France, fill in the SIRET)","type":"string","example":"12345678901234"},"vat_number":{"description":"Organization VAT number","type":"string","example":"FR123456789"},"website":{"description":"Organization website","type":"string","example":"https:\/\/www.domaine.fr"},"business_sector":{"description":"Business sector of the organization","type":"string","example":"1234Z"}},"type":"object"},"OrganizationLevel":{"description":"Level of the user","type":"string","enum":["user","admin"]},"OrganizationProfile":{"description":"Displays the organization profile detail (Show only values accessible with your level)","required":["id","name","organization_code","company_name","address","zip_code","city","country","head_office_address","head_office_zip_code","head_office_city","head_office_country","register_ident","vat_number","website","business_sector","number_of_users","user_level","user_role","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"description":"Organization name","type":"string","example":"ExempleOrg"},"organization_code":{"type":"string","example":"abc123"},"company_name":{"description":"Organization legal name","type":"string","example":"ExempleLegal"},"address":{"description":"Organization address","type":"string","example":"1 Rue Fictive"},"zip_code":{"description":"Organization zip code","type":"string","example":"75001"},"city":{"description":"Organization city","type":"string","example":"Paris"},"country":{"description":"Organization country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"head_office_address":{"description":"Head office address","type":"string","example":"1 Rue Fictive"},"head_office_zip_code":{"description":"Head office zip code","type":"string","example":"75001"},"head_office_city":{"description":"Head office city","type":"string","example":"Paris"},"head_office_country":{"description":"Head office country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"register_ident":{"description":"Organization register identification (In France, fill in the SIRET)","type":"string","example":"12345678901234"},"vat_number":{"description":"Organization VAT number","type":"string","example":"FR123456789"},"website":{"description":"Organization website","type":"string","example":"https:\/\/www.domaine.fr"},"business_sector":{"description":"Business sector of the organization","type":"string","example":"1234Z"},"number_of_users":{"type":"integer","example":2},"user_level":{"oneOf":[{"$ref":"#\/components\/schemas\/Level"}],"nullable":true},"user_role":{"oneOf":[{"$ref":"#\/components\/schemas\/RoleUser"}],"nullable":true},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"OrganizationUpdate":{"properties":{"name":{"description":"Organization name","type":"string","example":"ExempleOrg","nullable":true},"company_name":{"description":"Organization legal name","type":"string","example":"ExempleLegal","nullable":true},"address":{"description":"Organization address","type":"string","example":"1 Rue Fictive","nullable":true},"zip_code":{"description":"Organization zip code","type":"string","example":"75001","nullable":true},"city":{"description":"Organization city","type":"string","example":"Paris","nullable":true},"country":{"description":"Organization country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"head_office_address":{"description":"Head office address","type":"string","example":"1 Rue Fictive","nullable":true},"head_office_zip_code":{"description":"Head office zip code","type":"string","example":"75001","nullable":true},"head_office_city":{"description":"Head office city","type":"string","example":"Paris","nullable":true},"head_office_country":{"description":"Head office country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"register_ident":{"description":"Organization register identification (In France, fill in the SIRET)","type":"string","example":"12345678901234","nullable":true},"vat_number":{"description":"Organization VAT number","type":"string","example":"FR123456789","nullable":true},"website":{"description":"Organization website","type":"string","example":"https:\/\/www.domaine.fr","nullable":true},"business_sector":{"description":"Business sector of the organization","type":"string","example":"1234Z","nullable":true}},"type":"object"},"ovhCheckoutEmails":{"required":["prefix","password","display_name"],"properties":{"prefix":{"description":"Email prefix (before the @). For example: \"contact\" will result in contact@domain.tld","type":"string","example":"contact"},"password":{"description":"Password for the email account.","type":"string","example":"P@ssw0rd_123"},"display_name":{"description":"Display name for the email account.","type":"string","example":"Team"},"warmup":{"description":"Whether to activate warmup for the email account.","type":"boolean","example":true}},"type":"object"},"ovhEmailItems":{"required":["id","created_on","state","prefix","display_name"],"properties":{"id":{"type":"integer","example":1},"created_on":{"type":"string","format":"date-time","example":"2025-01-01T00:00:00+00:00"},"state":{"$ref":"#\/components\/schemas\/ovhState"},"prefix":{"type":"string","example":"contact"},"display_name":{"type":"string","example":"Support Team"}},"type":"object"},"ovhResultItems":{"required":["id","domain","created_by","created_on","state","emails"],"properties":{"id":{"type":"integer","example":1},"domain":{"type":"string","example":"example.com"},"created_by":{"type":"integer","example":101},"created_on":{"type":"string","format":"date-time","example":"2025-01-01T00:00:00+00:00"},"state":{"$ref":"#\/components\/schemas\/ovhState"},"emails":{"type":"array","items":{"$ref":"#\/components\/schemas\/ovhEmailItems"}}},"type":"object"},"ovhState":{"type":"string","enum":["InProgress","InQueue","Completed","Failed"]},"ColumnEntryNotificationFrequency":{"type":"string","enum":["instant","daily_digest"]},"AbstractHistoryItem":{"required":["history_type"],"properties":{"date":{"type":"string","format":"date-time"}},"type":"object"},"PRMContactCall":{"required":["id","name","call_date","type","created_by","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My call name"},"call_date":{"type":"string","format":"date-time"},"type":{"$ref":"#\/components\/schemas\/CallType"},"created_by":{"$ref":"#\/components\/schemas\/UserListed"},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"PRMContactCallCreate":{"required":["name","call_date","type"],"properties":{"name":{"type":"string","example":"My call name"},"call_date":{"type":"string","format":"date-time"},"type":{"$ref":"#\/components\/schemas\/CallType"}},"type":"object"},"CallType":{"type":"string","enum":["phone","phone_away","email","visio","meeting","appointment","other"]},"PRMContact":{"required":["id","created_by","created_on","properties","programmations","history","calls","workflow_steps","workflow_waiting_steps","status","custom_status","is_positive","score","amount","probability","closing_date","status_changed_date","permission","person_in_charge","company_has_person_in_charge","excluded_programmations","excluded_workflows","phone_has_person_in_charge","tags","last_reply_date","in_active_programmation","new_reply","new_first_reply"],"properties":{"id":{"type":"integer","example":1},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date-time"},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}},"programmations":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProgrammation"}},"history":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/HistoryItemNote"},{"$ref":"#\/components\/schemas\/HistoryItemEvent"},{"$ref":"#\/components\/schemas\/HistoryItemReply"},{"$ref":"#\/components\/schemas\/HistoryItemSent"}]}},"calls":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactCall"}},"workflow_steps":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowStepsProgrammation"}},"workflow_waiting_steps":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowStepsProgrammationWithChilds"}},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true},"custom_status":{"type":"integer","example":1,"nullable":true},"is_positive":{"description":"True if the contact is marked as positive. Null to remove the mark","type":"boolean","nullable":true},"score":{"type":"integer"},"amount":{"type":"integer","nullable":true},"probability":{"type":"integer","nullable":true},"closing_date":{"type":"string","format":"date","nullable":true},"status_changed_date":{"type":"string","format":"date"},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"person_in_charge":{"oneOf":[{"$ref":"#\/components\/schemas\/UserListed"}],"nullable":true},"company_has_person_in_charge":{"type":"boolean"},"phone_has_person_in_charge":{"type":"boolean"},"excluded_programmations":{"type":"array","items":{"type":"integer"}},"excluded_workflows":{"type":"array","items":{"type":"integer"}},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"last_reply_date":{"type":"string","format":"date-time","nullable":true},"in_active_programmation":{"type":"boolean"},"new_reply":{"type":"boolean"},"new_first_reply":{"type":"boolean"}},"type":"object"},"PRMContactImport":{"description":"Contact to import or update in PRM","required":["properties","status"],"properties":{"id":{"description":"Put an id to update a specific contact or null to create a new contact","type":"integer","example":1,"nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}}},"type":"object"},"PRMContactListItem":{"required":["id","created_by","created_on","properties","programmations","calls","status","custom_status","is_positive","score","amount","probability","closing_date","permission","status_changed_date","workflow_waiting_steps","number_of_replies","person_in_charge","last_reply_link","last_reply_id","last_reply_type","last_reply_date","in_active_programmation","new_reply","new_first_reply"],"properties":{"id":{"type":"integer","example":1},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date-time"},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}},"programmations":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProgrammation"}},"calls":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactCall"}},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true},"custom_status":{"type":"integer","example":1,"nullable":true},"is_positive":{"description":"If the contact is marked as positive. Null to remove the mark","type":"boolean","nullable":true},"score":{"type":"integer"},"amount":{"type":"integer","nullable":true},"probability":{"description":"True if the contact is marked as positive. Null to remove the mark","type":"integer","nullable":true},"closing_date":{"type":"string","format":"date","nullable":true},"status_changed_date":{"type":"string","format":"date"},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"workflow_waiting_steps":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowStepsProgrammationWithChilds"}},"number_of_replies":{"type":"integer"},"person_in_charge":{"oneOf":[{"$ref":"#\/components\/schemas\/UserListed"}],"nullable":true},"last_reply_link":{"type":"string","nullable":true},"last_reply_id":{"type":"integer","nullable":true},"last_reply_type":{"oneOf":[{"$ref":"#\/components\/schemas\/HistoryTypeReply"}],"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"last_reply_date":{"type":"string","format":"date-time","nullable":true},"in_active_programmation":{"type":"boolean"},"new_reply":{"type":"boolean"},"new_first_reply":{"type":"boolean"}},"type":"object"},"PRMContactUpdate":{"properties":{"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"},"nullable":true},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true},"custom_status":{"type":"integer","nullable":true},"is_positive":{"type":"boolean","nullable":true},"amount":{"type":"integer","nullable":true},"probability":{"type":"integer","nullable":true},"closing_date":{"type":"string","format":"date-time","nullable":true},"person_in_charge":{"type":"integer","nullable":true},"tags_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"new_reply":{"type":"boolean","nullable":true},"new_first_reply":{"type":"boolean","nullable":true}},"type":"object"},"PRMContactCustomStatus":{"required":["id","name","visible","color","sorting","default_status"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My custom status"},"visible":{"type":"boolean"},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","nullable":true},"sorting":{"type":"integer"},"type_default_status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMTypeDefaultCustomStatus"}],"nullable":true}},"type":"object"},"HistoryItemAttachment":{"required":["id","date","history_type","workflow_step_id","workflow_programmation_id","message","type","from","integration_id","attachments"],"properties":{"type":{"type":"string"},"name":{"type":"string","nullable":true},"download_url":{"type":"string","nullable":true},"size":{"type":"integer","nullable":true},"duration":{"type":"integer","nullable":true}},"type":"object"},"HistoryItemEvent":{"required":["date","event","workflow_step_id","workflow_programmation_id","additional_data","reference_event_id","integration_id"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractHistoryItem"},{"properties":{"date":{"type":"string","format":"date-time"},"event":{"$ref":"#\/components\/schemas\/EventType"},"workflow_step_id":{"type":"integer","nullable":true},"workflow_programmation_id":{"type":"integer","nullable":true},"additional_data":{"type":"string","nullable":true},"reference_event_id":{"type":"integer","nullable":true},"integration_id":{"type":"integer","nullable":true},"history_type":{"type":"string","enum":["event"]}},"type":"object"}]},"HistoryItemNote":{"required":["id","date","history_type","note","created_by","attachments"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractHistoryItem"},{"properties":{"id":{"type":"integer","example":1},"date":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time","nullable":true},"note":{"type":"string"},"created_by":{"oneOf":[{"$ref":"#\/components\/schemas\/UserListed"}],"nullable":true},"updated_by":{"type":"integer","nullable":true},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/NoteAttachment"}},"history_type":{"type":"string","enum":["note"]}},"type":"object"}]},"HistoryItemReply":{"required":["id","date","history_type","workflow_step_id","workflow_programmation_id","reply","type","direct_link","is_positive_reply","reply_to","from","reference_event_id","is_auto_submitted","attachments"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractHistoryItem"},{"properties":{"id":{"type":"integer"},"date":{"type":"string","format":"date-time"},"workflow_step_id":{"type":"integer","nullable":true},"workflow_programmation_id":{"type":"integer","nullable":true},"reply":{"type":"string"},"type":{"$ref":"#\/components\/schemas\/HistoryTypeReply"},"direct_link":{"type":"string","nullable":true},"is_positive_reply":{"type":"boolean","nullable":true},"reply_to":{"$ref":"#\/components\/schemas\/ReplyTo"},"from":{"type":"string","nullable":true},"reference_event_id":{"type":"integer","nullable":true},"is_auto_submitted":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/HistoryItemAttachment"}},"history_type":{"type":"string","enum":["reply"]}},"type":"object"}]},"ReplyTo":{"required":["model_id","subject","signature_id","integration_id"],"properties":{"model_id":{"type":"integer","nullable":true},"subject":{"type":"string","nullable":true},"signature_id":{"type":"integer","nullable":true},"integration_id":{"type":"integer","nullable":true}},"type":"object"},"HistoryItemSent":{"required":["id","date","history_type","workflow_step_id","workflow_programmation_id","message","type","from","integration_id","attachments"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AbstractHistoryItem"},{"properties":{"id":{"type":"integer"},"date":{"type":"string","format":"date-time"},"workflow_step_id":{"type":"integer","nullable":true},"workflow_programmation_id":{"type":"integer","nullable":true},"message":{"type":"string"},"type":{"$ref":"#\/components\/schemas\/HistoryTypeReply"},"from":{"type":"string","nullable":true},"integration_id":{"type":"integer","nullable":true},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/HistoryItemAttachment"}},"history_type":{"type":"string","enum":["sent"]}},"type":"object"}]},"HistoryType":{"type":"string","enum":["event","note","reply","added_from_programmation","sent"]},"HistoryTypeReply":{"type":"string","enum":["email","linkedin","sms"]},"NoteAttachment":{"required":["id","filename","file_size","mime_type","created_on","download_url"],"properties":{"id":{"type":"integer","example":1},"filename":{"type":"string","example":"document.pdf"},"file_size":{"type":"integer","example":1024},"mime_type":{"type":"string","example":"application\/pdf"},"created_on":{"type":"string","format":"date-time"},"download_url":{"type":"string","format":"uri"}},"type":"object"},"PRMContactProgrammation":{"required":["programmation_id","contact_lists","workflow_id","workflow_name","status","contact_list_contact_id","contact_list_id","programmation_contact_id","date_start","unsubscribed","blacklisted","excluded_workflow","excluded_programmation","excluded_previous_programmation","score","score_link_click_count","score_open_count","score_answer_count","score_positive_answer_count","score_negative_answer_count","score_invitation_accepted_count","properties"],"properties":{"programmation_contact_id":{"type":"integer"},"programmation_id":{"type":"integer","nullable":true},"contact_lists":{"type":"array","items":{"$ref":"#\/components\/schemas\/ContactListInfo"}},"workflow_id":{"type":"integer","example":1,"nullable":true},"workflow_name":{"type":"string","example":"My workflow","nullable":true},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true},"date_start":{"type":"string","format":"date-time","nullable":true},"contact_list_contact_id":{"description":"Id of the contact in the contact list","type":"integer","nullable":true},"contact_list_id":{"description":"Id of the contact list","type":"integer","nullable":true},"unsubscribed":{"type":"boolean"},"blacklisted":{"type":"boolean"},"excluded_workflow":{"type":"boolean"},"excluded_programmation":{"type":"boolean"},"excluded_previous_programmation":{"type":"boolean"},"score":{"type":"integer"},"score_link_click_count":{"type":"number","format":"float"},"score_open_count":{"type":"integer"},"score_answer_count":{"type":"integer"},"score_positive_answer_count":{"type":"integer"},"score_negative_answer_count":{"type":"integer"},"score_invitation_accepted_count":{"type":"integer"},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}}},"type":"object"},"PRMContactProperty":{"required":["data_field_id","value"],"properties":{"data_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"myemail@example.com"}},"type":"object"},"PRMContactStatus":{"type":"string","enum":["out_of_office","opener","clicker","answerer","to_call"]},"PRMTypeDefaultCustomStatus":{"type":"string","enum":["answerer_positive","answerer_negative"]},"WorkflowStep":{"required":["id","name","date_occured"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","nullable":true},"date_occured":{"type":"string","format":"date-time"}},"type":"object"},"WorkflowStepWithChilds":{"required":["id","name","date_occured","childs"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","nullable":true},"date_occured":{"type":"string","format":"date-time"},"childs":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowStep"}}},"type":"object"},"WorkflowStepsProgrammation":{"required":["programmation_id","programmation_contact_id","steps"],"properties":{"programmation_id":{"type":"integer","example":1,"nullable":true},"programmation_contact_id":{"type":"integer","example":1},"steps":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowStep"}}},"type":"object"},"WorkflowStepsProgrammationWithChilds":{"required":["programmation_id","programmation_contact_id","steps"],"properties":{"programmation_id":{"type":"integer","example":1},"programmation_contact_id":{"type":"integer","example":1},"steps":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowStepWithChilds"}}},"type":"object"},"prm.ContactsSelection":{"required":["filter","contact_ids","excluded_contact_ids"],"properties":{"filter":{"$ref":"#\/components\/schemas\/Filter"},"contact_ids":{"type":"array","items":{"type":"integer"}},"excluded_contact_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"},"CustomStatusCreate":{"required":["name"],"properties":{"name":{"type":"string","example":"My custom status"},"visible":{"type":"boolean","nullable":true,"default":true},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true,"default":null},"sorting":{"type":"integer","nullable":true,"default":0}},"type":"object"},"CustomStatusUpdate":{"properties":{"name":{"type":"string","example":"My custom status","nullable":true,"default":null},"visible":{"type":"boolean","nullable":true,"default":null},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true,"default":null},"sorting":{"type":"integer","nullable":true,"default":null}},"type":"object"},"PRMImportContactsBulkResponse":{"required":["contacts_added","contacts_updated","contacts_ignored","contacts_with_ignored_fields"],"properties":{"contacts_added":{"description":"Number of contacts added","type":"integer","example":1},"contacts_updated":{"description":"Number of contacts updated","type":"integer","example":1},"contacts_ignored":{"description":"If ignore_errors is true, this is the number of contacts ignored because all of their data is invalid","type":"integer","example":1},"contacts_with_ignored_fields":{"description":"If ignore_errors is true, this is the number of contacts that contains at least one ignored field","type":"integer","example":1}},"type":"object"},"PRMImportContactsResponse":{"required":["contacts_added","contacts_already_existing"],"properties":{"contacts_added":{"description":"Number of contacts added","type":"integer","example":1},"contacts_already_existing":{"description":"Number of contacts not added because they already exist","type":"integer","example":1}},"type":"object"},"NurturingCreate":{"required":["name","filter","contact_list_ids"],"properties":{"name":{"type":"string","example":"My nurturing"},"filter":{"$ref":"#\/components\/schemas\/Filter"},"contact_list_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"},"NurturingItem":{"required":["id","name","filter","contact_list_ids","created_on"],"properties":{"id":{"type":"integer"},"name":{"type":"string","example":"My nurturing"},"filter":{"$ref":"#\/components\/schemas\/Filter"},"contact_list_ids":{"type":"array","items":{"type":"integer"}},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"NurturingResultItem":{"required":["id","name","filter","contact_list_ids","created_on"],"properties":{"id":{"type":"integer"},"name":{"type":"string","example":"My nurturing"},"filter":{"$ref":"#\/components\/schemas\/Filter"},"contact_list_ids":{"type":"array","items":{"type":"integer"}},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"NurturingUpdate":{"properties":{"name":{"type":"string","example":"My nurturing","nullable":true},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true},"contact_list_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"},"PRMListed":{"required":["id","first_name","last_name","datafields","status","custom_status","date_view","new_answerers_since_date_view","new_reply","new_first_reply"],"properties":{"id":{"type":"integer","example":1},"first_name":{"type":"string","example":"Jean"},"last_name":{"type":"string","example":"Moulin"},"datafields":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataFieldResultItem"}},"status":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMStatusVisibility"}},"custom_status":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactCustomStatus"}},"date_view":{"type":"string","format":"date-time","nullable":true},"new_answerers_since_date_view":{"type":"integer"},"new_reply":{"type":"integer"},"new_first_reply":{"type":"integer"}},"type":"object"},"PRMPaginationOptions":{"required":["mode","values"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/PaginationOptions"},{"properties":{"conditions":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharedContactsCondition"}}},"type":"object"}]},"SharedContactsCondition":{"required":["sharing_type_to","ids_list"],"properties":{"sharing_type_to":{"$ref":"#\/components\/schemas\/SharingTypeTo"},"ids_list":{"description":"The list of ids that we have shared to","type":"array","items":{"type":"integer"},"example":[1,2]}},"type":"object"},"SharingContact":{"required":["sharing_type_to","read_permission","write_permission","delete_permission","ids_list","name","contact_ids"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Sharing"},{"properties":{"contact_ids":{"description":"The ids of your prm contacts to share","type":"array","items":{"type":"integer"}}},"type":"object"}]},"SharingContactResponse":{"required":["id","sharing_type","sharing_type_to","read_permission","write_permission","delete_permission","sharing_targets","name","filter"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SharingResponse"},{"properties":{"id":{"type":"integer"},"contact_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}]},"SharingFilter":{"required":["sharing_type_to","read_permission","write_permission","delete_permission","ids_list","name","filter"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Sharing"},{"properties":{"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true}},"type":"object"}]},"SharingFilterResponse":{"required":["id","sharing_type","sharing_type_to","read_permission","write_permission","delete_permission","sharing_targets","name","filter"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SharingResponse"},{"properties":{"id":{"type":"integer"},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true}},"type":"object"}]},"PRMStatusVisibility":{"required":["status","visible","color","sorting"],"properties":{"status":{"$ref":"#\/components\/schemas\/PRMContactStatus"},"visible":{"type":"boolean"},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","nullable":true},"sorting":{"type":"integer"}},"type":"object"},"StatusVisibilityUpdate":{"properties":{"visible":{"type":"boolean","nullable":true,"default":null},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true,"default":null},"sorting":{"type":"integer","nullable":true,"default":null}},"type":"object"},"AdditionalPermissions":{"required":["name","value"],"properties":{"name":{"$ref":"#\/components\/schemas\/PermissionNames"},"value":{"example":true}},"type":"object"},"DefaultPermissionsItem":{"required":["name","value","value_subscriber","value_reseller_user","value_trial","value_type"],"properties":{"name":{"$ref":"#\/components\/schemas\/PermissionNames"},"value":{"example":true},"value_subscriber":{"example":true},"value_trial":{"example":true},"value_reseller_user":{"example":true,"nullable":true},"value_type":{"description":"Value must be boolean or integer","type":"string","example":"bool"},"change_on_subscription_change":{"type":"boolean"}},"type":"object"},"PermissionItem":{"required":["name","value","default_value","value_type","is_editable","remaining","used"],"properties":{"name":{"$ref":"#\/components\/schemas\/PermissionNames"},"value":{"example":true},"default_value":{"example":true},"value_type":{"description":"Value must be boolean or integer","type":"string","example":"bool"},"is_editable":{"type":"boolean","example":true},"remaining":{"description":"Depending on the type of authorization, this will display the remaining number of authorized quota.","type":"integer","example":5,"nullable":true},"used":{"type":"integer","example":5,"nullable":true}},"type":"object"},"PermissionNames":{"type":"string","enum":["accessCampaigns","accessContactLists","accessModels","accessPRM","accessReporting","accessTargeting","accessTargetingDatabase","accessWorkflows","accessSearchAI","aiPerplexity","copyContactListToPRM","copyInternalContactListToPRM","createModelsLinkedinInvitation","createModelsLinkedinMessage","createModelsSms","displayAddIntegrationsEmailMassMailing","displayDetailedStatistics","displayEnrichExternalUsageStatistics","displayContactListExport","displayEmailsPhones","displayInternalEmailsPhones","displayPricing","displayResellers","displaySideMenu","displayTargeting","displayTargetingDatabase","displayTargetingGoogle","displayTargetingLinkedin","displayPRMManager","displayForms","displayWebhookStatistics","displayPRMResponsibleOnlySelf","findGoogleMapsPhone","findMobilePhone","generateEmail","generateIceBreaker","generateDatafieldAi","suggestedAnswerAi","iceBreakerV35","iceBreakerV40","integrationsEmailForceValidate","integrationsEmailSendingFrequency","linkedinConnectionsExtractorAtWeekends","linkedinConversationsExtractorAtWeekends","maxEmailsGeneratedPerMonth","maxMobilePhonesGeneratedPerMonth","maxEmailsSentPerDay","maxIceBreakerPerMonth","maxDatafieldAiPerMonth","maxIntegrationsEmailMassMailing","maxIntegrationsEmailSMTP","maxIntegrationsLinkedin","maxLinkedinConnectionsExtractor","maxLinkedinConversationsExtractor","maxLinkedinInteractionsPerDay","maxLinkedinInteractionsPerMonth","maxResellers","maxSmvSentPerDay","maxSmsSentPerDay","maxSmsSentPerMonth","maxTestEmailSentPerDay","modelGenerator","priorityCampaign","allowSpamhausMassMailing","resendToBounce","sharingIntegrationsEmail","sharingIntegrationsLinkedin","subscribeUser","personalizeTransactionalEmails","switchOrganizationUser","switchTeamUser","verifEmail","answsersAIMarkPositive","serperFrance","useAlternativeTargeting","emailWarmup","uploadImageFiles","uploadDocumentFiles","exportPRM","resellerSetDefaultUserPermissions"]},"UpdatePermissions":{"required":["name","value"],"properties":{"name":{"$ref":"#\/components\/schemas\/PermissionNames"},"value":{"description":"Permission value","example":true,"oneOf":[{"description":"Permission value as integer","type":"integer","example":5,"nullable":false},{"description":"Permission value as boolean","type":"boolean","example":true,"nullable":false}]}},"type":"object"},"Pool":{"required":["id","name","type"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My pool"},"type":{"$ref":"#\/components\/schemas\/poolsPoolType"}},"type":"object"},"PoolItem":{"required":["id","name","type","from_sharing","sharing","created_by","number_of_accounts","accounts_list","permission","created_on","internal_rotation_number","auto_remove_enabled","reputation_threshold"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My pool"},"type":{"$ref":"#\/components\/schemas\/poolsPoolType"},"from_sharing":{"description":"Whether or not someone is sharing you this pool","type":"boolean"},"sharing":{"description":"The sharing currently configured for this pool. Null if you are not the admin of this pool","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this pool","type":"integer","example":1,"nullable":true},"number_of_accounts":{"type":"integer"},"accounts_list":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmailResultItem"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedinResultItem"}]}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"internal_rotation_number":{"type":"integer"},"auto_remove_enabled":{"description":"Is the auto-remove feature enabled?","type":"boolean"},"reputation_threshold":{"description":"Reputation score threshold for auto-removal","type":"integer","example":50,"nullable":true}},"type":"object"},"PoolResultItem":{"required":["id","name","type","from_sharing","read_permission","write_permission","delete_permission","created_by","number_of_accounts","accounts_list","sharing","created_on","auto_remove_enabled","reputation_threshold"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My pool"},"type":{"$ref":"#\/components\/schemas\/poolsPoolType"},"from_sharing":{"description":"Whether or not someone is sharing you this pool","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this pool","type":"integer","example":1,"nullable":true},"number_of_accounts":{"type":"integer"},"accounts_list":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmailResultItem"},{"$ref":"#\/components\/schemas\/IntegrationsLinkedinResultItem"}]}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"auto_remove_enabled":{"type":"boolean"},"reputation_threshold":{"type":"integer","nullable":true}},"type":"object"},"poolsPoolType":{"description":"PoolType","type":"string","enum":["Email","Linkedin"]},"ReportingChartType":{"type":"string","enum":["bars","lines"]},"ReportCreate":{"required":["name","chart_type","programmation_ids","x_axis","y_axis"],"properties":{"name":{"type":"string","example":"My report"},"chart_type":{"$ref":"#\/components\/schemas\/ReportingChartType"},"programmation_ids":{"type":"array","items":{"type":"integer"}},"size":{"$ref":"#\/components\/schemas\/Size"},"x_axis":{"$ref":"#\/components\/schemas\/ReportingXAxis"},"y_axis":{"$ref":"#\/components\/schemas\/ReportingYAxis"},"sharing":{"description":"The sharing currently configured for this report.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pinned":{"type":"boolean","nullable":true},"hidden":{"type":"boolean","nullable":true}},"type":"object"},"ReportingReportItem":{"required":["id","name","chart_type","programmation_ids","size","x_axis","y_axis","sharing","created_on","pinned","hidden"],"properties":{"id":{"type":"integer"},"name":{"type":"string","example":"My report"},"chart_type":{"$ref":"#\/components\/schemas\/ReportingChartType"},"programmation_ids":{"type":"array","items":{"type":"integer"}},"size":{"$ref":"#\/components\/schemas\/Size"},"x_axis":{"$ref":"#\/components\/schemas\/ReportingXAxis"},"y_axis":{"$ref":"#\/components\/schemas\/ReportingYAxis"},"sharing":{"description":"The sharing currently configured for this report.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"pinned":{"type":"boolean"},"hidden":{"type":"boolean"}},"type":"object"},"ReportingReportResultItem":{"required":["id","name","chart_type","programmation_ids","size","x_axis","y_axis","sharing","created_on","pinned","hidden"],"properties":{"id":{"type":"integer"},"name":{"type":"string","example":"My report"},"chart_type":{"$ref":"#\/components\/schemas\/ReportingChartType"},"programmation_ids":{"type":"array","items":{"type":"integer"}},"size":{"$ref":"#\/components\/schemas\/Size"},"x_axis":{"$ref":"#\/components\/schemas\/ReportingXAxis"},"y_axis":{"$ref":"#\/components\/schemas\/ReportingYAxis"},"sharing":{"description":"The sharing currently configured for this report.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"pinned":{"type":"boolean"},"hidden":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this report","type":"integer","example":1,"nullable":true}},"type":"object"},"ReportUpdate":{"properties":{"name":{"type":"string","example":"My report","nullable":true},"chart_type":{"oneOf":[{"$ref":"#\/components\/schemas\/ReportingChartType"}],"nullable":true},"programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"size":{"oneOf":[{"$ref":"#\/components\/schemas\/Size"}],"nullable":true},"x_axis":{"oneOf":[{"$ref":"#\/components\/schemas\/ReportingXAxis"}],"nullable":true},"y_axis":{"oneOf":[{"$ref":"#\/components\/schemas\/ReportingYAxis"}],"nullable":true},"sharing":{"description":"The sharing currently configured for this report.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pinned":{"type":"boolean","nullable":true},"hidden":{"type":"boolean","nullable":true}},"type":"object"},"Size":{"required":["x","y","width","height"],"properties":{"x":{"type":"integer"},"y":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"}},"type":"object"},"ReportingXAxis":{"type":"string","enum":["steps","programmations"]},"ReportingYAxis":{"type":"string","enum":["contacted","to_contact","in_queue","opener","clicker","answerer","sent_today","bounced","unsubscriber","blacklisted","excluded_previous_programmation","excluded_workflow"]},"AdminDomainInfo":{"required":["reseller_id","domain","type","status","status_date","number_of_users","number_of_users_activated"],"properties":{"reseller_id":{"type":"integer","example":1},"name":{"type":"string","example":"My reseller"},"domain":{"type":"string","example":"saas.domain.ext"},"type":{"$ref":"#\/components\/schemas\/resellersDomainType"},"status":{"$ref":"#\/components\/schemas\/resellersDomainStatus"},"status_date":{"type":"string","format":"date-time"},"number_of_users":{"type":"integer","example":2},"number_of_users_activated":{"type":"integer","example":1}},"type":"object"},"CnamesResultItem":{"required":["domain"],"properties":{"domain":{"type":"string","example":"domain.ext"}},"type":"object"},"resellersDomainStatus":{"description":"DomainStatus","type":"string","enum":["new","waiting_dns","active","dns_failure","invalid"]},"resellersDomainType":{"description":"DomainType","type":"string","enum":["saas","saas2","saas3","api","files","redirect"]},"resellersNotificationType":{"description":"Notification type","type":"string","enum":["Linkedin","Email","Global"]},"ResellerOptionSubscriptionFreeTrial":{"required":["name","active"],"properties":{"name":{"type":"string","enum":["SubscriptionFreeTrial"]},"active":{"type":"boolean"},"variables":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerOptionEmptyVariables"}],"nullable":true}},"type":"object","additionalProperties":false},"ResellerOptionChatwoot":{"required":["name","active","variables"],"properties":{"name":{"type":"string","enum":["Chatwoot"]},"active":{"type":"boolean"},"variables":{"$ref":"#\/components\/schemas\/ResellerOptionChatwootVariables"}},"type":"object","additionalProperties":false},"ResellerOptionSmsVerificationOnRegister":{"required":["name","active","variables"],"properties":{"name":{"type":"string","enum":["SmsVerificationOnRegister"]},"active":{"type":"boolean"},"variables":{"$ref":"#\/components\/schemas\/ResellerOptionSmsVerificationOnRegisterVariables"}},"type":"object","additionalProperties":false},"ResellerOptionShowSmtpConnectionGmail":{"required":["name","active","variables"],"properties":{"name":{"type":"string","enum":["ShowSmtpConnectionGmail"]},"active":{"type":"boolean"},"variables":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerOptionEmptyVariables"}],"nullable":true}},"type":"object","additionalProperties":false},"ResellerOptionShowSmtpConnectionOutlook":{"required":["name","active","variables"],"properties":{"name":{"type":"string","enum":["ShowSmtpConnectionOutlook"]},"active":{"type":"boolean"},"variables":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerOptionEmptyVariables"}],"nullable":true}},"type":"object","additionalProperties":false},"ResellerOptionShowRegisterConnectionGmail":{"required":["name","active","variables"],"properties":{"name":{"type":"string","enum":["ShowRegisterConnectionGmail"]},"active":{"type":"boolean"},"variables":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerOptionEmptyVariables"}],"nullable":true}},"type":"object","additionalProperties":false},"ResellerOptionShowRegisterConnectionOutlook":{"required":["name","active","variables"],"properties":{"name":{"type":"string","enum":["ShowRegisterConnectionOutlook"]},"active":{"type":"boolean"},"variables":{"oneOf":[{"$ref":"#\/components\/schemas\/ResellerOptionEmptyVariables"}],"nullable":true}},"type":"object","additionalProperties":false},"ResellerOptionNewUserPermissions":{"required":["name","active","variables"],"properties":{"name":{"type":"string","enum":["NewUserPermissions"]},"active":{"type":"boolean"},"variables":{"$ref":"#\/components\/schemas\/ResellerOptionNewUserPermissionsVariables"}},"type":"object","additionalProperties":false},"ResellerOption":{"discriminator":{"propertyName":"name","mapping":{"SubscriptionFreeTrial":"#\/components\/schemas\/ResellerOptionSubscriptionFreeTrial","Chatwoot":"#\/components\/schemas\/ResellerOptionChatwoot","SmsVerificationOnRegister":"#\/components\/schemas\/ResellerOptionSmsVerificationOnRegister","ShowSmtpConnectionGmail":"#\/components\/schemas\/ResellerOptionShowSmtpConnectionGmail","ShowSmtpConnectionOutlook":"#\/components\/schemas\/ResellerOptionShowSmtpConnectionOutlook","ShowRegisterConnectionGmail":"#\/components\/schemas\/ResellerOptionShowRegisterConnectionGmail","ShowRegisterConnectionOutlook":"#\/components\/schemas\/ResellerOptionShowRegisterConnectionOutlook","NewUserPermissions":"#\/components\/schemas\/ResellerOptionNewUserPermissions"}},"oneOf":[{"$ref":"#\/components\/schemas\/ResellerOptionSubscriptionFreeTrial"},{"$ref":"#\/components\/schemas\/ResellerOptionChatwoot"},{"$ref":"#\/components\/schemas\/ResellerOptionSmsVerificationOnRegister"},{"$ref":"#\/components\/schemas\/ResellerOptionShowSmtpConnectionGmail"},{"$ref":"#\/components\/schemas\/ResellerOptionShowSmtpConnectionOutlook"},{"$ref":"#\/components\/schemas\/ResellerOptionShowRegisterConnectionGmail"},{"$ref":"#\/components\/schemas\/ResellerOptionShowRegisterConnectionOutlook"},{"$ref":"#\/components\/schemas\/ResellerOptionNewUserPermissions"}]},"ResellerOptionChatwootVariables":{"required":["BASE_URL","WEBSITE_TOKEN"],"properties":{"BASE_URL":{"type":"string","example":"https:\/\/app.chatwoot.com"},"WEBSITE_TOKEN":{"type":"string","example":""}},"type":"object","additionalProperties":false},"ResellerOptionEmptyVariables":{"type":"object","additionalProperties":false},"ResellerOptionNewUserPermissionsVariables":{"required":["maxIntegrationsEmailSMTP","maxIntegrationsLinkedin","maxEmailsGeneratedPerMonth"],"properties":{"maxIntegrationsEmailSMTP":{"type":"integer","example":1,"nullable":true},"maxIntegrationsLinkedin":{"type":"integer","example":0,"nullable":true},"maxEmailsGeneratedPerMonth":{"type":"integer","example":100,"nullable":true}},"type":"object","additionalProperties":false},"ResellerOptionSmsVerificationOnRegisterVariables":{"required":["SENDER"],"properties":{"SENDER":{"description":"Sender name. Empty string sends without sender.<br>When provided:<br>\u2022 Between 4 and 11 characters.<br>\u2022 Numbers between 0 and 9.<br>\u2022 Only numbers\/letters without accent.<br>\u2022 No special characters.<br>\u2022 Not only numbers.","type":"string","example":"ABC"}},"type":"object","additionalProperties":false},"PRMDefaultCustomStatus":{"required":["name"],"properties":{"name":{"description":"Status label","type":"string","example":"Lead"},"color":{"description":"Hexadecimal color code (optional)","type":"string","example":"FF6600","nullable":true}},"type":"object"},"ResellerCreate":{"required":["name"],"properties":{"name":{"description":"Reseller name. It will be displayed publicly","type":"string","example":"My reseller"},"domain_saas":{"description":"SAAS access domain name (Use visual 1 on the frontend). Underscores not allowed","type":"string","example":"http:\/\/saas.example.org","nullable":true},"domain_saas2":{"description":"SAAS 2 access domain name (Use visual 2 on the frontend). Underscores not allowed","type":"string","example":"http:\/\/saas2.example.org","nullable":true},"domain_saas3":{"description":"SAAS 3 access domain name (Use visual 3 on the frontend). Underscores not allowed","type":"string","example":"http:\/\/saas3.example.org","nullable":true},"domain_files":{"description":"Files access domain name. Underscores not allowed","type":"string","example":"http:\/\/files.example.org","nullable":true},"domain_redirect":{"description":"Redirect access domain name. Underscores not allowed","type":"string","example":"http:\/\/redirect.example.org","nullable":true},"domain_api":{"description":"API access domain name. Underscores not allowed","type":"string","example":"http:\/\/api.example.org","nullable":true},"emails_notification_linkedin":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_email":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_global":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"integration_id":{"description":"Use your email to send transactional emails (SMTP account only and must belong to you)","type":"string","example":"1","nullable":true},"logo":{"description":"Logo in SVG\/JPG\/PNG format (any size) (Maximum file size is 2mb)","type":"string","format":"binary","nullable":true},"logo_menu":{"description":"Logo in SVG\/JPG\/PNG format (any size) (Maximum file size is 2mb)","type":"string","format":"binary","nullable":true},"favicon":{"description":"Favicon in ICO format (Maximum file size is 2mb)","type":"string","format":"binary","nullable":true},"color_primary":{"description":"Primary color (Hexadecimal)","type":"string","example":"FDB713","nullable":true},"color_secondary":{"description":"Secondary color (Hexadecimal)","type":"string","example":"3F51B5","nullable":true},"color_muted":{"description":"Muted color (Hexadecimal)","type":"string","example":"CACACA","nullable":true},"color_primary_text":{"description":"Primary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"color_secondary_text":{"description":"Secondary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"link_chrome_extension":{"description":"Link to your Chrome extension","type":"string","example":"https:\/\/chrome.google.com\/webstore\/detail\/abc","nullable":true},"sso_client_id":{"description":"Client ID for SSO, used to identify the application in the identity provider.","type":"string","example":"your-client-id","nullable":true},"sso_client_secret":{"description":"Client Secret for SSO, used for secure communication with the identity provider. Keep this confidential.","type":"string","example":"your-client-secret","nullable":true},"sso_authorization_url":{"description":"Authorization URL for SSO, used to redirect users to the identity provider's login page.","type":"string","example":"https:\/\/example.auth0.com\/authorize","nullable":true},"sso_token_url":{"description":"Token URL for SSO, used to exchange the authorization code for access tokens.","type":"string","example":"https:\/\/example.auth0.com\/oauth\/token","nullable":true},"sso_userinfo_url":{"description":"UserInfo URL for SSO, used to fetch authenticated user details after successful login.","type":"string","example":"https:\/\/example.auth0.com\/userinfo","nullable":true},"book_demo":{"description":"Demo booking link or email","type":"string","nullable":true},"pricing_url":{"description":"Pricing page URL","type":"string","nullable":true},"contact_support":{"description":"Support contact link or email","type":"string","nullable":true},"terms_of_sale_file":{"description":"Terms of sale file in PDF format (maximum file size is 10mb). If this file is provided, the URL will be ignored.","type":"string","format":"binary","nullable":true},"terms_of_sale_url":{"description":"Terms of sale URL (if file is not provided)","type":"string","nullable":true},"prm_default_custom_statuses":{"description":"Defines the list of custom PRM statuses automatically created for new users of the reseller","type":"array","items":{"properties":{"name":{"type":"string","example":"Lead"},"color":{"type":"string","example":"FF6600","nullable":true}},"type":"object"},"nullable":true},"tags_default":{"type":"array","items":{"type":"string","example":"VIP"},"nullable":true}},"type":"object"},"ResellerFullProfile":{"description":"Displays the reseller profile detail (Show only values accessible with your level)","required":["id","name","domain_saas","domain_saas_status","domain_saas_status_date","domain_saas2","domain_saas2_status","domain_saas2_status_date","domain_saas3","domain_saas3_status","domain_saas3_status_date","domain_files","domain_files_status","domain_files_status_date","domain_redirect","domain_redirect_status","domain_redirect_status_date","domain_api","domain_api_status","domain_api_status_date","number_of_users","user_level","user_role","created_on","created_by","number_of_users_activated","terms_of_sale","prm_default_custom_statuses","options"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My reseller"},"domain_saas":{"type":"string","example":"http:\/\/saas.example.org","nullable":true},"domain_saas_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_saas_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_saas2":{"type":"string","example":"http:\/\/saas2.example.org","nullable":true},"domain_saas2_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_saas2_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_saas3":{"type":"string","example":"http:\/\/saas3.example.org","nullable":true},"domain_saas3_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_saas3_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_files":{"type":"string","example":"http:\/\/files.example.org","nullable":true},"domain_files_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_files_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_redirect":{"type":"string","example":"http:\/\/redirect.example.org","nullable":true},"domain_redirect_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_redirect_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_api":{"type":"string","example":"http:\/\/api.example.org","nullable":true},"domain_api_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_api_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"number_of_users":{"type":"integer","example":2},"number_of_users_activated":{"type":"integer","example":1},"user_level":{"oneOf":[{"$ref":"#\/components\/schemas\/Level"}],"nullable":true},"user_role":{"oneOf":[{"$ref":"#\/components\/schemas\/RoleUser"}],"nullable":true},"created_on":{"type":"string","format":"date-time"},"emails_notification_linkedin":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_email":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_global":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"integration_id":{"description":"Use your email to send transactional emails (SMTP account only and must belong to you)","type":"integer","example":"1","nullable":true},"logo":{"description":"Logo in SVG\/JPG\/PNG format","type":"string","nullable":true},"logo_menu":{"description":"Logo in SVG\/JPG\/PNG format","type":"string","nullable":true},"favicon":{"description":"Favicon in ICO format","type":"string","nullable":true},"color_primary":{"description":"Primary color (Hexadecimal)","type":"string","example":"FDB713","nullable":true},"color_secondary":{"description":"Secondary color (Hexadecimal)","type":"string","example":"3F51B5","nullable":true},"color_muted":{"description":"Muted color (Hexadecimal)","type":"string","example":"CACACA","nullable":true},"color_primary_text":{"description":"Primary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"color_secondary_text":{"description":"Secondary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"link_chrome_extension":{"description":"Link to your Chrome extension","type":"string","example":"https:\/\/chrome.google.com\/webstore\/detail\/abc","nullable":true},"created_by":{"type":"integer","example":1},"sso_client_id":{"description":"Client ID for SSO, used to identify the application in the identity provider.","type":"string","example":"your-client-id","nullable":true},"sso_redirect_uri":{"description":"Redirect URI for SSO, where the identity provider will send the authorization code after login.","type":"string","example":"https:\/\/your-api.com\/sso\/callback","nullable":true},"sso_authorization_url":{"description":"Authorization URL for SSO, used to redirect users to the identity provider's login page.","type":"string","example":"https:\/\/example.auth0.com\/authorize","nullable":true},"sso_token_url":{"description":"Token URL for SSO, used to exchange the authorization code for access tokens.","type":"string","example":"https:\/\/example.auth0.com\/oauth\/token","nullable":true},"sso_userinfo_url":{"description":"UserInfo URL for SSO, used to fetch authenticated user details after successful login.","type":"string","example":"https:\/\/example.auth0.com\/userinfo","nullable":true},"book_demo":{"description":"Demo booking link or email","type":"string","nullable":true},"pricing_url":{"description":"Pricing page URL","type":"string","nullable":true},"contact_support":{"description":"Support contact link or email","type":"string","nullable":true},"terms_of_sale":{"description":"Terms of sale URL","type":"string","nullable":true},"prm_default_custom_statuses":{"description":"List of custom PRM statuses automatically created for new users of the reseller","type":"array","items":{"$ref":"#\/components\/schemas\/PRMDefaultCustomStatus"},"nullable":true},"tags_default":{"type":"array","items":{"type":"string","example":"VIP"},"nullable":true},"options":{"description":"List of reseller options","type":"array","items":{"$ref":"#\/components\/schemas\/ResellerOption"}}},"type":"object"},"ResellerLevel":{"type":"string","enum":["user","admin"]},"ResellerProfile":{"description":"Displays the reseller profile detail (Show only values accessible with your level)","required":["id","name","domain_saas","domain_saas_status","domain_saas_status_date","created_by","domain_saas2","domain_saas2_status","domain_saas2_status_date","domain_saas3","domain_saas3_status","domain_saas3_status_date","domain_files","domain_files_status","domain_files_status_date","domain_redirect","domain_redirect_status","domain_redirect_status_date","domain_api","domain_api_status","domain_api_status_date","number_of_users","user_level","user_role","created_on","emails_notification_linkedin","emails_notification_email","emails_notification_global","integration_id","logo_url","logo_menu_url","favicon_url","color_primary","color_secondary","color_muted","color_primary_text","color_secondary_text","link_chrome_extension","chrome_extension_version","number_of_users_activated","book_demo","pricing_url","contact_support","terms_of_sale","prm_default_custom_statuses","tags_default","options"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My reseller"},"domain_saas":{"type":"string","example":"http:\/\/saas.example.org","nullable":true},"domain_saas_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_saas_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_saas2":{"type":"string","example":"http:\/\/saas2.example.org","nullable":true},"domain_saas2_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_saas2_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_saas3":{"type":"string","example":"http:\/\/saas3.example.org","nullable":true},"domain_saas3_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_saas3_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_files":{"type":"string","example":"http:\/\/files.example.org","nullable":true},"domain_files_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_files_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_redirect":{"type":"string","example":"http:\/\/redirect.example.org","nullable":true},"domain_redirect_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_redirect_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"domain_api":{"type":"string","example":"http:\/\/api.example.org","nullable":true},"domain_api_status":{"oneOf":[{"$ref":"#\/components\/schemas\/resellersDomainStatus"}],"nullable":true},"domain_api_status_date":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00","nullable":true},"number_of_users":{"type":"integer","example":2},"number_of_users_activated":{"type":"integer","example":1},"user_level":{"oneOf":[{"$ref":"#\/components\/schemas\/Level"}],"nullable":true},"user_role":{"oneOf":[{"$ref":"#\/components\/schemas\/RoleUser"}],"nullable":true},"created_on":{"type":"string","format":"date-time"},"emails_notification_linkedin":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_email":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_global":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"integration_id":{"description":"Use your email to send transactional emails (SMTP account only and must belong to you)","type":"integer","example":"1","nullable":true},"logo_url":{"description":"Logo URL in SVG\/JPG\/PNG format","type":"string","nullable":true},"logo_menu_url":{"description":"Logo URL in SVG\/JPG\/PNG format","type":"string","nullable":true},"favicon_url":{"description":"Favicon URL in ICO format","type":"string","nullable":true},"color_primary":{"description":"Primary color (Hexadecimal)","type":"string","example":"FDB713","nullable":true},"color_secondary":{"description":"Secondary color (Hexadecimal)","type":"string","example":"3F51B5","nullable":true},"color_muted":{"description":"Muted color (Hexadecimal)","type":"string","example":"CACACA","nullable":true},"color_primary_text":{"description":"Primary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"color_secondary_text":{"description":"Secondary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"link_chrome_extension":{"description":"Link to your Chrome extension","type":"string","example":"https:\/\/chrome.google.com\/webstore\/detail\/abc","nullable":true},"created_by":{"type":"integer","example":1},"chrome_extension_version":{"description":"Chrome extension version","type":"string","example":"1.0"},"sso_client_id":{"description":"Client ID for SSO, used to identify the application in the identity provider.","type":"string","example":"your-client-id","nullable":true},"sso_redirect_uri":{"description":"Redirect URI for SSO, where the identity provider will send the authorization code after login.","type":"string","example":"https:\/\/your-api.com\/sso\/callback","nullable":true},"sso_authorization_url":{"description":"Authorization URL for SSO, used to redirect users to the identity provider's login page.","type":"string","example":"https:\/\/example.auth0.com\/authorize","nullable":true},"sso_token_url":{"description":"Token URL for SSO, used to exchange the authorization code for access tokens.","type":"string","example":"https:\/\/example.auth0.com\/oauth\/token","nullable":true},"sso_userinfo_url":{"description":"UserInfo URL for SSO, used to fetch authenticated user details after successful login.","type":"string","example":"https:\/\/example.auth0.com\/userinfo","nullable":true},"book_demo":{"description":"Demo booking link or email","type":"string","nullable":true},"pricing_url":{"description":"Pricing page URL","type":"string","nullable":true},"contact_support":{"description":"Support contact link or email","type":"string","nullable":true},"terms_of_sale":{"description":"Terms of sale URL","type":"string","nullable":true},"prm_default_custom_statuses":{"description":"List of custom PRM statuses automatically created for new users of the reseller","type":"array","items":{"$ref":"#\/components\/schemas\/PRMDefaultCustomStatus"},"nullable":true},"tags_default":{"type":"array","items":{"type":"string","example":"VIP"},"nullable":true},"options":{"description":"List of reseller options","type":"array","items":{"$ref":"#\/components\/schemas\/ResellerOption"}}},"type":"object"},"ResellerUpdate":{"properties":{"name":{"description":"Reseller name. It will be displayed publicly","type":"string","example":"My reseller","nullable":true},"domain_saas":{"description":"SAAS access domain name (Use visual 1 on the frontend). Underscores not allowed","type":"string","example":"http:\/\/saas.example.org","nullable":true},"domain_saas2":{"description":"SAAS 2 access domain name (Use visual 2 on the frontend). Underscores not allowed","type":"string","example":"http:\/\/saas2.example.org","nullable":true},"domain_saas3":{"description":"SAAS 3 access domain name (Use visual 3 on the frontend). Underscores not allowed","type":"string","example":"http:\/\/saas3.example.org","nullable":true},"domain_files":{"description":"Files access domain name. Underscores not allowed","type":"string","example":"http:\/\/files.example.org","nullable":true},"domain_redirect":{"description":"Redirect access domain name. Underscores not allowed","type":"string","example":"http:\/\/redirect.example.org","nullable":true},"domain_api":{"description":"API access domain name. Underscores not allowed","type":"string","example":"http:\/\/api.example.org","nullable":true},"emails_notification_linkedin":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_email":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"emails_notification_global":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"integration_id":{"description":"Use your email to send transactional emails (SMTP account only and must belong to you)","type":"integer","example":"1","nullable":true},"logo":{"description":"Logo in SVG\/JPG\/PNG format (any size) (Maximum file size is 2mb)","type":"string","format":"binary","nullable":true},"logo_menu":{"description":"Logo in SVG\/JPG\/PNG format (any size) (Maximum file size is 2mb)","type":"string","format":"binary","nullable":true},"favicon":{"description":"Favicon in ICO format (Maximum file size is 2mb)","type":"string","format":"binary","nullable":true},"color_primary":{"description":"Primary color (Hexadecimal)","type":"string","example":"FDB713","nullable":true},"color_secondary":{"description":"Secondary color (Hexadecimal)","type":"string","example":"3F51B5","nullable":true},"color_muted":{"description":"Muted color (Hexadecimal)","type":"string","example":"CACACA","nullable":true},"color_primary_text":{"description":"Primary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"color_secondary_text":{"description":"Secondary text color (Hexadecimal)","type":"string","example":"FFFFFF","nullable":true},"link_chrome_extension":{"description":"Link to your Chrome extension","type":"string","example":"https:\/\/chrome.google.com\/webstore\/detail\/abc","nullable":true},"sso_client_id":{"description":"Client ID for SSO, used to identify the application in the identity provider.","type":"string","example":"your-client-id","nullable":true},"sso_client_secret":{"description":"Client Secret for SSO, used for secure communication with the identity provider. Keep this confidential.","type":"string","example":"your-client-secret","nullable":true},"sso_authorization_url":{"description":"Authorization URL for SSO, used to redirect users to the identity provider's login page.","type":"string","example":"https:\/\/example.auth0.com\/authorize","nullable":true},"sso_token_url":{"description":"Token URL for SSO, used to exchange the authorization code for access tokens.","type":"string","example":"https:\/\/example.auth0.com\/oauth\/token","nullable":true},"sso_userinfo_url":{"description":"UserInfo URL for SSO, used to fetch authenticated user details after successful login.","type":"string","example":"https:\/\/example.auth0.com\/userinfo","nullable":true},"book_demo":{"description":"Demo booking link or email","type":"string","nullable":true},"pricing_url":{"description":"Pricing page URL","type":"string","nullable":true},"contact_support":{"description":"Support contact link or email","type":"string","nullable":true},"terms_of_sale_file":{"description":"Terms of sale file in PDF format (maximum file size is 10mb). If this file is provided, the URL will be ignored.","type":"string","format":"binary","nullable":true},"terms_of_sale_url":{"description":"Terms of sale URL (if file is not provided)","type":"string","nullable":true},"prm_default_custom_statuses":{"description":"Defines the list of custom PRM statuses automatically created for new users of the reseller","type":"array","items":{"properties":{"name":{"type":"string","example":"Lead"},"color":{"type":"string","example":"FF6600","nullable":true}},"type":"object"},"nullable":true},"tags_default":{"type":"array","items":{"type":"string","example":"VIP"},"nullable":true}},"type":"object"},"RoleCreate":{"required":["name","is_admin","can_write_data"],"properties":{"name":{"type":"string","example":"My role"},"is_admin":{"type":"boolean"},"can_write_data":{"type":"boolean"}},"type":"object"},"RoleItem":{"required":["id","name","is_admin","can_write_data","created_by","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My role"},"is_admin":{"type":"boolean"},"can_write_data":{"type":"boolean"},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date_time"}},"type":"object"},"RoleResultItem":{"required":["id","name","is_admin","can_write_data","created_by","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My role"},"is_admin":{"type":"boolean"},"can_write_data":{"type":"boolean"},"created_by":{"type":"integer","example":1},"created_on":{"type":"string","format":"date_time"}},"type":"object"},"RoleUpdate":{"properties":{"name":{"type":"string","example":"My role","nullable":true},"is_admin":{"type":"boolean","nullable":true},"can_write_data":{"type":"boolean","nullable":true}},"type":"object"},"RoleUser":{"required":["id","name","is_admin","can_write_data"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My role"},"is_admin":{"type":"boolean"},"can_write_data":{"type":"boolean"}},"type":"object"},"Statistics.AbTest":{"required":["ab_subject","count_total","count_open"],"properties":{"ab_subject":{"type":"string"},"count_total":{"type":"integer"},"count_open":{"type":"integer"}},"type":"object"},"Statistics.ContactList":{"required":["contact_list_id","name"],"properties":{"contact_list_id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"statistics.date_range":{"required":["start_date","end_date"],"properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"}},"type":"object"},"DateStats":{"required":["date","sent","opener","clicker","answerer","bounce","email_sent","linkedin_invitation_sent","linkedin_message_sent","linkedin_visit_profile","sms_sent","email_answer","linkedin_invitation_accepted","linkedin_message_answered","email_answer_positive","email_answer_negative","email_answer_neutral","linkedin_message_answered_positive","linkedin_message_answered_negative","linkedin_message_answered_neutral","sms_answer","sms_answer_positive","sms_answer_negative","sms_answer_neutral","prm_contacts_status"],"properties":{"date":{"type":"string","format":"date"},"sent":{"type":"integer"},"opener":{"type":"integer"},"clicker":{"type":"integer"},"answerer":{"type":"integer"},"bounce":{"type":"integer"},"email_sent":{"type":"integer"},"linkedin_invitation_sent":{"type":"integer"},"linkedin_message_sent":{"type":"integer"},"linkedin_visit_profile":{"type":"integer"},"sms_sent":{"type":"integer"},"email_answer":{"type":"integer"},"email_answer_positive":{"type":"integer"},"email_answer_negative":{"type":"integer"},"email_answer_neutral":{"type":"integer"},"linkedin_invitation_accepted":{"type":"integer"},"linkedin_message_answered":{"type":"integer"},"linkedin_message_answered_positive":{"type":"integer"},"linkedin_message_answered_negative":{"type":"integer"},"linkedin_message_answered_neutral":{"type":"integer"},"sms_answer":{"type":"integer"},"sms_answer_positive":{"type":"integer"},"sms_answer_negative":{"type":"integer"},"sms_answer_neutral":{"type":"integer"},"prm_contacts_status":{"type":"array","items":{"$ref":"#\/components\/schemas\/statistics.PrmContactCustomStatus"}}},"type":"object"},"DateStatsDetailed":{"required":["date","stats"],"properties":{"date":{"type":"string","format":"date"},"stats":{"$ref":"#\/components\/schemas\/GlobalStatisticsDate"}},"type":"object"},"GlobalStatistics":{"required":["contacts_unique","sent","opener_total","clicker_total","answerer_total","opener_unique","clicker_unique","answerer_unique","email_sent","contact_email_bounce","integrations_deliverability","programmation_running","programmation_stopped","programmation_archived","linkedin_invitation_sent","linkedin_message_sent","linkedin_visit_profile","sms_sent","email_answer","linkedin_invitation_accepted","linkedin_message_answered","email_answer_positive","email_answer_negative","email_answer_neutral","linkedin_message_answered_positive","linkedin_message_answered_negative","linkedin_message_answered_neutral","sms_answer","sms_answer_positive","sms_answer_negative","sms_answer_neutral","prm_contacts_status","email_answer_unique","linkedin_message_answered_unique","linkedin_invitation_accepted_unique","email_opener_unique"],"properties":{"contacts_unique":{"type":"integer"},"sent":{"type":"integer"},"opener_total":{"type":"integer"},"clicker_total":{"type":"integer"},"answerer_total":{"type":"integer"},"opener_unique":{"type":"integer"},"clicker_unique":{"type":"integer"},"answerer_unique":{"type":"integer"},"email_sent":{"type":"integer"},"contact_email_bounce":{"type":"integer"},"integrations_deliverability":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.IntegrationDeliverability"}},"programmation_running":{"type":"integer"},"programmation_stopped":{"type":"integer"},"programmation_archived":{"type":"integer"},"linkedin_invitation_sent":{"type":"integer"},"linkedin_message_sent":{"type":"integer"},"linkedin_visit_profile":{"type":"integer"},"sms_sent":{"type":"integer"},"email_answer":{"type":"integer"},"email_answer_unique":{"type":"integer"},"email_answer_positive":{"type":"integer"},"email_answer_negative":{"type":"integer"},"email_answer_neutral":{"type":"integer"},"email_opener_unique":{"type":"integer"},"linkedin_invitation_accepted":{"type":"integer"},"linkedin_invitation_accepted_unique":{"type":"integer"},"linkedin_message_answered":{"type":"integer"},"linkedin_message_answered_unique":{"type":"integer"},"linkedin_message_answered_positive":{"type":"integer"},"linkedin_message_answered_negative":{"type":"integer"},"linkedin_message_answered_neutral":{"type":"integer"},"sms_answer":{"type":"integer"},"sms_answer_positive":{"type":"integer"},"sms_answer_negative":{"type":"integer"},"sms_answer_neutral":{"type":"integer"},"prm_contacts_status":{"type":"array","items":{"$ref":"#\/components\/schemas\/statistics.PrmContactCustomStatus"}}},"type":"object"},"GlobalStatisticsDate":{"required":["contacts_unique","sent","opener_total","clicker_total","answerer_total","opener_unique","clicker_unique","answerer_unique","contact_email_bounce","email_sent","linkedin_invitation_sent","linkedin_message_sent","linkedin_visit_profile","sms_sent","email_answer","linkedin_invitation_accepted","linkedin_message_answered","email_answer_positive","email_answer_negative","email_answer_neutral","linkedin_message_answered_positive","linkedin_message_answered_negative","linkedin_message_answered_neutral","sms_answer","sms_answer_positive","sms_answer_negative","sms_answer_neutral","prm_contacts_status","email_answer_unique","linkedin_message_answered_unique","linkedin_invitation_accepted_unique","email_opener_unique"],"properties":{"contacts_unique":{"type":"integer"},"sent":{"type":"integer"},"opener_total":{"type":"integer"},"clicker_total":{"type":"integer"},"answerer_total":{"type":"integer"},"opener_unique":{"type":"integer"},"clicker_unique":{"type":"integer"},"answerer_unique":{"type":"integer"},"contact_email_bounce":{"type":"integer"},"email_sent":{"type":"integer"},"linkedin_invitation_sent":{"type":"integer"},"linkedin_message_sent":{"type":"integer"},"linkedin_visit_profile":{"type":"integer"},"sms_sent":{"type":"integer"},"email_answer":{"type":"integer"},"email_answer_unique":{"type":"integer"},"email_answer_positive":{"type":"integer"},"email_answer_negative":{"type":"integer"},"email_answer_neutral":{"type":"integer"},"email_opener_unique":{"type":"integer"},"linkedin_invitation_accepted":{"type":"integer"},"linkedin_invitation_accepted_unique":{"type":"integer"},"linkedin_message_answered":{"type":"integer"},"linkedin_message_answered_unique":{"type":"integer"},"linkedin_message_answered_positive":{"type":"integer"},"linkedin_message_answered_negative":{"type":"integer"},"linkedin_message_answered_neutral":{"type":"integer"},"sms_answer":{"type":"integer"},"sms_answer_positive":{"type":"integer"},"sms_answer_negative":{"type":"integer"},"sms_answer_neutral":{"type":"integer"},"prm_contacts_status":{"type":"array","items":{"$ref":"#\/components\/schemas\/statistics.PrmContactCustomStatus"}}},"type":"object"},"Statistics.Integration":{"required":["id","name","account_type_email","contacts_contacted_today","contacts_contacted_week","contacts_contacted_month","limit_contacts_today","limit_contacts_month","enable_tracking"],"properties":{"id":{"type":"integer","nullable":true},"name":{"type":"string","nullable":true},"account_type_email":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"}],"nullable":true},"contacts_contacted_today":{"description":"Number of interractions done today. Take note for linkedin, \"today\" is the last 24 hours instead","type":"integer","nullable":true},"contacts_contacted_week":{"description":"Only for linkedin. Number of interactions done on the last 7 days","type":"integer","nullable":true},"contacts_contacted_month":{"description":"Only for linkedin. Number of interactions done on the last month","type":"integer","nullable":true},"limit_contacts_today":{"type":"integer","nullable":true},"limit_contacts_month":{"type":"integer","nullable":true},"enable_tracking":{"type":"boolean","nullable":true}},"type":"object"},"Statistics.IntegrationDeliverability":{"required":["id","name","type","sent","opener","clicker","answerer","answer_positive","answer_negative","answer_neutral"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"$ref":"#\/components\/schemas\/IntegrationType"},"sent":{"type":"integer"},"opener":{"type":"integer"},"clicker":{"type":"integer"},"answerer":{"type":"integer"},"answer_positive":{"type":"integer"},"answer_negative":{"type":"integer"},"answer_neutral":{"type":"integer"}},"type":"object"},"Statistics.IntegrationStatistic":{"required":["id","name","type","account_type_email","interactions","programmation_id"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"$ref":"#\/components\/schemas\/IntegrationType"},"account_type_email":{"oneOf":[{"$ref":"#\/components\/schemas\/IntegrationsEmailAccountType"}],"nullable":true},"interactions":{"type":"integer"},"programmation_id":{"type":"integer","nullable":true}},"type":"object"},"Statistics.IntegrationStatisticDate":{"required":["date","integrations"],"properties":{"date":{"type":"string","format":"date"},"integrations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.IntegrationStatistic"}}},"type":"object"},"Statistics.Link":{"required":["url","clicks"],"properties":{"url":{"type":"string"},"clicks":{"type":"integer"}},"type":"object"},"Statistics.Model":{"required":["id","name","is_email_template"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"is_email_template":{"type":"boolean","nullable":true}},"type":"object"},"Statistics.ParentStep":{"required":["id","event_type","name","when_minutes"],"properties":{"id":{"type":"integer"},"event_type":{"$ref":"#\/components\/schemas\/EventType"},"name":{"type":"string","nullable":true},"when_minutes":{"type":"integer","nullable":true}},"type":"object"},"statistics.Pool":{"allOf":[{"$ref":"#\/components\/schemas\/PoolItem"}]},"statistics.PrmContactCustomStatus":{"required":["custom_status_id","contacts_total"],"properties":{"custom_status_id":{"type":"integer"},"contacts_total":{"type":"integer"}},"type":"object"},"Programmation":{"required":["id","stopped","stopped_on","archived","archived_on","workflow_id","workflow_name","is_newsletter","contact_lists","created_by","steps","created_on","bounced","unsubscribers","blacklisted","excluded_previous_programmation","excluded_workflow","contacts_opened","contacts_clicked","contacts_answered","date_start","time_start_sending","time_stop_sending","excluded_programmation","stats_sharings","ab_finished_at","ab_tests","pin","blacklists_stats","contacted","to_contact","tags"],"properties":{"id":{"type":"integer"},"stopped":{"type":"boolean"},"stopped_on":{"type":"string","format":"date-time","nullable":true},"archived":{"type":"boolean"},"archived_on":{"type":"string","format":"date-time","nullable":true},"workflow_id":{"type":"integer"},"workflow_name":{"type":"string"},"is_newsletter":{"description":"True if it is a newsletter workflow","type":"boolean"},"contact_lists":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.ContactList"}},"created_by":{"$ref":"#\/components\/schemas\/UserListed"},"steps":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.Step"}},"created_on":{"type":"string","format":"date-time"},"date_start":{"type":"string","format":"date-time"},"time_start_sending":{"description":"Between 00:00:00 and 23:59:59. Must be lower than time_stop_sending. Must be GMT if you don't provide time_sending_timezone","type":"string","example":"08:00:00"},"time_stop_sending":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59"},"contacted":{"type":"integer","nullable":true},"to_contact":{"type":"integer","nullable":true},"bounced":{"type":"integer","nullable":true},"unsubscribers":{"type":"integer","nullable":true},"blacklisted":{"type":"integer","nullable":true},"excluded_previous_programmation":{"type":"integer","nullable":true},"excluded_workflow":{"type":"integer","nullable":true},"excluded_programmation":{"type":"integer","nullable":true},"contacts_opened":{"type":"integer","nullable":true},"contacts_clicked":{"type":"integer","nullable":true},"contacts_answered":{"type":"integer","nullable":true},"stats_sharings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"ab_finished_at":{"type":"string","format":"date-time","nullable":true},"ab_tests":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.AbTest"}},"pin":{"type":"boolean"},"blacklists_stats":{"type":"array","items":{"$ref":"#\/components\/schemas\/BlacklistedCount"},"nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}},"type":"object"},"Statistics.ProgrammationDiagnostic":{"required":["level","message","integration_id"],"properties":{"level":{"$ref":"#\/components\/schemas\/ProgrammationDiagnosticLevel"},"message":{"$ref":"#\/components\/schemas\/message"},"integration_id":{"type":"integer","nullable":true}},"type":"object"},"ProgrammationDiagnosticLevel":{"type":"string","enum":["critical","error","warning","info"]},"ProgrammationSort":{"required":["field_name","sort_direction"],"type":"object","example":{"field_name":"contacted","sort_direction":"desc"},"allOf":[{"$ref":"#\/components\/schemas\/Sort"},{"properties":{"field_name":{"type":"string","enum":["id","contacted","contacts_opened","contacts_clicked","contacts_answered","contacts_opened_rate","contacts_clicked_rate","contacts_answered_rate"]}},"type":"object"}]},"Statistics.ProgrammationType":{"type":"string","enum":["all","running","stopped","archived","non_archived"]},"ProgrammationsStatistics":{"required":["number_results","programmations","page"],"properties":{"number_results":{"type":"integer"},"page":{"description":"Current page","type":"integer"},"programmations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Programmation"}}},"type":"object"},"Channel":{"type":"string","enum":["email","linkedin"]},"PrmContactStatusInfo":{"required":["status","custom_status_id"],"properties":{"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true,"description":"PRM contact default status; null when the responder has no PRM contact or no default status."},"custom_status_id":{"description":"PRM custom status id; null when the responder has no PRM contact or no custom status.","type":"integer","nullable":true}},"type":"object"},"ResponderByChannelAndStatus":{"required":["channel","prm_status","count"],"properties":{"channel":{"$ref":"#\/components\/schemas\/Channel"},"prm_status":{"$ref":"#\/components\/schemas\/PrmContactStatusInfo"},"count":{"type":"integer"}},"type":"object"},"ResponderByCompanySize":{"required":["company_size","count"],"properties":{"company_size":{"description":"Normalized company size range (e.g. \"1-10\", \"11-50\"); null when the contact has no company size set.","type":"string","nullable":true},"count":{"type":"integer"}},"type":"object"},"ResponderByCompanySizeAndStatus":{"required":["company_size","prm_status","count"],"properties":{"company_size":{"description":"Normalized company size range (e.g. \"1-10\", \"11-50\"); null when the contact has no company size set.","type":"string","nullable":true},"prm_status":{"$ref":"#\/components\/schemas\/PrmContactStatusInfo"},"count":{"type":"integer"}},"type":"object"},"ResponderByCountry":{"required":["country","count"],"properties":{"country":{"description":"Country raw value from the contact datafield; null when missing.","type":"string","nullable":true},"count":{"type":"integer"}},"type":"object"},"ResponderByPrmOwner":{"required":["owner","count"],"properties":{"owner":{"oneOf":[{"$ref":"#\/components\/schemas\/UserListed"}],"nullable":true,"description":"PRM contact owner; null when responder has no PRM contact or no owner assigned."},"count":{"type":"integer"}},"type":"object"},"ResponderByProgrammationAndList":{"required":["programmation","contact_list","count"],"properties":{"programmation":{"$ref":"#\/components\/schemas\/WorkflowProgrammationInfo"},"contact_list":{"oneOf":[{"$ref":"#\/components\/schemas\/ContactListInfo"}],"nullable":true,"description":"Contact list; null when the responder is not bound to a contact list."},"count":{"type":"integer"}},"type":"object"},"ResponderByRegion":{"required":["country","region","count"],"properties":{"country":{"description":"ISO 3166-1 alpha-3 country code (e.g. \"FRA\").","type":"string"},"region":{"description":"Region name within the country; null when the zip code is missing\/invalid.","type":"string","nullable":true},"count":{"type":"integer"}},"type":"object"},"ResponderBySector":{"required":["sector","count"],"properties":{"sector":{"description":"Activity sector raw value from the contact datafield; null when missing.","type":"string","nullable":true},"count":{"type":"integer"}},"type":"object"},"ResponderBySectorAndStatus":{"required":["sector","prm_status","count"],"properties":{"sector":{"description":"Activity sector raw value from the contact datafield; null when missing.","type":"string","nullable":true},"prm_status":{"$ref":"#\/components\/schemas\/PrmContactStatusInfo"},"count":{"type":"integer"}},"type":"object"},"ResponderByTag":{"required":["tag_id","tag_name","count"],"properties":{"tag_id":{"description":"Tag id; null when the responder has no tag (or no PRM contact).","type":"integer","nullable":true},"tag_name":{"description":"Tag name; null when the responder has no tag (or no PRM contact).","type":"string","nullable":true},"count":{"type":"integer"}},"type":"object"},"Statistics.Step":{"required":["id","model","action_type","is_initial","contacted","to_contact","in_queue","contacts_opened","contacts_clicked","contacts_answered","integration","pool","details","is_stopped","parent_steps","last_contacted","sent_today","limit_send_per_day","bounced","unsubscribers","blacklisted","excluded_previous_programmation","excluded_workflow","waiting","in_queue_failed","to_contact_failed","excluded_programmation","contacts_without_required_data","next_waiting"],"properties":{"id":{"type":"integer"},"model":{"oneOf":[{"$ref":"#\/components\/schemas\/Statistics.Model"}],"nullable":true},"action_type":{"$ref":"#\/components\/schemas\/ActionType"},"is_initial":{"type":"boolean"},"contacted":{"type":"integer","nullable":true},"to_contact":{"type":"integer","nullable":true},"to_contact_failed":{"type":"integer","nullable":true},"in_queue":{"type":"integer","nullable":true},"in_queue_failed":{"type":"integer","nullable":true},"contacts_opened":{"type":"integer","nullable":true},"contacts_clicked":{"type":"integer","nullable":true},"contacts_answered":{"type":"integer","nullable":true},"integration":{"oneOf":[{"$ref":"#\/components\/schemas\/Statistics.Integration"}],"nullable":true},"pool":{"oneOf":[{"$ref":"#\/components\/schemas\/statistics.Pool"}],"nullable":true},"details":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.ProgrammationDiagnostic"}},"is_stopped":{"type":"boolean"},"parent_steps":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.ParentStep"}},"last_contacted":{"type":"string","format":"date-time","nullable":true},"sent_today":{"type":"integer","nullable":true},"limit_send_per_day":{"type":"integer"},"bounced":{"type":"integer","nullable":true},"unsubscribers":{"type":"integer","nullable":true},"blacklisted":{"type":"integer","nullable":true},"excluded_previous_programmation":{"type":"integer","nullable":true},"excluded_workflow":{"type":"integer","nullable":true},"excluded_programmation":{"type":"integer","nullable":true},"links":{"type":"array","items":{"$ref":"#\/components\/schemas\/Statistics.Link"}},"waiting":{"type":"integer","nullable":true},"contacts_without_required_data":{"type":"integer","nullable":true},"next_waiting":{"type":"string","format":"date-time","nullable":true}},"type":"object"},"UsersStats":{"required":["stats_current_range","stats_previous_range","connection_per_day"],"properties":{"stats_current_range":{"$ref":"#\/components\/schemas\/UsersStatsStat"},"stats_previous_range":{"oneOf":[{"$ref":"#\/components\/schemas\/UsersStatsStat"}],"nullable":true},"connection_per_day":{"type":"array","items":{"$ref":"#\/components\/schemas\/UsersStatsDate"}}},"type":"object"},"UsersStatsDate":{"required":["date","number_connections"],"properties":{"date":{"type":"string","format":"date"},"number_connections":{"type":"integer"}},"type":"object"},"UsersStatsStat":{"required":["total_users","active_users","paid_users","total_sum_billed"],"properties":{"total_users":{"type":"integer"},"active_users":{"type":"integer"},"paid_users":{"type":"integer"},"total_sum_billed":{"type":"number","format":"float"}},"type":"object"},"Address":{"required":["line1","city","postal_code","country"],"properties":{"line1":{"type":"string","example":"123 Fake Street","nullable":true},"line2":{"type":"string","example":"Suite 456","nullable":true},"city":{"type":"string","example":"Faketown","nullable":true},"state":{"type":"string","example":"CA","nullable":true},"postal_code":{"type":"string","example":"90210","nullable":true},"country":{"description":"ISO 3166 standard (2 characters) - Example: FR for France, BE for Belgium","type":"string","example":"US","nullable":true}},"type":"object"},"Customer":{"required":["email","name","address","tax_ids"],"properties":{"email":{"type":"string","example":"fake.email@example.com","nullable":true},"name":{"type":"string","example":"John Doe","nullable":true},"address":{"oneOf":[{"$ref":"#\/components\/schemas\/Address"}],"nullable":true},"tax_ids":{"type":"array","items":{"$ref":"#\/components\/schemas\/TaxId"}}},"type":"object"},"Invoice":{"required":["id","amount_paid","subtotal","subtotal_before_discount","discount_ht","net_total_ht","vat_amount","total","total_ttc","currency","created","period","lines","country"],"properties":{"id":{"type":"string","example":"in_123456789","nullable":true},"amount_paid":{"type":"integer","example":1500},"subtotal":{"type":"integer","example":1400},"subtotal_before_discount":{"type":"integer","example":1800},"discount":{"type":"integer","example":3640},"vat_amount":{"type":"integer","example":2912},"total":{"type":"integer","example":1500},"currency":{"type":"string","example":"usd"},"status":{"type":"string","example":"paid","nullable":true},"created":{"type":"integer","example":1680671232},"period":{"$ref":"#\/components\/schemas\/InvoicePeriod"},"lines":{"type":"array","items":{"$ref":"#\/components\/schemas\/InvoiceLine"}},"promo_code":{"type":"string","example":"DISCOUNT20","nullable":true},"country":{"type":"string","example":"FR","nullable":true}},"type":"object"},"InvoiceLine":{"required":["id","amount"],"properties":{"id":{"type":"string","example":"line_123456789"},"amount":{"type":"integer","example":500},"description":{"type":"string","example":"Product description","nullable":true},"name":{"type":"string","example":"Product name","nullable":true}},"type":"object"},"InvoicePeriod":{"required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","example":"2023-01-01T00:00:00+00:00","nullable":true},"end":{"type":"string","format":"date-time","example":"2023-01-31T23:59:59+00:00","nullable":true}},"type":"object"},"InvoiceResultItem":{"required":["id","ident","totalAmountTaxesFree","totalAmount","taxesAmountSum","displayedDate","auxCode"],"properties":{"id":{"type":"integer","example":123456},"ident":{"type":"string","example":"INV12345"},"totalAmountTaxesFree":{"type":"number","format":"float","example":500},"totalAmount":{"type":"number","format":"float","example":600},"taxesAmountSum":{"type":"number","format":"float","example":100},"displayedDate":{"type":"string","format":"date-time","example":"2024-10-25T12:34:56+00:00"},"auxCode":{"type":"string","example":"CCLIEN001"}},"type":"object"},"MySubscription":{"required":["active","subscription_id","end_date","first_day_of_month","recurring_interval","trial","monthly_amount","products","options_remove_renewal","payment_methods","customer","next_monthly_amount","payment_method_valid","is_canceled","canceled_at","last_payment_succeeded","last_payment_error_status","last_payment_error_details"],"properties":{"active":{"type":"boolean"},"subscription_id":{"type":"string","example":"sub_123456789","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"first_day_of_month":{"type":"string","format":"date-time","nullable":true},"recurring_interval":{"type":"string","nullable":true,"enum":["month","year"]},"trial":{"type":"boolean"},"monthly_amount":{"description":"Monthly amount in Euros","type":"number","format":"float","nullable":true},"next_monthly_amount":{"description":"Next monthly amount in Euros","type":"number","format":"float","nullable":true},"products":{"type":"array","items":{"$ref":"#\/components\/schemas\/ProductItem"},"nullable":true},"options_remove_renewal":{"type":"array","items":{"$ref":"#\/components\/schemas\/ProductItemRemoveRenewal"},"nullable":true},"payment_methods":{"type":"array","items":{"$ref":"#\/components\/schemas\/PaymentMethod"},"nullable":true},"payment_method_valid":{"description":"Indicates if the default payment method is valid (Stripe + expiry)","type":"boolean"},"customer":{"oneOf":[{"$ref":"#\/components\/schemas\/Customer"}],"nullable":true},"is_canceled":{"type":"boolean"},"last_payment_succeeded":{"description":"Indicates if the last Stripe payment succeeded","type":"boolean","nullable":true},"last_payment_error_status":{"description":"Stripe PaymentIntent status when last payment failed","type":"string","nullable":true,"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled"]},"last_payment_error_details":{"description":"Detailed information on last payment failure from Stripe","properties":{"type":{"type":"string","example":"card_error"},"code":{"type":"string","example":"card_declined"},"decline_code":{"type":"string","example":"transaction_not_allowed"},"message":{"type":"string","example":"Your card does not support this type of purchase."},"action_url":{"type":"string","format":"uri","example":"https:\/\/billing.stripe.com\/p\/session\/abc123"}},"type":"object","nullable":true},"canceled_at":{"type":"string","format":"date-time","nullable":true}},"type":"object"},"PaymentMethod":{"required":["id","name","brand","last4","exp_month","exp_year","is_default"],"properties":{"id":{"type":"string","example":"pm_123456789"},"name":{"type":"string","example":"Jean Dupont","nullable":true},"brand":{"type":"string","example":"visa","nullable":true},"last4":{"type":"string","example":"4242","nullable":true},"exp_month":{"type":"integer","example":12,"nullable":true},"exp_year":{"type":"integer","example":2025,"nullable":true},"is_default":{"description":"Is this the default payment method","type":"boolean","example":true}},"type":"object"},"ProductItem":{"required":["product_id","product_name","price_id","quantity","price_amount","price_currency","billing_interval","image_url","description","features","type","sub_type"],"properties":{"product_id":{"type":"string","example":"prod_123456789"},"product_name":{"type":"string","example":"My product"},"price_id":{"type":"string","example":"price_123456789"},"quantity":{"type":"integer","example":1},"price_amount":{"type":"number","format":"float","example":80},"price_currency":{"type":"string","example":"eur"},"billing_interval":{"type":"string","enum":["month","year"]},"image_url":{"type":"string","example":"http:\/\/img.example.org\/product.png","nullable":true},"description":{"type":"string","example":"My description","nullable":true},"features":{"type":"array","items":{"type":"string","example":"My feature"},"nullable":true},"type":{"type":"string","nullable":true,"enum":["product","option"]},"sub_type":{"type":"string","nullable":true,"enum":["linkedin","smtp","enrich","mobile"]}},"type":"object"},"ProductItemRemoveRenewal":{"required":["product_id","product_name","price_id","quantity","sub_type"],"properties":{"product_id":{"type":"string","example":"prod_123456789"},"product_name":{"type":"string","example":"My product"},"price_id":{"type":"string","example":"price_123456789"},"quantity":{"type":"integer","example":1},"sub_type":{"type":"string","nullable":true,"enum":["linkedin","smtp","enrich","mobile"]}},"type":"object"},"ProductResultItem":{"required":["product_id","product_name","price_id","price_amount","price_currency","billing_interval"],"properties":{"product_id":{"type":"string","example":"prod_123456789"},"product_name":{"type":"string","example":"My product"},"price_id":{"type":"string","example":"price_123456789"},"price_amount":{"type":"number","format":"float","example":80},"price_currency":{"type":"string","example":"eur"},"billing_interval":{"type":"string","enum":["month","year"]},"image_url":{"type":"string","example":"http:\/\/img.example.org\/product.png","nullable":true},"description":{"type":"string","example":"My description","nullable":true},"features":{"type":"array","items":{"type":"string","example":"My feature"},"nullable":true},"type":{"type":"string","nullable":true,"enum":["product","option"]},"sub_type":{"type":"string","nullable":true,"enum":["linkedin","smtp","enrich","mobile"]}},"type":"object"},"RecurringInterval":{"type":"string","enum":["month","year"]},"SubscribeItems":{"required":["price_id","quantity"],"properties":{"price_id":{"type":"string","example":"price_123456789"},"quantity":{"description":"Quantity to add\/remove","type":"integer","example":1}},"type":"object"},"TaxId":{"required":["id","type","value"],"properties":{"id":{"type":"string","example":"txi_123456789"},"type":{"type":"string","example":"eu_vat"},"value":{"type":"string","example":"FR123456789"}},"type":"object"},"UserSubscriptionType":{"type":"string","enum":["free","subscriber","trial"]},"Tag":{"required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My tag"},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true,"default":null}},"type":"object"},"TagItem":{"required":["id","name","from_sharing","sharing","created_by","permission","created_on","color"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My tag"},"from_sharing":{"description":"Whether or not someone is sharing you this tag","type":"boolean"},"sharing":{"description":"The sharing currently configured for this tag. Null if you are not the admin of this tag","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this tag","type":"integer","example":1,"nullable":true},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true,"default":null}},"type":"object"},"TagResultItem":{"required":["id","name","from_sharing","read_permission","write_permission","delete_permission","created_by","sharing","created_on","color"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My tag"},"from_sharing":{"description":"Whether or not someone is sharing you this tag","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this tag","type":"integer","example":1,"nullable":true},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"color":{"description":"RGB hex color code in 6 hex digits","type":"string","example":"AA5C00","nullable":true,"default":null}},"type":"object"},"DatabaseLocation":{"properties":{"name":{"type":"string"}},"type":"object"},"DatabaseFilter":{"properties":{"field":{"description":"The target field for the search. Allowed fields include: 'civility', 'last_name', 'first_name', 'phone', 'mobile_phone', 'zip_code',\n        'city', 'job_title', 'company', 'company_size', 'naf_code', 'siren', 'siret', 'activity', 'website', 'linkedin_url', 'contact_location', 'summary',\n        'country'. These fields represent the specific attributes of contacts that can be targeted for filtering.","type":"string"},"contains":{"description":"Values that the specified field should contain.","type":"array","items":{"type":"string"}},"does_not_contain":{"description":"Values that the specified field should not contain.","type":"array","items":{"type":"string"}},"starts_with":{"description":"Values with which the specified field should start.","type":"array","items":{"type":"string"}},"does_not_start_with":{"description":"Values with which the specified field should not start.","type":"array","items":{"type":"string"}},"ends_with":{"description":"Values with which the specified field should end.","type":"array","items":{"type":"string"}},"does_not_end_with":{"description":"Values with which the specified field should not end.","type":"array","items":{"type":"string"}},"exact_match":{"description":"Values that should exactly match the specified field.","type":"array","items":{"type":"string"}},"exists":{"description":"Specifies if the field must exist or not.","type":"boolean"}},"type":"object"},"DatabaseFilters":{"properties":{"filters":{"description":"Array of filter criteria.","type":"array","items":{"$ref":"#\/components\/schemas\/DatabaseFilter"}}},"type":"object"},"GeneratePeoplesSearch":{"properties":{"current_title":{"type":"string","nullable":true},"locations":{"description":"Some example values :\n        France\t105015875<br>\n        USA\t103644278<br>\n        UK\t101165590<br>\n        Germany\t101282230<br>\n        Italie\t103350119<br>\n        Suisse\t106693272<br>\n        Luxembourg\t104042105<br>\n        Belgique\t100565514<br>\n        Pays Bas\t102890719<br>\n        Espagne\t105646813<br>\n        Maroc\t102787409<br>\n        Auvergne-Rh\u00f4ne-Alpes\t103623254<br>\n        Bourgogne-Franche-Comt\u00e9\t103286073<br>\n        Bretagne\t103737322<br>\n        Centre-Val de Loire\t102215960<br>\n        Corse\t106926833<br>\n        Grand Est\t101735443<br>\n        Hauts-de-France\t105007536<br>\n        Ile-de-France\t104246759<br>\n        Normandie\t104433326<br>\n        Nouvelle-Aquitaine\t105563475<br>\n        Occitanie\t103876217<br>\n        Pays de la Loire\t104731846<br>\n        Provence Alpes C\u00f4te d\u2019Azur\t102203735","type":"array","items":{"type":"integer"}},"industries":{"description":"Possible values: {\"1\":\"Defense and Space Manufacturing\",\"3\":\"Computer Hardware Manufacturing\",\"4\":\"Software Development\",\"5\":\"Computer Networking Products\",\"6\":\"Technology, Information and Internet\",\"7\":\"Semiconductor Manufacturing\",\"8\":\"Telecommunications\",\"9\":\"Law Practice\",\"10\":\"Legal Services\",\"11\":\"Business Consulting and Services\",\"12\":\"Biotechnology Research\",\"13\":\"Medical Practices\",\"14\":\"Hospitals and Health Care\",\"15\":\"Pharmaceutical Manufacturing\",\"16\":\"Veterinary Services\",\"17\":\"Medical Equipment Manufacturing\",\"18\":\"Personal Care Product Manufacturing\",\"19\":\"Retail Apparel and Fashion\",\"20\":\"Sporting Goods Manufacturing\",\"21\":\"Tobacco Manufacturing\",\"22\":\"Retail Groceries\",\"23\":\"Food and Beverage Manufacturing\",\"24\":\"Computers and Electronics Manufacturing\",\"25\":\"Manufacturing\",\"26\":\"Furniture and Home Furnishings Manufacturing\",\"27\":\"Retail\",\"28\":\"Entertainment Providers\",\"29\":\"Gambling Facilities and Casinos\",\"30\":\"Travel Arrangements\",\"31\":\"Hospitality\",\"32\":\"Restaurants\",\"33\":\"Spectator Sports\",\"34\":\"Food and Beverage Services\",\"35\":\"Movies, Videos, and Sound\",\"36\":\"Broadcast Media Production and Distribution\",\"37\":\"Museums, Historical Sites, and Zoos\",\"38\":\"Artists and Writers\",\"39\":\"Performing Arts\",\"40\":\"Recreational Facilities\",\"41\":\"Banking\",\"42\":\"Insurance\",\"43\":\"Financial Services\",\"44\":\"Real Estate\",\"45\":\"Investment Banking\",\"46\":\"Investment Management\",\"47\":\"Accounting\",\"48\":\"Construction\",\"49\":\"Wholesale Building Materials\",\"50\":\"Architecture and Planning\",\"51\":\"Civil Engineering\",\"52\":\"Aviation and Aerospace Component Manufacturing\",\"53\":\"Motor Vehicle Manufacturing\",\"54\":\"Chemical Manufacturing\",\"55\":\"Machinery Manufacturing\",\"56\":\"Mining\",\"57\":\"Oil and Gas\",\"58\":\"Shipbuilding\",\"59\":\"Utilities\",\"60\":\"Textile Manufacturing\",\"61\":\"Paper and Forest Product Manufacturing\",\"62\":\"Railroad Equipment Manufacturing\",\"63\":\"Farming\",\"64\":\"Ranching\",\"65\":\"Dairy Product Manufacturing\",\"66\":\"Fisheries\",\"67\":\"Primary and Secondary Education\",\"68\":\"Higher Education\",\"69\":\"Education Administration Programs\",\"70\":\"Research Services\",\"71\":\"Armed Forces\",\"72\":\"Legislative Offices\",\"73\":\"Administration of Justice\",\"74\":\"International Affairs\",\"75\":\"Government Administration\",\"76\":\"Executive Offices\",\"77\":\"Law Enforcement\",\"78\":\"Public Safety\",\"79\":\"Public Policy Offices\",\"80\":\"Advertising Services\",\"81\":\"Newspaper Publishing\",\"82\":\"Book and Periodical Publishing\",\"83\":\"Printing Services\",\"84\":\"Information Services\",\"85\":\"Libraries\",\"86\":\"Environmental Services\",\"87\":\"Freight and Package Transportation\",\"88\":\"Individual and Family Services\",\"89\":\"Religious Institutions\",\"90\":\"Civic and Social Organizations\",\"91\":\"Consumer Services\",\"92\":\"Truck Transportation\",\"93\":\"Warehousing and Storage\",\"94\":\"Airlines and Aviation\",\"95\":\"Maritime Transportation\",\"96\":\"IT Services and IT Consulting\",\"97\":\"Market Research\",\"98\":\"Public Relations and Communications Services\",\"99\":\"Design Services\",\"100\":\"Non-profit Organizations\",\"101\":\"Fundraising\",\"102\":\"Strategic Management Services\",\"103\":\"Writing and Editing\",\"104\":\"Staffing and Recruiting\",\"105\":\"Professional Training and Coaching\",\"106\":\"Venture Capital and Private Equity Principals\",\"107\":\"Political Organizations\",\"108\":\"Translation and Localization\",\"109\":\"Computer Games\",\"110\":\"Events Services\",\"111\":\"Retail Art Supplies\",\"112\":\"Appliances, Electrical, and Electronics Manufacturing\",\"113\":\"Online Audio and Video Media\",\"114\":\"Nanotechnology Research\",\"115\":\"Musicians\",\"116\":\"Transportation, Logistics, Supply Chain and Storage\",\"117\":\"Plastics Manufacturing\",\"118\":\"Computer and Network Security\",\"119\":\"Wireless Services\",\"120\":\"Alternative Dispute Resolution\",\"121\":\"Security and Investigations\",\"122\":\"Facilities Services\",\"123\":\"Outsourcing and Offshoring Consulting\",\"124\":\"Wellness and Fitness Services\",\"125\":\"Alternative Medicine\",\"126\":\"Media Production\",\"127\":\"Animation and Post-production\",\"128\":\"Leasing Non-residential Real Estate\",\"129\":\"Capital Markets\",\"130\":\"Think Tanks\",\"131\":\"Philanthropic Fundraising Services\",\"132\":\"E-Learning Providers\",\"133\":\"Wholesale\",\"134\":\"Wholesale Import and Export\",\"135\":\"Industrial Machinery Manufacturing\",\"136\":\"Photography\",\"137\":\"Human Resources Services\",\"138\":\"Retail Office Equipment\",\"139\":\"Mental Health Care\",\"140\":\"Graphic Design\",\"141\":\"International Trade and Development\",\"142\":\"Beverage Manufacturing\",\"143\":\"Retail Luxury Goods and Jewelry\",\"144\":\"Renewable Energy Semiconductor Manufacturing\",\"145\":\"Glass, Ceramics and Concrete Manufacturing\",\"146\":\"Packaging and Containers Manufacturing\",\"147\":\"Automation Machinery Manufacturing\",\"148\":\"Government Relations Services\",\"150\":\"Horticulture\",\"201\":\"Farming, Ranching, Forestry\",\"256\":\"Ranching and Fisheries\",\"298\":\"Forestry and Logging\",\"332\":\"Oil, Gas, and Mining\",\"341\":\"Coal Mining\",\"345\":\"Metal Ore Mining\",\"356\":\"Nonmetallic Mineral Mining\",\"382\":\"Electric Power Transmission, Control, and Distribution\",\"383\":\"Electric Power Generation\",\"384\":\"Hydroelectric Power Generation\",\"385\":\"Fossil Fuel Electric Power Generation\",\"386\":\"Nuclear Electric Power Generation\",\"387\":\"Solar Electric Power Generation\",\"388\":\"Environmental Quality Programs\",\"389\":\"Geothermal Electric Power Generation\",\"390\":\"Biomass Electric Power Generation\",\"397\":\"Natural Gas Distribution\",\"398\":\"Water, Waste, Steam, and Air Conditioning Services\",\"400\":\"Water Supply and Irrigation Systems\",\"404\":\"Steam and Air-Conditioning Supply\",\"406\":\"Building Construction\",\"408\":\"Residential Building Construction\",\"413\":\"Nonresidential Building Construction\",\"419\":\"Utility System Construction\",\"428\":\"Subdivision of Land\",\"431\":\"Highway, Street, and Bridge Construction\",\"435\":\"Specialty Trade Contractors\",\"436\":\"Building Structure and Exterior Contractors\",\"453\":\"Building Equipment Contractors\",\"460\":\"Building Finishing Contractors\",\"481\":\"Animal Feed Manufacturing\",\"495\":\"Sugar and Confectionery Product Manufacturing\",\"504\":\"Fruit and Vegetable Preserves Manufacturing\",\"521\":\"Meat Products Manufacturing\",\"528\":\"Seafood Product Manufacturing\",\"529\":\"Baked Goods Manufacturing\",\"562\":\"Breweries\",\"564\":\"Distilleries\",\"598\":\"Apparel Manufacturing\",\"615\":\"Fashion Accessories Manufacturing\",\"616\":\"Leather Product Manufacturing\",\"622\":\"Footwear Manufacturing\",\"625\":\"Women&#39;s Handbag Manufacturing\",\"679\":\"Oil and Coal Product Manufacturing\",\"690\":\"Chemical Raw Materials Manufacturing\",\"703\":\"Artificial Rubber and Synthetic Fiber Manufacturing\",\"709\":\"Agricultural Chemical Manufacturing\",\"722\":\"Paint, Coating, and Adhesive Manufacturing\",\"727\":\"Soap and Cleaning Product Manufacturing\",\"743\":\"Plastics and Rubber Product Manufacturing\",\"763\":\"Rubber Products Manufacturing\",\"773\":\"Clay and Refractory Products Manufacturing\",\"779\":\"Glass Product Manufacturing\",\"784\":\"Wood Product Manufacturing\",\"794\":\"Lime and Gypsum Products Manufacturing\",\"799\":\"Abrasives and Nonmetallic Minerals Manufacturing\",\"807\":\"Primary Metal Manufacturing\",\"840\":\"Fabricated Metal Products\",\"849\":\"Cutlery and Handtool Manufacturing\",\"852\":\"Architectural and Structural Metal Manufacturing\",\"861\":\"Boilers, Tanks, and Shipping Container Manufacturing\",\"871\":\"Construction Hardware Manufacturing\",\"873\":\"Spring and Wire Product Manufacturing\",\"876\":\"Turned Products and Fastener Manufacturing\",\"883\":\"Metal Treatments\",\"887\":\"Metal Valve, Ball, and Roller Manufacturing\",\"901\":\"Agriculture, Construction, Mining Machinery Manufacturing\",\"918\":\"Commercial and Service Industry Machinery Manufacturing\",\"923\":\"HVAC and Refrigeration Equipment Manufacturing\",\"928\":\"Metalworking Machinery Manufacturing\",\"935\":\"Engines and Power Transmission Equipment Manufacturing\",\"964\":\"Communications Equipment Manufacturing\",\"973\":\"Audio and Video Equipment Manufacturing\",\"983\":\"Measuring and Control Instrument Manufacturing\",\"994\":\"Magnetic and Optical Media Manufacturing\",\"998\":\"Electric Lighting Equipment Manufacturing\",\"1005\":\"Household Appliance Manufacturing\",\"1029\":\"Transportation Equipment Manufacturing\",\"1042\":\"Motor Vehicle Parts Manufacturing\",\"1080\":\"Household and Institutional Furniture Manufacturing\",\"1090\":\"Office Furniture and Fixtures Manufacturing\",\"1095\":\"Mattress and Blinds Manufacturing\",\"1128\":\"Wholesale Motor Vehicles and Parts\",\"1137\":\"Wholesale Furniture and Home Furnishings\",\"1153\":\"Wholesale Photography Equipment and Supplies\",\"1157\":\"Wholesale Computer Equipment\",\"1166\":\"Wholesale Metals and Minerals\",\"1171\":\"Wholesale Appliances, Electrical, and Electronics\",\"1178\":\"Wholesale Hardware, Plumbing, Heating Equipment\",\"1187\":\"Wholesale Machinery\",\"1206\":\"Wholesale Recyclable Materials\",\"1208\":\"Wholesale Luxury Goods and Jewelry\",\"1212\":\"Wholesale Paper Products\",\"1221\":\"Wholesale Drugs and Sundries\",\"1222\":\"Wholesale Apparel and Sewing Supplies\",\"1230\":\"Wholesale Footwear\",\"1231\":\"Wholesale Food and Beverage\",\"1250\":\"Wholesale Raw Farm Products\",\"1257\":\"Wholesale Chemical and Allied Products\",\"1262\":\"Wholesale Petroleum and Petroleum Products\",\"1267\":\"Wholesale Alcoholic Beverages\",\"1285\":\"Internet Marketplace Platforms\",\"1292\":\"Retail Motor Vehicles\",\"1309\":\"Retail Furniture and Home Furnishings\",\"1319\":\"Retail Appliances, Electrical, and Electronic Equipment\",\"1324\":\"Retail Building Materials and Garden Equipment\",\"1339\":\"Food and Beverage Retail\",\"1359\":\"Retail Health and Personal Care Products\",\"1370\":\"Retail Gasoline\",\"1407\":\"Retail Musical Instruments\",\"1409\":\"Retail Books and Printed News\",\"1423\":\"Retail Florists\",\"1424\":\"Retail Office Supplies and Gifts\",\"1431\":\"Retail Recyclable Materials &amp; Used Merchandise\",\"1445\":\"Online and Mail Order Retail\",\"1481\":\"Rail Transportation\",\"1495\":\"Ground Passenger Transportation\",\"1497\":\"Urban Transit Services\",\"1504\":\"Interurban and Rural Bus Services\",\"1505\":\"Taxi and Limousine Services\",\"1512\":\"School and Employee Bus Services\",\"1517\":\"Shuttles and Special Needs Transportation Services\",\"1520\":\"Pipeline Transportation\",\"1532\":\"Sightseeing Transportation\",\"1573\":\"Postal Services\",\"1594\":\"Technology, Information and Media\",\"1600\":\"Periodical Publishing\",\"1602\":\"Book Publishing\",\"1611\":\"Movies and Sound Recording\",\"1623\":\"Sound Recording\",\"1625\":\"Sheet Music Publishing\",\"1633\":\"Radio and Television Broadcasting\",\"1641\":\"Cable and Satellite Programming\",\"1644\":\"Telecommunications Carriers\",\"1649\":\"Satellite Telecommunications\",\"1673\":\"Credit Intermediation\",\"1678\":\"Savings Institutions\",\"1696\":\"Loan Brokers\",\"1713\":\"Securities and Commodity Exchanges\",\"1720\":\"Investment Advice\",\"1725\":\"Insurance Carriers\",\"1737\":\"Insurance Agencies and Brokerages\",\"1738\":\"Claims Adjusting, Actuarial Services\",\"1742\":\"Funds and Trusts\",\"1743\":\"Insurance and Employee Benefit Funds\",\"1745\":\"Pension Funds\",\"1750\":\"Trusts and Estates\",\"1757\":\"Real Estate and Equipment Rental Services\",\"1759\":\"Leasing Residential Real Estate\",\"1770\":\"Real Estate Agents and Brokers\",\"1779\":\"Equipment Rental Services\",\"1786\":\"Consumer Goods Rental\",\"1798\":\"Commercial and Industrial Equipment Rental\",\"1810\":\"Professional Services\",\"1855\":\"IT System Design Services\",\"1862\":\"Marketing Services\",\"1905\":\"Holding Companies\",\"1909\":\"Industry Associations\",\"1911\":\"Professional Organizations\",\"1912\":\"Administrative and Support Services\",\"1916\":\"Office Administration\",\"1923\":\"Executive Search Services\",\"1925\":\"Temporary Help Services\",\"1931\":\"Telephone Call Centers\",\"1938\":\"Collection Agencies\",\"1956\":\"Security Guards and Patrol Services\",\"1958\":\"Security Systems Services\",\"1965\":\"Janitorial Services\",\"1981\":\"Waste Collection\",\"1986\":\"Waste Treatment and Disposal\",\"1999\":\"Education\",\"2012\":\"Secretarial Schools\",\"2018\":\"Technical and Vocational Training\",\"2019\":\"Cosmetology and Barber Schools\",\"2020\":\"Flight Training\",\"2025\":\"Fine Arts Schools\",\"2027\":\"Sports and Recreation Instruction\",\"2029\":\"Language Schools\",\"2040\":\"Physicians\",\"2045\":\"Dentists\",\"2050\":\"Optometrists\",\"2054\":\"Physical, Occupational and Speech Therapists\",\"2060\":\"Family Planning Centers\",\"2063\":\"Outpatient Care Centers\",\"2069\":\"Medical and Diagnostic Laboratories\",\"2074\":\"Home Health Care Services\",\"2077\":\"Ambulance Services\",\"2081\":\"Hospitals\",\"2091\":\"Nursing Homes and Residential Care Facilities\",\"2112\":\"Services for the Elderly and Disabled\",\"2115\":\"Community Services\",\"2122\":\"Emergency and Relief Services\",\"2125\":\"Vocational Rehabilitation Services\",\"2128\":\"Child Day Care Services\",\"2130\":\"Performing Arts and Spectator Sports\",\"2133\":\"Theater Companies\",\"2135\":\"Dance Companies\",\"2139\":\"Circuses and Magic Shows\",\"2142\":\"Sports Teams and Clubs\",\"2143\":\"Racetracks\",\"2159\":\"Museums\",\"2161\":\"Historical Sites\",\"2163\":\"Zoos and Botanical Gardens\",\"2167\":\"Amusement Parks and Arcades\",\"2179\":\"Golf Courses and Country Clubs\",\"2181\":\"Skiing Facilities\",\"2190\":\"Accommodation and Food Services\",\"2194\":\"Hotels and Motels\",\"2197\":\"Bed-and-Breakfasts, Hostels, Homestays\",\"2212\":\"Caterers\",\"2214\":\"Mobile Food Services\",\"2217\":\"Bars, Taverns, and Nightclubs\",\"2225\":\"Repair and Maintenance\",\"2226\":\"Vehicle Repair and Maintenance\",\"2240\":\"Electronic and Precision Equipment Maintenance\",\"2247\":\"Commercial and Industrial Machinery Maintenance\",\"2253\":\"Reupholstery and Furniture Repair\",\"2255\":\"Footwear and Leather Goods Repair\",\"2258\":\"Personal and Laundry Services\",\"2259\":\"Personal Care Services\",\"2272\":\"Laundry and Drycleaning Services\",\"2282\":\"Pet Services\",\"2318\":\"Household Services\",\"2353\":\"Health and Human Services\",\"2358\":\"Public Health\",\"2360\":\"Public Assistance Programs\",\"2366\":\"Air, Water, and Waste Program Management\",\"2368\":\"Conservation Programs\",\"2369\":\"Housing and Community Development\",\"2374\":\"Community Development and Urban Planning\",\"2375\":\"Economic Programs\",\"2391\":\"Military and International Affairs\",\"2401\":\"Operations Consulting\",\"2458\":\"Data Infrastructure and Analytics\",\"2468\":\"Electrical Equipment Manufacturing\",\"2489\":\"Wind Electric Power Generation\",\"2500\":\"Wineries\",\"2934\":\"Landscaping Services\",\"3065\":\"Courts of Law\",\"3068\":\"Correctional Institutions\",\"3070\":\"Fire Protection\",\"3081\":\"Housing Programs\",\"3085\":\"Transportation Programs\",\"3086\":\"Utilities Administration\",\"3089\":\"Space Research and Technology\",\"3095\":\"Oil Extraction\",\"3096\":\"Natural Gas Extraction\",\"3099\":\"Embedded Software Products\",\"3100\":\"Mobile Computing Software Products\",\"3101\":\"Desktop Computing Software Products\",\"3102\":\"IT System Custom Software Development\",\"3103\":\"IT System Operations and Maintenance\",\"3104\":\"IT System Installation and Disposal\",\"3105\":\"IT System Training and Support\",\"3106\":\"IT System Data Services\",\"3107\":\"IT System Testing and Evaluation\",\"3124\":\"Internet News\",\"3125\":\"Blogs\",\"3126\":\"Interior Design\",\"3127\":\"Social Networking Platforms\",\"3128\":\"Business Intelligence Platforms\",\"3129\":\"Business Content\",\"3130\":\"Data Security Software Products\",\"3131\":\"Mobile Gaming Apps\",\"3132\":\"Internet Publishing\",\"3133\":\"Media and Telecommunications\",\"3134\":\"Blockchain Services\",\"3186\":\"Retail Art Dealers\",\"3240\":\"Renewable Energy Power Generation\",\"3241\":\"Renewable Energy Equipment Manufacturing\",\"3242\":\"Engineering Services\",\"3243\":\"Services for Renewable Energy\",\"3244\":\"Digital Accessibility Services\",\"3245\":\"Accessible Hardware Manufacturing\",\"3246\":\"Accessible Architecture and Design\",\"3247\":\"Robot Manufacturing\",\"3248\":\"Robotics Engineering\",\"3249\":\"Surveying and Mapping Services\",\"3250\":\"Retail Pharmacies\",\"3251\":\"Climate Technology Product Manufacturing\",\"3252\":\"Climate Data and Analytics\",\"3253\":\"Alternative Fuel Vehicle Manufacturing\",\"3254\":\"Smart Meter Manufacturing\",\"3255\":\"Fuel Cell Manufacturing\",\"3256\":\"Regenerative Design\"}","type":"array","items":{"type":"integer"}},"current_company":{"type":"string","nullable":true}},"type":"object"},"GenerateSalesNavigatorPeoplesSearch":{"properties":{"current_titles":{"type":"array","items":{"type":"string"}},"current_titles_exclude":{"type":"array","items":{"type":"string"}},"company_head_counts":{"type":"array","items":{"$ref":"#\/components\/schemas\/CompanyHeadCount"}},"locations":{"description":"Some example values :\n        France\t105015875<br>\n        USA\t103644278<br>\n        UK\t101165590<br>\n        Germany\t101282230<br>\n        Italie\t103350119<br>\n        Suisse\t106693272<br>\n        Luxembourg\t104042105<br>\n        Belgique\t100565514<br>\n        Pays Bas\t102890719<br>\n        Espagne\t105646813<br>\n        Maroc\t102787409<br>\n        Auvergne-Rh\u00f4ne-Alpes\t103623254<br>\n        Bourgogne-Franche-Comt\u00e9\t103286073<br>\n        Bretagne\t103737322<br>\n        Centre-Val de Loire\t102215960<br>\n        Corse\t106926833<br>\n        Grand Est\t101735443<br>\n        Hauts-de-France\t105007536<br>\n        Ile-de-France\t104246759<br>\n        Normandie\t104433326<br>\n        Nouvelle-Aquitaine\t105563475<br>\n        Occitanie\t103876217<br>\n        Pays de la Loire\t104731846<br>\n        Provence Alpes C\u00f4te d\u2019Azur\t102203735","type":"array","items":{"type":"integer"}},"locations_exclude":{"type":"array","items":{"type":"integer"}},"industries":{"description":"Possible values: {\"1\":\"Defense and Space Manufacturing\",\"3\":\"Computer Hardware Manufacturing\",\"4\":\"Software Development\",\"5\":\"Computer Networking Products\",\"6\":\"Technology, Information and Internet\",\"7\":\"Semiconductor Manufacturing\",\"8\":\"Telecommunications\",\"9\":\"Law Practice\",\"10\":\"Legal Services\",\"11\":\"Business Consulting and Services\",\"12\":\"Biotechnology Research\",\"13\":\"Medical Practices\",\"14\":\"Hospitals and Health Care\",\"15\":\"Pharmaceutical Manufacturing\",\"16\":\"Veterinary Services\",\"17\":\"Medical Equipment Manufacturing\",\"18\":\"Personal Care Product Manufacturing\",\"19\":\"Retail Apparel and Fashion\",\"20\":\"Sporting Goods Manufacturing\",\"21\":\"Tobacco Manufacturing\",\"22\":\"Retail Groceries\",\"23\":\"Food and Beverage Manufacturing\",\"24\":\"Computers and Electronics Manufacturing\",\"25\":\"Manufacturing\",\"26\":\"Furniture and Home Furnishings Manufacturing\",\"27\":\"Retail\",\"28\":\"Entertainment Providers\",\"29\":\"Gambling Facilities and Casinos\",\"30\":\"Travel Arrangements\",\"31\":\"Hospitality\",\"32\":\"Restaurants\",\"33\":\"Spectator Sports\",\"34\":\"Food and Beverage Services\",\"35\":\"Movies, Videos, and Sound\",\"36\":\"Broadcast Media Production and Distribution\",\"37\":\"Museums, Historical Sites, and Zoos\",\"38\":\"Artists and Writers\",\"39\":\"Performing Arts\",\"40\":\"Recreational Facilities\",\"41\":\"Banking\",\"42\":\"Insurance\",\"43\":\"Financial Services\",\"44\":\"Real Estate\",\"45\":\"Investment Banking\",\"46\":\"Investment Management\",\"47\":\"Accounting\",\"48\":\"Construction\",\"49\":\"Wholesale Building Materials\",\"50\":\"Architecture and Planning\",\"51\":\"Civil Engineering\",\"52\":\"Aviation and Aerospace Component Manufacturing\",\"53\":\"Motor Vehicle Manufacturing\",\"54\":\"Chemical Manufacturing\",\"55\":\"Machinery Manufacturing\",\"56\":\"Mining\",\"57\":\"Oil and Gas\",\"58\":\"Shipbuilding\",\"59\":\"Utilities\",\"60\":\"Textile Manufacturing\",\"61\":\"Paper and Forest Product Manufacturing\",\"62\":\"Railroad Equipment Manufacturing\",\"63\":\"Farming\",\"64\":\"Ranching\",\"65\":\"Dairy Product Manufacturing\",\"66\":\"Fisheries\",\"67\":\"Primary and Secondary Education\",\"68\":\"Higher Education\",\"69\":\"Education Administration Programs\",\"70\":\"Research Services\",\"71\":\"Armed Forces\",\"72\":\"Legislative Offices\",\"73\":\"Administration of Justice\",\"74\":\"International Affairs\",\"75\":\"Government Administration\",\"76\":\"Executive Offices\",\"77\":\"Law Enforcement\",\"78\":\"Public Safety\",\"79\":\"Public Policy Offices\",\"80\":\"Advertising Services\",\"81\":\"Newspaper Publishing\",\"82\":\"Book and Periodical Publishing\",\"83\":\"Printing Services\",\"84\":\"Information Services\",\"85\":\"Libraries\",\"86\":\"Environmental Services\",\"87\":\"Freight and Package Transportation\",\"88\":\"Individual and Family Services\",\"89\":\"Religious Institutions\",\"90\":\"Civic and Social Organizations\",\"91\":\"Consumer Services\",\"92\":\"Truck Transportation\",\"93\":\"Warehousing and Storage\",\"94\":\"Airlines and Aviation\",\"95\":\"Maritime Transportation\",\"96\":\"IT Services and IT Consulting\",\"97\":\"Market Research\",\"98\":\"Public Relations and Communications Services\",\"99\":\"Design Services\",\"100\":\"Non-profit Organizations\",\"101\":\"Fundraising\",\"102\":\"Strategic Management Services\",\"103\":\"Writing and Editing\",\"104\":\"Staffing and Recruiting\",\"105\":\"Professional Training and Coaching\",\"106\":\"Venture Capital and Private Equity Principals\",\"107\":\"Political Organizations\",\"108\":\"Translation and Localization\",\"109\":\"Computer Games\",\"110\":\"Events Services\",\"111\":\"Retail Art Supplies\",\"112\":\"Appliances, Electrical, and Electronics Manufacturing\",\"113\":\"Online Audio and Video Media\",\"114\":\"Nanotechnology Research\",\"115\":\"Musicians\",\"116\":\"Transportation, Logistics, Supply Chain and Storage\",\"117\":\"Plastics Manufacturing\",\"118\":\"Computer and Network Security\",\"119\":\"Wireless Services\",\"120\":\"Alternative Dispute Resolution\",\"121\":\"Security and Investigations\",\"122\":\"Facilities Services\",\"123\":\"Outsourcing and Offshoring Consulting\",\"124\":\"Wellness and Fitness Services\",\"125\":\"Alternative Medicine\",\"126\":\"Media Production\",\"127\":\"Animation and Post-production\",\"128\":\"Leasing Non-residential Real Estate\",\"129\":\"Capital Markets\",\"130\":\"Think Tanks\",\"131\":\"Philanthropic Fundraising Services\",\"132\":\"E-Learning Providers\",\"133\":\"Wholesale\",\"134\":\"Wholesale Import and Export\",\"135\":\"Industrial Machinery Manufacturing\",\"136\":\"Photography\",\"137\":\"Human Resources Services\",\"138\":\"Retail Office Equipment\",\"139\":\"Mental Health Care\",\"140\":\"Graphic Design\",\"141\":\"International Trade and Development\",\"142\":\"Beverage Manufacturing\",\"143\":\"Retail Luxury Goods and Jewelry\",\"144\":\"Renewable Energy Semiconductor Manufacturing\",\"145\":\"Glass, Ceramics and Concrete Manufacturing\",\"146\":\"Packaging and Containers Manufacturing\",\"147\":\"Automation Machinery Manufacturing\",\"148\":\"Government Relations Services\",\"150\":\"Horticulture\",\"201\":\"Farming, Ranching, Forestry\",\"256\":\"Ranching and Fisheries\",\"298\":\"Forestry and Logging\",\"332\":\"Oil, Gas, and Mining\",\"341\":\"Coal Mining\",\"345\":\"Metal Ore Mining\",\"356\":\"Nonmetallic Mineral Mining\",\"382\":\"Electric Power Transmission, Control, and Distribution\",\"383\":\"Electric Power Generation\",\"384\":\"Hydroelectric Power Generation\",\"385\":\"Fossil Fuel Electric Power Generation\",\"386\":\"Nuclear Electric Power Generation\",\"387\":\"Solar Electric Power Generation\",\"388\":\"Environmental Quality Programs\",\"389\":\"Geothermal Electric Power Generation\",\"390\":\"Biomass Electric Power Generation\",\"397\":\"Natural Gas Distribution\",\"398\":\"Water, Waste, Steam, and Air Conditioning Services\",\"400\":\"Water Supply and Irrigation Systems\",\"404\":\"Steam and Air-Conditioning Supply\",\"406\":\"Building Construction\",\"408\":\"Residential Building Construction\",\"413\":\"Nonresidential Building Construction\",\"419\":\"Utility System Construction\",\"428\":\"Subdivision of Land\",\"431\":\"Highway, Street, and Bridge Construction\",\"435\":\"Specialty Trade Contractors\",\"436\":\"Building Structure and Exterior Contractors\",\"453\":\"Building Equipment Contractors\",\"460\":\"Building Finishing Contractors\",\"481\":\"Animal Feed Manufacturing\",\"495\":\"Sugar and Confectionery Product Manufacturing\",\"504\":\"Fruit and Vegetable Preserves Manufacturing\",\"521\":\"Meat Products Manufacturing\",\"528\":\"Seafood Product Manufacturing\",\"529\":\"Baked Goods Manufacturing\",\"562\":\"Breweries\",\"564\":\"Distilleries\",\"598\":\"Apparel Manufacturing\",\"615\":\"Fashion Accessories Manufacturing\",\"616\":\"Leather Product Manufacturing\",\"622\":\"Footwear Manufacturing\",\"625\":\"Women&#39;s Handbag Manufacturing\",\"679\":\"Oil and Coal Product Manufacturing\",\"690\":\"Chemical Raw Materials Manufacturing\",\"703\":\"Artificial Rubber and Synthetic Fiber Manufacturing\",\"709\":\"Agricultural Chemical Manufacturing\",\"722\":\"Paint, Coating, and Adhesive Manufacturing\",\"727\":\"Soap and Cleaning Product Manufacturing\",\"743\":\"Plastics and Rubber Product Manufacturing\",\"763\":\"Rubber Products Manufacturing\",\"773\":\"Clay and Refractory Products Manufacturing\",\"779\":\"Glass Product Manufacturing\",\"784\":\"Wood Product Manufacturing\",\"794\":\"Lime and Gypsum Products Manufacturing\",\"799\":\"Abrasives and Nonmetallic Minerals Manufacturing\",\"807\":\"Primary Metal Manufacturing\",\"840\":\"Fabricated Metal Products\",\"849\":\"Cutlery and Handtool Manufacturing\",\"852\":\"Architectural and Structural Metal Manufacturing\",\"861\":\"Boilers, Tanks, and Shipping Container Manufacturing\",\"871\":\"Construction Hardware Manufacturing\",\"873\":\"Spring and Wire Product Manufacturing\",\"876\":\"Turned Products and Fastener Manufacturing\",\"883\":\"Metal Treatments\",\"887\":\"Metal Valve, Ball, and Roller Manufacturing\",\"901\":\"Agriculture, Construction, Mining Machinery Manufacturing\",\"918\":\"Commercial and Service Industry Machinery Manufacturing\",\"923\":\"HVAC and Refrigeration Equipment Manufacturing\",\"928\":\"Metalworking Machinery Manufacturing\",\"935\":\"Engines and Power Transmission Equipment Manufacturing\",\"964\":\"Communications Equipment Manufacturing\",\"973\":\"Audio and Video Equipment Manufacturing\",\"983\":\"Measuring and Control Instrument Manufacturing\",\"994\":\"Magnetic and Optical Media Manufacturing\",\"998\":\"Electric Lighting Equipment Manufacturing\",\"1005\":\"Household Appliance Manufacturing\",\"1029\":\"Transportation Equipment Manufacturing\",\"1042\":\"Motor Vehicle Parts Manufacturing\",\"1080\":\"Household and Institutional Furniture Manufacturing\",\"1090\":\"Office Furniture and Fixtures Manufacturing\",\"1095\":\"Mattress and Blinds Manufacturing\",\"1128\":\"Wholesale Motor Vehicles and Parts\",\"1137\":\"Wholesale Furniture and Home Furnishings\",\"1153\":\"Wholesale Photography Equipment and Supplies\",\"1157\":\"Wholesale Computer Equipment\",\"1166\":\"Wholesale Metals and Minerals\",\"1171\":\"Wholesale Appliances, Electrical, and Electronics\",\"1178\":\"Wholesale Hardware, Plumbing, Heating Equipment\",\"1187\":\"Wholesale Machinery\",\"1206\":\"Wholesale Recyclable Materials\",\"1208\":\"Wholesale Luxury Goods and Jewelry\",\"1212\":\"Wholesale Paper Products\",\"1221\":\"Wholesale Drugs and Sundries\",\"1222\":\"Wholesale Apparel and Sewing Supplies\",\"1230\":\"Wholesale Footwear\",\"1231\":\"Wholesale Food and Beverage\",\"1250\":\"Wholesale Raw Farm Products\",\"1257\":\"Wholesale Chemical and Allied Products\",\"1262\":\"Wholesale Petroleum and Petroleum Products\",\"1267\":\"Wholesale Alcoholic Beverages\",\"1285\":\"Internet Marketplace Platforms\",\"1292\":\"Retail Motor Vehicles\",\"1309\":\"Retail Furniture and Home Furnishings\",\"1319\":\"Retail Appliances, Electrical, and Electronic Equipment\",\"1324\":\"Retail Building Materials and Garden Equipment\",\"1339\":\"Food and Beverage Retail\",\"1359\":\"Retail Health and Personal Care Products\",\"1370\":\"Retail Gasoline\",\"1407\":\"Retail Musical Instruments\",\"1409\":\"Retail Books and Printed News\",\"1423\":\"Retail Florists\",\"1424\":\"Retail Office Supplies and Gifts\",\"1431\":\"Retail Recyclable Materials &amp; Used Merchandise\",\"1445\":\"Online and Mail Order Retail\",\"1481\":\"Rail Transportation\",\"1495\":\"Ground Passenger Transportation\",\"1497\":\"Urban Transit Services\",\"1504\":\"Interurban and Rural Bus Services\",\"1505\":\"Taxi and Limousine Services\",\"1512\":\"School and Employee Bus Services\",\"1517\":\"Shuttles and Special Needs Transportation Services\",\"1520\":\"Pipeline Transportation\",\"1532\":\"Sightseeing Transportation\",\"1573\":\"Postal Services\",\"1594\":\"Technology, Information and Media\",\"1600\":\"Periodical Publishing\",\"1602\":\"Book Publishing\",\"1611\":\"Movies and Sound Recording\",\"1623\":\"Sound Recording\",\"1625\":\"Sheet Music Publishing\",\"1633\":\"Radio and Television Broadcasting\",\"1641\":\"Cable and Satellite Programming\",\"1644\":\"Telecommunications Carriers\",\"1649\":\"Satellite Telecommunications\",\"1673\":\"Credit Intermediation\",\"1678\":\"Savings Institutions\",\"1696\":\"Loan Brokers\",\"1713\":\"Securities and Commodity Exchanges\",\"1720\":\"Investment Advice\",\"1725\":\"Insurance Carriers\",\"1737\":\"Insurance Agencies and Brokerages\",\"1738\":\"Claims Adjusting, Actuarial Services\",\"1742\":\"Funds and Trusts\",\"1743\":\"Insurance and Employee Benefit Funds\",\"1745\":\"Pension Funds\",\"1750\":\"Trusts and Estates\",\"1757\":\"Real Estate and Equipment Rental Services\",\"1759\":\"Leasing Residential Real Estate\",\"1770\":\"Real Estate Agents and Brokers\",\"1779\":\"Equipment Rental Services\",\"1786\":\"Consumer Goods Rental\",\"1798\":\"Commercial and Industrial Equipment Rental\",\"1810\":\"Professional Services\",\"1855\":\"IT System Design Services\",\"1862\":\"Marketing Services\",\"1905\":\"Holding Companies\",\"1909\":\"Industry Associations\",\"1911\":\"Professional Organizations\",\"1912\":\"Administrative and Support Services\",\"1916\":\"Office Administration\",\"1923\":\"Executive Search Services\",\"1925\":\"Temporary Help Services\",\"1931\":\"Telephone Call Centers\",\"1938\":\"Collection Agencies\",\"1956\":\"Security Guards and Patrol Services\",\"1958\":\"Security Systems Services\",\"1965\":\"Janitorial Services\",\"1981\":\"Waste Collection\",\"1986\":\"Waste Treatment and Disposal\",\"1999\":\"Education\",\"2012\":\"Secretarial Schools\",\"2018\":\"Technical and Vocational Training\",\"2019\":\"Cosmetology and Barber Schools\",\"2020\":\"Flight Training\",\"2025\":\"Fine Arts Schools\",\"2027\":\"Sports and Recreation Instruction\",\"2029\":\"Language Schools\",\"2040\":\"Physicians\",\"2045\":\"Dentists\",\"2050\":\"Optometrists\",\"2054\":\"Physical, Occupational and Speech Therapists\",\"2060\":\"Family Planning Centers\",\"2063\":\"Outpatient Care Centers\",\"2069\":\"Medical and Diagnostic Laboratories\",\"2074\":\"Home Health Care Services\",\"2077\":\"Ambulance Services\",\"2081\":\"Hospitals\",\"2091\":\"Nursing Homes and Residential Care Facilities\",\"2112\":\"Services for the Elderly and Disabled\",\"2115\":\"Community Services\",\"2122\":\"Emergency and Relief Services\",\"2125\":\"Vocational Rehabilitation Services\",\"2128\":\"Child Day Care Services\",\"2130\":\"Performing Arts and Spectator Sports\",\"2133\":\"Theater Companies\",\"2135\":\"Dance Companies\",\"2139\":\"Circuses and Magic Shows\",\"2142\":\"Sports Teams and Clubs\",\"2143\":\"Racetracks\",\"2159\":\"Museums\",\"2161\":\"Historical Sites\",\"2163\":\"Zoos and Botanical Gardens\",\"2167\":\"Amusement Parks and Arcades\",\"2179\":\"Golf Courses and Country Clubs\",\"2181\":\"Skiing Facilities\",\"2190\":\"Accommodation and Food Services\",\"2194\":\"Hotels and Motels\",\"2197\":\"Bed-and-Breakfasts, Hostels, Homestays\",\"2212\":\"Caterers\",\"2214\":\"Mobile Food Services\",\"2217\":\"Bars, Taverns, and Nightclubs\",\"2225\":\"Repair and Maintenance\",\"2226\":\"Vehicle Repair and Maintenance\",\"2240\":\"Electronic and Precision Equipment Maintenance\",\"2247\":\"Commercial and Industrial Machinery Maintenance\",\"2253\":\"Reupholstery and Furniture Repair\",\"2255\":\"Footwear and Leather Goods Repair\",\"2258\":\"Personal and Laundry Services\",\"2259\":\"Personal Care Services\",\"2272\":\"Laundry and Drycleaning Services\",\"2282\":\"Pet Services\",\"2318\":\"Household Services\",\"2353\":\"Health and Human Services\",\"2358\":\"Public Health\",\"2360\":\"Public Assistance Programs\",\"2366\":\"Air, Water, and Waste Program Management\",\"2368\":\"Conservation Programs\",\"2369\":\"Housing and Community Development\",\"2374\":\"Community Development and Urban Planning\",\"2375\":\"Economic Programs\",\"2391\":\"Military and International Affairs\",\"2401\":\"Operations Consulting\",\"2458\":\"Data Infrastructure and Analytics\",\"2468\":\"Electrical Equipment Manufacturing\",\"2489\":\"Wind Electric Power Generation\",\"2500\":\"Wineries\",\"2934\":\"Landscaping Services\",\"3065\":\"Courts of Law\",\"3068\":\"Correctional Institutions\",\"3070\":\"Fire Protection\",\"3081\":\"Housing Programs\",\"3085\":\"Transportation Programs\",\"3086\":\"Utilities Administration\",\"3089\":\"Space Research and Technology\",\"3095\":\"Oil Extraction\",\"3096\":\"Natural Gas Extraction\",\"3099\":\"Embedded Software Products\",\"3100\":\"Mobile Computing Software Products\",\"3101\":\"Desktop Computing Software Products\",\"3102\":\"IT System Custom Software Development\",\"3103\":\"IT System Operations and Maintenance\",\"3104\":\"IT System Installation and Disposal\",\"3105\":\"IT System Training and Support\",\"3106\":\"IT System Data Services\",\"3107\":\"IT System Testing and Evaluation\",\"3124\":\"Internet News\",\"3125\":\"Blogs\",\"3126\":\"Interior Design\",\"3127\":\"Social Networking Platforms\",\"3128\":\"Business Intelligence Platforms\",\"3129\":\"Business Content\",\"3130\":\"Data Security Software Products\",\"3131\":\"Mobile Gaming Apps\",\"3132\":\"Internet Publishing\",\"3133\":\"Media and Telecommunications\",\"3134\":\"Blockchain Services\",\"3186\":\"Retail Art Dealers\",\"3240\":\"Renewable Energy Power Generation\",\"3241\":\"Renewable Energy Equipment Manufacturing\",\"3242\":\"Engineering Services\",\"3243\":\"Services for Renewable Energy\",\"3244\":\"Digital Accessibility Services\",\"3245\":\"Accessible Hardware Manufacturing\",\"3246\":\"Accessible Architecture and Design\",\"3247\":\"Robot Manufacturing\",\"3248\":\"Robotics Engineering\",\"3249\":\"Surveying and Mapping Services\",\"3250\":\"Retail Pharmacies\",\"3251\":\"Climate Technology Product Manufacturing\",\"3252\":\"Climate Data and Analytics\",\"3253\":\"Alternative Fuel Vehicle Manufacturing\",\"3254\":\"Smart Meter Manufacturing\",\"3255\":\"Fuel Cell Manufacturing\",\"3256\":\"Regenerative Design\"}","type":"array","items":{"type":"integer"}},"industries_exclude":{"type":"array","items":{"type":"integer"}},"seniority_levels":{"type":"array","items":{"$ref":"#\/components\/schemas\/SeniorityLevel"}},"seniority_levels_exclude":{"type":"array","items":{"$ref":"#\/components\/schemas\/SeniorityLevel"}},"current_companies":{"type":"array","items":{"type":"string"}},"current_companies_exclude":{"type":"array","items":{"type":"string"}},"company_headquarters":{"description":"The values are the same as for locations","type":"array","items":{"type":"integer"}},"company_headquarters_exclude":{"type":"array","items":{"type":"integer"}},"recently_changed_job":{"type":"boolean","nullable":true},"posted_on_linkedin":{"type":"boolean","nullable":true},"in_the_news":{"type":"boolean","nullable":true}},"type":"object"},"CompanyHeadCount":{"type":"string","enum":["independant","1-10","11-50","51-200","201-500","501-1000","1001-5000","5001-10000","10001-above"]},"SeniorityLevel":{"type":"string","enum":["in_training","entry_level","senior","strategic","entry_level_manager","experienced_manager","director","vice_president","cxo","owner_partner"]},"Location":{"properties":{"id":{"type":"integer"},"name_fr":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true}},"type":"object"},"AdminTeamProfile":{"description":"Displays the team profile detail","required":["id","name","team_code","created_by","user_email"],"properties":{"id":{"type":"integer","example":1},"name":{"description":"Team name","type":"string","example":"ExempleTeam"},"team_code":{"type":"string","example":"abc123"},"created_by":{"description":"User ID of the team creator","type":"integer","example":"1","nullable":true},"user_email":{"description":"User email of the team creator","type":"string","example":"me@domain.ext","nullable":true}},"type":"object"},"TeamLevel":{"description":"Level of the user","type":"string","enum":["user","admin"]},"TeamProfile":{"description":"Displays the team profile detail (Show only values accessible with your level)","required":["id","name","team_code","number_of_users","user_level","user_role","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My team"},"team_code":{"type":"string","example":"abc123"},"number_of_users":{"type":"integer","example":1},"user_level":{"oneOf":[{"$ref":"#\/components\/schemas\/Level"}],"nullable":true},"user_role":{"oneOf":[{"$ref":"#\/components\/schemas\/RoleUser"}],"nullable":true},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"Messages":{"description":"Displays transactionnal messages","required":["name","language","subject","content"],"properties":{"reseller_id":{"type":"integer","example":1,"nullable":true},"name":{"$ref":"#\/components\/schemas\/TransactionnalName"},"language":{"type":"string","example":"ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG"},"subject":{"type":"string","example":"Your password reset code"},"content":{"type":"string","example":"Hello, here is the code to reset your password : {resetCode}"}},"type":"object"},"TransactionnalName":{"type":"string","enum":["MailTestSmtpCredentials","MailValidationMassMailing","MailValidationMail","MailDisconnectedAPIEmailAccount","LinkedinDisconnected","OrganizationJoin","TeamJoin","PasswordResetEmail","AccountLocked","InviteUserOrganization","InviteUserTeam","PositiveReply","NeutralReply","NegativeReply","PrmColumnEntryInstant","PrmColumnEntryDailyDigest"]},"TutorialName":{"type":"string","enum":["HomeWelcomeDemo","HomeSenderEmailConnectDemo","HomeLinkedinAccountConnectDemo","HomeListCreationDemo","HomeTemplateCreationDemo","HomeCampaignCreationDemo","ListsScrapingSourcesTutorial","ListsScrapeLinkedinTutorial","ListsScrapeGoogleMapsTutorial","ListsScrapeLinkedinJobPostPublishersTutorial","ListsScrapeLinkedinLikersCommentersTutorial","ListsLinkedinScrapeLinkedinTutorial","ListsLinkedinScrapeJobPostPublishersTutorial","ListsLinkedinScrapingErrorTutorial","ListsManualImportTutorial","ListsGoogleMapsScrapeGoogleMapsTutorial","LeadsTrackingZapierMakeSyncTutorial","IntegrationOVHTutorial","IntegrationLinkedinConnectTutorial"]},"Video":{"description":"Displays reseller tutorial video link","required":["name","url"],"properties":{"reseller_id":{"type":"integer","example":1,"nullable":true},"name":{"$ref":"#\/components\/schemas\/TutorialName"},"url":{"type":"string","example":"https:\/\/videos.example.com\/tutorials\/home-welcome"},"thumbnail_url":{"type":"string","example":"https:\/\/files.example.com\/resellers\/image\/thumbnail.png","nullable":true}},"type":"object"},"URLShortenerBulkCreate":{"required":["urls"],"properties":{"urls":{"description":"URLs to shorten","type":"array","items":{"type":"string","example":"https:\/\/www.domaine.fr"},"maxItems":1000,"minItems":1}},"type":"object"},"URLShortenerBulkResultItem":{"required":["url","shortened_url"],"properties":{"url":{"type":"string","example":"https:\/\/www.domaine.fr"},"shortened_url":{"type":"string","example":"https:\/\/r.magileads.com\/AbC123"}},"type":"object"},"URLShortenerItem":{"required":["id","name","url","shortened_url","url_code","nb_clicks","from_sharing","sharing","created_by","permission","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My URL Shortener"},"url":{"type":"string"},"shortened_url":{"type":"string"},"url_code":{"type":"string"},"nb_clicks":{"type":"integer"},"from_sharing":{"description":"Whether or not someone is sharing you this URL Shortener","type":"boolean"},"sharing":{"description":"The sharing currently configured for this URL Shortener. Null if you are not the admin of this list","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this URL Shortener","type":"integer","example":1,"nullable":true},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"URLShortenerResultItem":{"required":["id","name","url","shortened_url","url_code","nb_clicks","from_sharing","read_permission","write_permission","delete_permission","created_by","sharing","created_on"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My URL Shortener"},"url":{"type":"string"},"shortened_url":{"type":"string"},"url_code":{"type":"string"},"nb_clicks":{"type":"integer"},"from_sharing":{"description":"Whether or not someone is sharing you this URL Shortener","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this URL Shortener","type":"integer","example":1,"nullable":true},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"ImportUnsubscribersDataResponse":{"required":["data_imported","data_already_existing"],"properties":{"data_imported":{"description":"Number of data imported","type":"integer","example":1},"data_already_existing":{"description":"Number of data not imported because it is already existing","type":"integer","example":1}},"type":"object"},"Unsubscriber":{"required":["id","value_type","value","organization_id","organization_name","created_by","created_on"],"properties":{"id":{"type":"integer","example":1},"value_type":{"$ref":"#\/components\/schemas\/UnsubscriberType"},"value":{"type":"string","example":"email@example.com"},"organization_id":{"type":"integer","example":1,"nullable":true},"organization_name":{"type":"string","example":"My organization"},"created_by":{"type":"integer","example":1,"nullable":true},"created_on":{"type":"string","format":"date-time"}},"type":"object"},"UnsubscriberType":{"type":"string","enum":["email","domain_email","linkedin_url","phone","siren","siret","naf_code","company"]},"ActionRequiredItem":{"required":["action","value"],"properties":{"action":{"$ref":"#\/components\/schemas\/TypeOfActionRequired"},"value":{"description":"Value of action required","type":"string","example":"5"}},"type":"object"},"DatafieldReplacement":{"properties":{"datafield_id":{"type":"integer","example":1},"replacement":{"type":"string","example":"My replacement text"}},"type":"object"},"DontShowValues":{"required":["step_delete","library_auto_show","sales_contacts_welcome","sales_companies_welcome","database_welcome","quick_search_welcome","linkedin_peoples_welcome","linkedin_likes_welcome","linkedin_comments_welcome","linkedin_jobs_welcome","linkedin_connections_welcome","manual_import_welcome"],"properties":{"step_delete":{"type":"boolean","nullable":true},"library_auto_show":{"type":"boolean","nullable":true},"sales_contacts_welcome":{"type":"boolean","nullable":true},"sales_companies_welcome":{"type":"boolean","nullable":true},"database_welcome":{"type":"boolean","nullable":true},"quick_search_welcome":{"type":"boolean","nullable":true},"linkedin_peoples_welcome":{"type":"boolean","nullable":true},"linkedin_likes_welcome":{"type":"boolean","nullable":true},"linkedin_comments_welcome":{"type":"boolean","nullable":true},"linkedin_jobs_welcome":{"type":"boolean","nullable":true},"linkedin_connections_welcome":{"type":"boolean","nullable":true},"manual_import_welcome":{"type":"boolean","nullable":true}},"type":"object"},"OauthRegisterOrLogin":{"properties":{"domain_saas":{"description":"Current access domain name (ex: saas.domain.ext)","type":"string","example":"saas.domain.ext"},"email_validation_url_success":{"description":"When the email validation is OK, then redirect the user to (email_validation_url_success)\n            If empty, then the user will be redirected to {SAAS_URL}\/email-validated","type":"string","example":"https:\/\/saas.domain.ext\/email-validation-success"},"email_validation_url_error":{"description":"When the email validation is ERROR, then redirect the user to (email_validation_url_error)\n            If empty, then the user will be redirected to {SAAS_URL}\/email-not-validated","type":"string","example":"https:\/\/saas.domain.ext\/email-validation-error"},"language":{"description":"Code of the user's preferred language - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"referred_user_id":{"description":"Referring user ID","type":"integer","example":"1","nullable":true},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"team_codes":{"description":"List of invitation codes to join a team, if you have","type":"array","items":{"type":"string"},"nullable":true},"organization_codes":{"description":"List of invitation codes to join an organization, if you have","type":"array","items":{"type":"string"},"nullable":true},"show_onboarding":{"type":"boolean","nullable":true,"default":true},"send_email":{"description":"Send email to validate account","type":"boolean","nullable":true,"default":true}},"type":"object"},"PRMScoring":{"description":"Put null for default value","properties":{"link_click":{"type":"integer","nullable":true},"link_click_specific_link":{"description":"Different score when clicking on specific link","type":"object","nullable":true,"additionalProperties":{"description":"Hashmap of urls with the score","type":"integer","format":"int16"}},"open":{"type":"integer","nullable":true},"answer":{"type":"integer","nullable":true},"positive_answer":{"type":"integer","nullable":true},"negative_answer":{"type":"integer","nullable":true},"invitation_accepted":{"type":"integer","nullable":true}},"type":"object"},"PasswordResetMethod":{"type":"string","enum":["sms","email"]},"SavedFilter":{"required":["name","filter"],"properties":{"name":{"type":"string"},"filter":{"$ref":"#\/components\/schemas\/Filter"},"pinned":{"type":"boolean"},"pinnedToToolbar":{"type":"boolean"},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}}},"type":"object"},"SavedFilterOutput":{"required":["name","filter","pinned","pinnedToToolbar","sharing","created_by"],"properties":{"name":{"type":"string"},"filter":{"$ref":"#\/components\/schemas\/Filter"},"pinned":{"type":"boolean"},"pinnedToToolbar":{"type":"boolean"},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"}},"created_by":{"$ref":"#\/components\/schemas\/UserListed"}},"type":"object"},"SavedFilters":{"properties":{"prm":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"blacklists":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"contact_lists":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"contact_lists_contacts":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"unsubscribers":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"users":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"files":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"models_email":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"models_linkedin_invitation":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"models_linkedin_message":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"models_sms":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"models_smv":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"integrations_email":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"integrations_linkedin":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"workflows":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true},"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilter"},"nullable":true}},"type":"object"},"SavedFiltersOutput":{"required":["prm","blacklists","contact_lists","contact_lists_contacts","unsubscribers","users","files","models_email","models_linkedin_invitation","models_linkedin_message","models_sms","models_smv","integrations_email","integrations_linkedin","workflows","statistics"],"properties":{"prm":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"blacklists":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"contact_lists":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"contact_lists_contacts":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"unsubscribers":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"users":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"files":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"models_email":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"models_linkedin_invitation":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"models_linkedin_message":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"models_sms":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"models_smv":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"integrations_email":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"integrations_linkedin":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"workflows":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true},"statistics":{"type":"array","items":{"$ref":"#\/components\/schemas\/SavedFilterOutput"},"nullable":true}},"type":"object"},"SavedOrder":{"required":["contact_list_fetch_contacts_order","contact_list_fetch_contacts_order_linkedin","contact_list_fetch_contacts_order_google_maps","contact_list_fetch_contacts_order_imported","contact_list_fetch_contacts_order_by_contact_list_id","mapping","contact_list_order","prm_order","models_email_order","models_linkedin_invitation_order","models_linkedin_message_order","models_sms_order","models_smv_order","models_folder_order","workflows_order","stats_order","blacklists_order","integrations_email_order","integrations_linkedin_order","files_order","unsubscribers_order","pools_order","email_signatures_order","api_key_order","url_shortener_order","users_order","teams_order","organizations_order","resellers_order","stats_fetch_contacts_order"],"properties":{"contact_list_fetch_contacts_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"contact_list_fetch_contacts_order_linkedin":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"contact_list_fetch_contacts_order_google_maps":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"contact_list_fetch_contacts_order_imported":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"contact_list_fetch_contacts_order_by_contact_list_id":{"description":"Overrides for contact list columns order by contact list id","type":"object","example":{"123":{"hidden_columns":["1"],"order_columns":["2"],"size_columns":[120]}},"additionalProperties":{"$ref":"#\/components\/schemas\/OrderString"}},"contact_list_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"prm_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"models_email_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"models_linkedin_invitation_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"models_linkedin_message_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"models_sms_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"models_smv_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"models_folder_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"workflows_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"stats_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"stats_fetch_contacts_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"blacklists_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"integrations_email_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"integrations_linkedin_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"files_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"unsubscribers_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"pools_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"email_signatures_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"api_key_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"url_shortener_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"users_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"teams_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"organizations_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"resellers_order":{"oneOf":[{"$ref":"#\/components\/schemas\/OrderString"}],"nullable":true},"mapping":{"description":"An hashmap with the ids of datafield as index and a list of header that are linked to that datafield","type":"object","example":{"1":["email","e-mail"]},"additionalProperties":{"type":"array","items":{"type":"string"}}}},"type":"object"},"Mapping":{"required":["visibleColumns","orderColumns"],"properties":{"hidden_columns":{"description":"List of datafield ids that should be hidden. Null for default.","type":"array","items":{"type":"integer"},"nullable":true},"order_columns":{"description":"Order of datafield ids. Null for default order.","type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"},"Order":{"required":["hidden_columns","order_columns"],"properties":{"hidden_columns":{"description":"List of datafield ids that should be hidden. Null for default.","type":"array","items":{"type":"integer"},"nullable":true},"order_columns":{"description":"Order of datafield ids. Null for default order.","type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"},"OrderString":{"required":["hidden_columns","order_columns","size_columns"],"properties":{"hidden_columns":{"description":"List of columns names that should be hidden. Null for default.","type":"array","items":{"type":"string"},"nullable":true},"order_columns":{"description":"Order of columns. Null for default order.","type":"array","items":{"type":"string"},"nullable":true},"size_columns":{"description":"Size of columns in pixels. Null for default size.","type":"object","example":{"id":200},"nullable":true,"additionalProperties":{"type":"integer"}}},"type":"object"},"usersSex":{"description":"User sex","type":"string","enum":["male","female"]},"Source":{"type":"string","enum":["web_search","linkedin","referral","email","trade_show","other","linkedin_post","linkedin_message"]},"SwitchKey":{"required":["token"],"properties":{"token":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz"}},"type":"object"},"usersTableDensity":{"description":"Table density","type":"string","enum":["compact","standard","comfortable"]},"TypeOfActionRequired":{"type":"string","enum":["linkedin_account_to_delete","smtp_account_to_delete"]},"UserCreate":{"required":["email","password"],"properties":{"email":{"description":"Identification\/Contact email","type":"string","example":"jean.dupont@example.com"},"password":{"description":"Identification password (Password should be at least 8 characters in length and should include at least one lower case letter, one upper case letter, one number, and one special character)","type":"string","example":"Azerty123!"},"sex":{"oneOf":[{"$ref":"#\/components\/schemas\/usersSex"}],"nullable":true},"last_name":{"description":"User last name","type":"string","example":"Dupont"},"first_name":{"description":"User first name","type":"string","example":"Jean"},"mobile_phone":{"description":"User mobile phone","type":"string","example":"33612345678"},"mobile_phone_country":{"description":"Mobile phone country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"domain_saas":{"description":"Current access domain name (ex: saas.domain.ext)","type":"string","example":"saas.domain.ext"},"email_validation_url_success":{"description":"When the email validation is OK, then redirect the user to (email_validation_url_success)\n            If empty, then the user will be redirected to {SAAS_URL}\/email-validated","type":"string","example":"https:\/\/saas.domain.ext\/email-validation-success"},"email_validation_url_error":{"description":"When the email validation is ERROR, then redirect the user to (email_validation_url_error)\n            If empty, then the user will be redirected to {SAAS_URL}\/email-not-validated","type":"string","example":"https:\/\/saas.domain.ext\/email-validation-error"},"language":{"description":"Code of the user's preferred language - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"referred_user_id":{"description":"Referring user ID","type":"integer","example":"1","nullable":true},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"team_codes":{"description":"List of invitation codes to join a team, if you have","type":"array","items":{"type":"string"},"nullable":true},"organization_codes":{"description":"List of invitation codes to join an organization, if you have","type":"array","items":{"type":"string"},"nullable":true},"show_onboarding":{"type":"boolean","nullable":true,"default":true},"send_email":{"description":"Send email to validate account","type":"boolean","nullable":true,"default":true}},"type":"object"},"UserListed":{"required":["id","first_name","last_name"],"properties":{"id":{"type":"integer","example":1},"first_name":{"type":"string","example":"Jean"},"last_name":{"type":"string","example":"Moulin"}},"type":"object"},"UserProfile":{"description":"Displays the user profile detail","required":["id","language","email","sex","last_name","first_name","mobile_phone","mobile_phone_country","phone","address","zip_code","city","country","teams","organizations","resellers","activated","permissions","avatar","emails_notification","subscriptions","timezone","show_onboarding","table_density","contact_list_language","contact_list_country","activity_description","actions_required","activation_dates","deactivation_dates","source","created_on","last_activity","reseller_user_tags"],"properties":{"id":{"type":"integer","example":1},"language":{"description":"Code of the user's preferred language - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA"},"email":{"description":"Identification\/Contact email","type":"string","example":"email@example.org"},"sex":{"oneOf":[{"$ref":"#\/components\/schemas\/usersSex"}],"nullable":true},"last_name":{"description":"User last name","type":"string","example":"Dupont"},"first_name":{"description":"User first name","type":"string","example":"Jean"},"mobile_phone":{"description":"User mobile phone","type":"string","example":"33612345678"},"mobile_phone_country":{"description":"Mobile phone country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"phone":{"description":"User phone","type":"string","example":"0112345678"},"address":{"description":"User address","type":"string","example":"2 rue eiffel"},"zip_code":{"description":"User zip code","type":"string","example":"75001"},"city":{"description":"User city","type":"string","example":"Paris"},"country":{"description":"User country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR"},"job_title":{"type":"string"},"company":{"type":"string"},"teams":{"type":"array","items":{"$ref":"#\/components\/schemas\/TeamProfile"}},"organizations":{"type":"array","items":{"$ref":"#\/components\/schemas\/OrganizationProfile"}},"resellers":{"type":"array","items":{"$ref":"#\/components\/schemas\/ResellerProfile"}},"activated":{"type":"boolean"},"permissions":{"type":"array","items":{"$ref":"#\/components\/schemas\/PermissionItem"}},"avatar":{"description":"User avatar in base64 format","type":"string","nullable":true},"emails_notification":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"subscriptions":{"oneOf":[{"$ref":"#\/components\/schemas\/MySubscription"}],"nullable":true},"created_on":{"type":"string","format":"date-time"},"timezone":{"type":"string","nullable":true},"show_onboarding":{"type":"boolean"},"table_density":{"oneOf":[{"$ref":"#\/components\/schemas\/usersTableDensity"}],"nullable":true},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"activity_description":{"description":"Describe your professional activity","type":"string","nullable":true},"actions_required":{"description":"Displays actions required on the account","type":"array","items":{"$ref":"#\/components\/schemas\/ActionRequiredItem"}},"activation_dates":{"description":"List of all account activation dates","type":"array","items":{"type":"string","format":"date-time"}},"deactivation_dates":{"description":"List of all account deactivation dates","type":"array","items":{"type":"string","format":"date-time"}},"source":{"oneOf":[{"$ref":"#\/components\/schemas\/Source"}],"nullable":true},"last_activity":{"type":"string","format":"date-time"},"reseller_user_tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}},"type":"object"},"UserProfileAffiliate":{"description":"Displays the user profile detail","required":["id","email","last_name","first_name","created_on"],"properties":{"id":{"type":"integer","example":1},"email":{"description":"Contact email","type":"string","example":"email@example.org"},"last_name":{"description":"User last name","type":"string","example":"Dupont"},"first_name":{"description":"User first name","type":"string","example":"Jean"},"created_on":{"type":"string","format":"date-time"},"subscriptions":{"oneOf":[{"$ref":"#\/components\/schemas\/MySubscription"}],"nullable":true}},"type":"object"},"UserProfileMe":{"required":["saved_order","saved_filters","level","prm_scoring","datafields_replacement","permissions","emails_notification","subscriptions","dont_show_values","activity_description","answer_ai_mark_positive","actions_required","activation_dates","deactivation_dates","reseller_user_tags","send_positive_reply_mail","send_negative_reply_mail","send_neutral_reply_mail","send_prm_column_entry_mail","send_prm_column_entry_mail_frequency","send_prm_column_entry_mail_digest_time","show_new_workflow_builder"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UserProfile"},{"properties":{"saved_order":{"oneOf":[{"$ref":"#\/components\/schemas\/SavedOrder"}],"nullable":true},"saved_filters":{"oneOf":[{"$ref":"#\/components\/schemas\/SavedFiltersOutput"}],"nullable":true},"prm_scoring":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMScoring"}],"nullable":true},"level":{"$ref":"#\/components\/schemas\/Level"},"datafields_replacement":{"type":"array","items":{"$ref":"#\/components\/schemas\/DatafieldReplacement"},"nullable":true},"dont_show_values":{"oneOf":[{"$ref":"#\/components\/schemas\/DontShowValues"}],"nullable":true},"answer_ai_mark_positive":{"type":"boolean"},"show_new_workflow_builder":{"type":"boolean","nullable":true}},"type":"object"}]},"UserUpdate":{"properties":{"email":{"description":"Identification\/Contact email","type":"string","example":"jean.dupont@example.com","nullable":true},"password":{"description":"Identification password (Password should be at least 8 characters in length and should include at least one lower case letter, one upper case letter, one number, and one special character)","type":"string","example":"Azerty123!","nullable":true},"sex":{"oneOf":[{"$ref":"#\/components\/schemas\/usersSex"}],"nullable":true},"last_name":{"description":"User last name","type":"string","example":"Dupont","nullable":true},"first_name":{"description":"User first name","type":"string","example":"Jean","nullable":true},"mobile_phone":{"description":"User mobile phone","type":"string","example":"33612345678","nullable":true},"mobile_phone_country":{"description":"Mobile phone country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"phone":{"description":"User phone","type":"string","example":"0112345678","nullable":true},"address":{"description":"User address","type":"string","example":"2 rue eiffel","nullable":true},"zip_code":{"description":"User zip code","type":"string","example":"75001","nullable":true},"city":{"description":"User city","type":"string","example":"Paris","nullable":true},"country":{"description":"User country code - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"language":{"description":"Code of the user's preferred language - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"job_title":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"email_validation_url_success":{"description":"When the email validation is OK, then redirect the user to (email_validation_url_success)\n            If empty, then the user will be redirected to {SAAS_URL}\/email-validated","type":"string","example":"https:\/\/saas.domain.ext\/email-validation-success","nullable":true},"email_validation_url_error":{"description":"When the email validation is ERROR, then redirect the user to (email_validation_url_error)\n            If empty, then the user will be redirected to {SAAS_URL}\/email-not-validated","type":"string","example":"https:\/\/saas.domain.ext\/email-validation-error","nullable":true},"saved_order":{"oneOf":[{"$ref":"#\/components\/schemas\/SavedOrder"}],"nullable":true},"saved_filters":{"oneOf":[{"$ref":"#\/components\/schemas\/SavedFilters"}],"nullable":true},"prm_scoring":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMScoring"}],"nullable":true},"datafields_replacement":{"type":"array","items":{"$ref":"#\/components\/schemas\/DatafieldReplacement"},"nullable":true},"emails_notification":{"type":"array","items":{"type":"string","example":"jean.dupont@example.com"},"nullable":true},"timezone":{"description":"You can use values like UTC, Europe\/Paris, America\/Detroit","type":"string","example":"Europe\/Paris","nullable":true},"show_onboarding":{"type":"boolean","nullable":true},"table_density":{"oneOf":[{"$ref":"#\/components\/schemas\/usersTableDensity"}],"nullable":true},"contact_list_language":{"description":"Code of the user's preferred language for contact list - ISO 639-3 standard (3 characters) - Example : France = FRA \/ English = ENG","type":"string","example":"FRA","nullable":true},"contact_list_country":{"description":"Code of the user's preferred country for contact list - ISO 3166 standard (2 characters) - Example : France = FR \/ Belgium = BE","type":"string","example":"FR","nullable":true},"dont_show_values":{"oneOf":[{"$ref":"#\/components\/schemas\/DontShowValues"}],"nullable":true},"activity_description":{"description":"Describe your professional activity","type":"string","nullable":true},"answer_ai_mark_positive":{"type":"boolean","nullable":true},"show_new_workflow_builder":{"type":"boolean","nullable":true},"source":{"oneOf":[{"$ref":"#\/components\/schemas\/Source"}],"nullable":true},"current_password":{"description":"The current user password to confirm password\/email update (Only for your account)","type":"string","example":"abc","nullable":true},"send_positive_reply_mail":{"type":"boolean","nullable":true},"send_negative_reply_mail":{"type":"boolean","nullable":true},"send_neutral_reply_mail":{"type":"boolean","nullable":true},"send_prm_column_entry_mail":{"type":"boolean","nullable":true},"send_prm_column_entry_mail_frequency":{"oneOf":[{"$ref":"#\/components\/schemas\/ColumnEntryNotificationFrequency"}],"nullable":true},"send_prm_column_entry_mail_digest_time":{"type":"string","nullable":true}},"type":"object"},"UsersListData":{"required":["id","last_name","first_name","email","activated","in_same_organization","in_our_reseller","in_same_team","in_a_reseller","is_subscription_active","created_on","last_activity","source"],"properties":{"id":{"type":"integer","example":1},"last_name":{"type":"string","example":"Dupont"},"first_name":{"type":"string","example":"Jean"},"email":{"type":"string","example":"jean.dupont@example.com"},"activated":{"type":"boolean"},"in_same_organization":{"type":"boolean"},"in_our_reseller":{"type":"boolean"},"in_a_reseller":{"type":"boolean"},"in_same_team":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"is_subscription_active":{"$ref":"#\/components\/schemas\/UserSubscriptionType"},"last_activity":{"type":"string","format":"date-time"},"source":{"oneOf":[{"$ref":"#\/components\/schemas\/Source"}],"nullable":true}},"type":"object"},"UsersListDataAdmin":{"required":["id","last_name","first_name","email","activated","in_same_organization","in_our_reseller","in_same_team","in_a_reseller","is_subscription_active","created_on","last_activity","reseller_user_tags","number_connections","source","number_integrations_email","number_integrations_linkedin","number_model","number_programmations","sum_billed","number_contact_list","job_title","company","country","subscription_churn","email_validated","avatar","mobile_phone"],"properties":{"id":{"type":"integer","example":1},"last_name":{"type":"string","example":"Dupont"},"first_name":{"type":"string","example":"Jean"},"email":{"type":"string","example":"jean.dupont@example.com"},"activated":{"type":"boolean"},"in_same_organization":{"type":"boolean"},"in_our_reseller":{"type":"boolean"},"in_a_reseller":{"type":"boolean"},"in_same_team":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"is_subscription_active":{"$ref":"#\/components\/schemas\/UserSubscriptionType"},"last_activity":{"type":"string","format":"date-time"},"reseller_user_tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"number_connections":{"type":"integer"},"source":{"oneOf":[{"$ref":"#\/components\/schemas\/Source"}],"nullable":true},"number_integrations_email":{"type":"integer"},"number_integrations_linkedin":{"type":"integer"},"number_model":{"type":"integer"},"number_programmations":{"type":"integer"},"number_contact_list":{"type":"integer"},"sum_billed":{"type":"number","format":"float"},"job_title":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"subscription_churn":{"description":"Have the user cancelled a subscription ?","type":"boolean"},"email_validated":{"type":"boolean"},"avatar":{"type":"string","nullable":true},"mobile_phone":{"type":"string","nullable":true}},"type":"object"},"Webhooks.Data":{"required":["event_id","workflow_programmation_id","event","workflow_id","workflow_programmation_contact_id","properties","date_event","prm_contacts_id","batch_id"],"properties":{"event_id":{"type":"integer"},"workflow_programmation_id":{"type":"integer"},"event":{"$ref":"#\/components\/schemas\/Webhooks.EventType"},"workflow_id":{"type":"integer"},"workflow_programmation_contact_id":{"type":"integer"},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/ContactProperty"}},"date_event":{"type":"string","format":"date-time"},"prm_contacts_id":{"type":"integer","nullable":true},"batch_id":{"type":"string","nullable":true}},"type":"object"},"Webhooks.EventType":{"type":"string","enum":["email_open","link_click","email_answered","linkedin_invitation_sent","linkedin_invitation_accepted","linkedin_message_sent","linkedin_message_answered","linkedin_visited","sms_got","sms_replied","smv_got","enrich","all"]},"WebhookCreate":{"required":["name","enabled","event_type","url","headers"],"properties":{"name":{"description":"Webhook name","type":"string","example":"My webhook"},"enabled":{"type":"boolean"},"event_type":{"$ref":"#\/components\/schemas\/Webhooks.EventType"},"url":{"type":"string","example":"https:\/\/example.org\/callback"},"headers":{"type":"object","example":{"Authorization":"123456"},"additionalProperties":{"type":"string"}}},"type":"object"},"WebhookItem":{"required":["id","name","enabled","event_type","url","created_by","created_on","updated_on","headers","last_test"],"properties":{"id":{"type":"integer"},"name":{"description":"Webhook name","type":"string","example":"My webhook"},"enabled":{"type":"boolean"},"event_type":{"$ref":"#\/components\/schemas\/Webhooks.EventType"},"url":{"type":"string","example":"https:\/\/example.org\/callback"},"created_by":{"description":"The user id of the person that has created this webhook","type":"integer","example":1},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"headers":{"type":"object","example":{"Authorization":"123456"},"additionalProperties":{"type":"string"}},"last_test":{"type":"string","format":"date-time","nullable":true}},"type":"object"},"WebhookResultItem":{"required":["id","name","enabled","event_type","url","created_by","created_on","updated_on","headers"],"properties":{"id":{"type":"integer"},"name":{"description":"Webhook name","type":"string","example":"My webhook"},"enabled":{"type":"boolean"},"event_type":{"$ref":"#\/components\/schemas\/Webhooks.EventType"},"url":{"type":"string","example":"https:\/\/example.org\/callback"},"created_by":{"description":"The user id of the person that has created this webhook","type":"integer","example":1},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"headers":{"type":"object","example":{"Authorization":"123456"},"additionalProperties":{"type":"string"}}},"type":"object"},"WebhookUpdate":{"required":[],"properties":{"name":{"description":"Webhook name","type":"string","example":"My webhook","nullable":true},"enabled":{"type":"boolean","nullable":true},"event_type":{"oneOf":[{"$ref":"#\/components\/schemas\/Webhooks.EventType"}],"nullable":true},"url":{"type":"string","example":"https:\/\/example.org\/callback","nullable":true},"headers":{"type":"object","example":{"Authorization":"123456"},"nullable":true,"additionalProperties":{"type":"string"}}},"type":"object"},"Action":{"required":["workflow_id","step_id","step_type","action_type","model_id","limit_send_per_day","sending_weekends_allowed","allow_massmailing","time_start_sending","time_stop_sending","blacklist_ids","email_linkedin_exclude","is_initial","show_reply_as_conversation","use_smtp_fallback_server","disable_auto_remove_responders"],"properties":{"step_id":{"$ref":"#\/components\/schemas\/StepId"},"step_type":{"type":"string","enum":["action"]},"position_x":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"position_y":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"parent_ids":{"type":"array","items":{"$ref":"#\/components\/schemas\/StepId"},"nullable":true},"action_type":{"$ref":"#\/components\/schemas\/ActionType"},"model_id":{"type":"integer","example":1,"nullable":true},"integration_id":{"type":"integer","example":1,"nullable":true},"pool_id":{"type":"integer","example":1,"nullable":true},"limit_send_per_day":{"description":"For the initial step, the value is remplaced by daily_send_limit on the programmation","type":"integer","example":1},"sending_weekends_allowed":{"type":"boolean"},"allow_massmailing":{"type":"boolean"},"time_start_sending":{"description":"Between 00:00:00 and 23:59:59. Must be lower than time_stop_sending. For the initial step, the value is replaced by the programmation.\n        Must be GMT if you don't provide time_sending_timezone in the programmation. If null, the value from the programmation will be used.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending":{"description":"Between 00:00:00 and 23:59:59. For the initial step, the value is replaced by the programmation.\n        If null, the value from the programmation will be used.","type":"string","example":"23:59:59","nullable":true},"time_start_sending_monday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_monday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_thursday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_thursday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_friday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_friday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_saturday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_saturday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_sunday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_sunday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"blacklist_ids":{"type":"array","items":{"type":"integer"}},"email_linkedin_exclude":{"type":"array","items":{"type":"string","example":"https:\/\/www.linkedin.com\/in\/abc"}},"is_initial":{"description":"True if it's the first action of the workflow. There should be exactly one initial action and it should be on the root of the workflow","type":"boolean"},"show_reply_as_conversation":{"type":"boolean"},"use_smtp_fallback_server":{"description":"Use our SMTP servers in case of a disconnect","type":"boolean"},"signature_id":{"type":"integer","nullable":true},"disable_auto_remove_responders":{"type":"boolean","default":false}},"type":"object"},"ActionOutput":{"required":["step_id","step_type","action_type","model_id","integration_id","pool_id","limit_send_per_day","position_x","position_y","sending_weekends_allowed","allow_massmailing","time_start_sending","time_stop_sending","blacklist_ids","email_linkedin_exclude","is_initial","show_reply_as_conversation","use_smtp_fallback_server","model_name","integration_name","pool_name","signature_id","signature_name","number_contacts","is_attached_to_initial","disable_auto_remove_responders","time_start_sending_monday","time_start_sending_tuesday","time_stop_sending_tuesday","time_start_sending_wednesday","time_stop_sending_wednesday","time_start_sending_thursday","time_stop_sending_thursday","time_start_sending_friday","time_stop_sending_friday","time_start_sending_saturday","time_stop_sending_saturday","time_start_sending_sunday","time_stop_sending_sunday"],"properties":{"step_id":{"$ref":"#\/components\/schemas\/StepId"},"step_type":{"type":"string","enum":["action"]},"position_x":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"position_y":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"parent_ids":{"type":"array","items":{"$ref":"#\/components\/schemas\/StepId"},"nullable":true},"action_type":{"$ref":"#\/components\/schemas\/ActionType"},"model_id":{"type":"integer","example":1,"nullable":true},"model_name":{"type":"string","nullable":true},"integration_id":{"type":"integer","example":1,"nullable":true},"integration_name":{"type":"string","nullable":true},"pool_id":{"type":"integer","example":1,"nullable":true},"pool_name":{"type":"string","nullable":true},"limit_send_per_day":{"type":"integer","example":1},"sending_weekends_allowed":{"type":"boolean"},"allow_massmailing":{"type":"boolean"},"time_start_sending":{"description":"Between 00:00:00 and 23:59:59. Must be lower than time_stop_sending. For the initial step, the value is replaced by the programmation.\n        Must be GMT if you don't provide time_sending_timezone in the programmation. If null, the value from the programmation will be used.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending":{"description":"Between 00:00:00 and 23:59:59. For the initial step, the value is replaced by the programmation.\n        If null, the value from the programmation will be used.","type":"string","example":"23:59:59","nullable":true},"time_start_sending_monday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_monday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_thursday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_thursday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_friday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_friday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_saturday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_saturday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_sunday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_sunday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"blacklist_ids":{"type":"array","items":{"$ref":"#\/components\/schemas\/BlacklistListed"}},"email_linkedin_exclude":{"type":"array","items":{"type":"string","example":"https:\/\/www.linkedin.com\/in\/abc"}},"is_initial":{"description":"True if it's the first action of the workflow. There should be exactly one initial action and it should be on the root of the workflow","type":"boolean"},"show_reply_as_conversation":{"type":"boolean"},"use_smtp_fallback_server":{"description":"Use our SMTP servers in case of a disconnect","type":"boolean"},"signature_id":{"type":"integer","nullable":true},"signature_name":{"type":"string","nullable":true},"number_contacts":{"description":"The number of contacts that reached this step","type":"integer"},"is_attached_to_initial":{"type":"boolean"},"disable_auto_remove_responders":{"type":"boolean"}},"type":"object"},"ActionType":{"type":"string","enum":["email","smv","sms","linkedin_message","linkedin_invitation","linkedin_visit","call","remove_prospect","dummy","split_contacts"]},"WorkflowAiAgentGeneratedModel":{"required":["action_type","name","model_id","personalized_by_contact","model_generation_mode","personalization_notice"],"properties":{"action_type":{"$ref":"#\/components\/schemas\/WorkflowAiAgentPlanActionType"},"name":{"type":"string"},"model_id":{"type":"integer","nullable":true},"personalized_by_contact":{"type":"boolean"},"model_generation_mode":{"$ref":"#\/components\/schemas\/WorkflowAiAgentModelGenerationMode"},"personalization_notice":{"type":"string","nullable":true}},"type":"object"},"WorkflowAiAgentGenerationJobListItem":{"required":["uniqid","ai_agent_id","ai_agent_uniqid","state","queued_date","start_date","end_date","percent","current_step","error","preview","preview_expires_at"],"properties":{"uniqid":{"type":"string"},"ai_agent_id":{"type":"integer"},"ai_agent_uniqid":{"type":"string"},"state":{"$ref":"#\/components\/schemas\/State"},"queued_date":{"type":"string","format":"date-time"},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"percent":{"type":"number","format":"float","example":100},"current_step":{"$ref":"#\/components\/schemas\/WorkflowAiAgentGenerationStep"},"error":{"type":"string","nullable":true},"preview":{"nullable":true,"oneOf":[{"$ref":"#\/components\/schemas\/WorkflowAiAgentPreview"}]},"preview_expires_at":{"type":"string","format":"date-time","nullable":true}},"type":"object"},"WorkflowAiAgentGenerationStatus":{"required":["job"],"properties":{"job":{"$ref":"#\/components\/schemas\/WorkflowAiAgentJob"}},"type":"object"},"WorkflowAiAgentGenerationStep":{"type":"string","enum":["queued","starting","collecting_contact_context","loading_ai_agent","generating_sequence_plan","resolving_resources","generating_models","building_preview","completed","failed","cancelled"]},"WorkflowAiAgentJob":{"required":["uniqid","state","state_details"],"properties":{"uniqid":{"type":"string"},"state":{"$ref":"#\/components\/schemas\/State"},"state_details":{"type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}}},"type":"object"},"WorkflowAiAgentMissingResource":{"type":"string","enum":["email_integration","email_signature","linkedin_integration"]},"WorkflowAiAgentModelGenerationMode":{"type":"string","enum":["contact_ai","static"]},"WorkflowAiAgentNature":{"type":"string","enum":["email","linkedin","crosscanal"]},"WorkflowAiAgentPlanActionType":{"type":"string","enum":["email","linkedin_invitation","linkedin_message"]},"WorkflowAiAgentPlanCtaType":{"type":"string","enum":["soft_reply","ask_interest","book_meeting","share_resource","qualify_need","connect"]},"WorkflowAiAgentPlanPlaybook":{"type":"string","enum":["educational","pain_led","event_triggered","re_engagement","agency_partner","local_prospecting","proof_led"]},"WorkflowAiAgentPlanTopology":{"type":"string","enum":["linear_nurture","engagement_branch","cross_channel_branch","re_engagement_tree"]},"WorkflowAiAgentPlanTriggerEvent":{"type":"string","enum":["none","not_active","email_open","email_open_no_click","link_click","linkedin_invitation_accepted"]},"WorkflowAiAgentPlannedAction":{"required":["step_id","action_key","action_type","parent_action_key","trigger_event_after_parent","delay_days_after_previous","playbook","cta_type","audience_segment","personalization_source","channel_role","continuity","delay_reason","goal","prompt"],"properties":{"action_key":{"type":"string"},"action_type":{"$ref":"#\/components\/schemas\/WorkflowAiAgentPlanActionType"},"parent_action_key":{"type":"string"},"trigger_event_after_parent":{"$ref":"#\/components\/schemas\/WorkflowAiAgentPlanTriggerEvent"},"delay_days_after_previous":{"type":"integer","maximum":14,"minimum":0},"playbook":{"$ref":"#\/components\/schemas\/WorkflowAiAgentPlanPlaybook"},"cta_type":{"$ref":"#\/components\/schemas\/WorkflowAiAgentPlanCtaType"},"audience_segment":{"type":"string"},"personalization_source":{"type":"string"},"channel_role":{"type":"string"},"continuity":{"type":"string"},"delay_reason":{"type":"string"},"goal":{"type":"string"},"prompt":{"type":"string"},"step_id":{"oneOf":[{"$ref":"#\/components\/schemas\/StepId"}],"nullable":true}},"type":"object"},"WorkflowAiAgentPreview":{"required":["sequence_plan","models","steps","workflow_payload","missing_resources","model_generation_mode"],"properties":{"sequence_plan":{"$ref":"#\/components\/schemas\/WorkflowAiAgentSequencePlan"},"models":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowAiAgentGeneratedModel"}},"steps":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/Action"},{"$ref":"#\/components\/schemas\/Event"}]}},"missing_resources":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowAiAgentMissingResource"}},"modelGenerationMode":{"$ref":"#\/components\/schemas\/WorkflowAiAgentModelGenerationMode"},"workflow_payload":{"required":["name","ai_agent_uniqid","auto_remove_responders","steps"],"properties":{"name":{"type":"string"},"ai_agent_uniqid":{"type":"string"},"auto_remove_responders":{"type":"boolean"},"steps":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/Action"},{"$ref":"#\/components\/schemas\/Event"}]}}},"type":"object"}},"type":"object"},"WorkflowAiAgentQueuedJob":{"required":["uniqid"],"properties":{"uniqid":{"type":"string"}},"type":"object"},"WorkflowAiAgentSequencePlan":{"required":["topology","actions"],"properties":{"topology":{"$ref":"#\/components\/schemas\/WorkflowAiAgentPlanTopology"},"actions":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowAiAgentPlannedAction"}}},"type":"object"},"ContactType":{"type":"string","enum":["contacted","to_contact","in_queue","opener","clicker","answerer","sent_today","bounced","unsubscriber","blacklisted","excluded_previous_programmation","excluded_workflow","to_contact_failed"]},"ContactTypeProgrammation":{"type":"string","enum":["contacted","opener","clicker","answerer","bounced","unsubscriber","blacklisted","excluded_previous_programmation"]},"Workflows.ContactsSelection":{"required":["filter","contact_ids","excluded_contact_ids"],"properties":{"filter":{"$ref":"#\/components\/schemas\/Filter"},"contact_ids":{"type":"array","items":{"type":"integer"}},"excluded_contact_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"},"Event":{"required":["workflow_id","step_id","step_type","event_type","when_minutes"],"properties":{"step_id":{"$ref":"#\/components\/schemas\/StepId"},"step_type":{"type":"string","enum":["event"]},"position_x":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"position_y":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"parent_ids":{"type":"array","items":{"$ref":"#\/components\/schemas\/StepId"},"nullable":true},"event_type":{"oneOf":[{"$ref":"#\/components\/schemas\/EventType"}],"nullable":true},"which_links_clicked":{"type":"array","items":{"type":"string","example":"https:\/\/www.google.com"},"nullable":true},"when_minutes":{"description":"The number of minutes to wait before continuing to this event","type":"integer","example":1},"name":{"type":"string","example":"My custom event","nullable":true},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"description":"Allowed field_name: all data fields ids, preferred_integration_id, date_added_to_contact_list"}},"type":"object"},"EventOutput":{"required":["step_id","step_type","event_type","which_links_clicked","number_contacts","when_minutes","position_x","position_y","parent_ids","name","is_attached_to_initial"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Event"},{"properties":{"step_id":{"$ref":"#\/components\/schemas\/StepId"},"step_type":{"type":"string","enum":["event"]},"position_x":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"position_y":{"description":"If you want to store the visual position of the step, you can put it there","type":"integer","nullable":true},"parent_ids":{"type":"array","items":{"$ref":"#\/components\/schemas\/StepId"},"nullable":true},"event_type":{"oneOf":[{"$ref":"#\/components\/schemas\/EventType"}],"nullable":true},"which_links_clicked":{"type":"array","items":{"type":"string","example":"https:\/\/www.google.com"},"nullable":true},"number_contacts":{"description":"The number of contacts that reached this step","type":"integer"},"when_minutes":{"description":"The number of minutes to wait before continuing to this event","type":"integer","example":1},"name":{"type":"string","example":"My custom event","nullable":true},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"description":"Allowed field_name: all data fields ids"},"is_attached_to_initial":{"type":"boolean"}},"type":"object"}]},"EventType":{"description":"You cannot use the events unsubscribe, unsubscribe_advertiser, bounce, blacklisted, excluded_programmation, excluded_workflow,\nemail_sent_manually on the workflows. split_contacts cannot have filters and must be only after split_contacts action.","type":"string","enum":["email_open","email_open_no_click","link_click","email_answered","not_active","all_contacts","linkedin_invitation_queued","linkedin_invitation_sent","linkedin_invitation_accepted","linkedin_message_queued","linkedin_message_sent","linkedin_message_answered","linkedin_visit_queued","linkedin_visited","call_custom","sms_got","sms_not_got","sms_replied","smv_got","smv_not_got","email_queued","email_sent","email_sent_manually","sms_queued","sms_sent","smv_queued","smv_sent","split_contacts","error_occured","unsubscribe","unsubscribe_advertiser","bounce","blacklisted","excluded_programmation","excluded_workflow","out_of_office"]},"Filter.Workflows":{"required":["mode","values"],"example":{"mode":"or","values":[{"field_name":"id","type":"equals","value":"1"},{"field_name":"date_start","type":"start_with","value":"2024"},{"mode":"and","values":[{"field_name":"contains_linkedin_invitation_step","type":"does_exist","value":""},{"field_name":"contains_call_step","type":"does_not_exist","value":""}]}]},"allOf":[{"$ref":"#\/components\/schemas\/Filter"}]},"ProgrammationContactForProgrammationOutput":{"required":["id","properties","status","prm_contacts_id","status_changed_date","contact_list_id","contact_list_contacts_id","is_bounced","unsubscribed","blacklisted","excluded_workflow","excluded_programmation","excluded_previous_programmation","programmation_id","workflow_id","workflow_name","email_prefered_integration_id"],"properties":{"id":{"type":"integer"},"programmation_id":{"type":"integer"},"workflow_id":{"type":"integer"},"workflow_name":{"type":"string"},"contact_list_id":{"type":"integer","nullable":true},"contact_list_contacts_id":{"type":"integer","nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true},"prm_contacts_id":{"type":"integer","nullable":true},"status_changed_date":{"type":"string","format":"date-time"},"is_bounced":{"type":"boolean"},"unsubscribed":{"type":"boolean"},"blacklisted":{"type":"boolean"},"excluded_workflow":{"type":"boolean"},"excluded_programmation":{"type":"boolean"},"excluded_previous_programmation":{"type":"boolean"},"email_prefered_integration_id":{"type":"integer","nullable":true}},"type":"object"},"ProgrammationContactOutput":{"required":["id","properties","status","prm_contacts_id","status_changed_date","date_contacted","contact_list_id","contact_list_contacts_id","is_bounced","unsubscribed","blacklisted","excluded_workflow","excluded_programmation","excluded_previous_programmation","email_prefered_integration_id"],"properties":{"id":{"type":"integer"},"contact_list_id":{"type":"integer","nullable":true},"contact_list_contacts_id":{"type":"integer","nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/PRMContactProperty"}},"status":{"oneOf":[{"$ref":"#\/components\/schemas\/PRMContactStatus"}],"nullable":true},"prm_contacts_id":{"type":"integer","nullable":true},"status_changed_date":{"type":"string","format":"date-time"},"date_contacted":{"type":"string","format":"date-time","nullable":true},"is_bounced":{"type":"boolean"},"unsubscribed":{"type":"boolean"},"blacklisted":{"type":"boolean"},"excluded_workflow":{"type":"boolean"},"excluded_programmation":{"type":"boolean"},"excluded_previous_programmation":{"type":"boolean"},"email_prefered_integration_id":{"type":"integer","nullable":true}},"type":"object"},"StepId":{"required":["type","id"],"properties":{"type":{"$ref":"#\/components\/schemas\/StepIdType"},"id":{"description":"If the type is \"existing\", it must be an id previously returned by the api. Else, provide any number","type":"integer"}},"type":"object"},"StepIdType":{"description":"Set to \"new\" when you want to create a new step","type":"string","enum":["new","existing"]},"StepType":{"type":"string","enum":["event","action"]},"WorkflowCreate":{"required":["name","steps"],"properties":{"name":{"description":"Workflow name","type":"string","example":"My workflow"},"steps":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/Action"},{"$ref":"#\/components\/schemas\/Event"}]}},"sharing":{"description":"The sharing currently configured for this workflow.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true},"ai_agent_uniqid":{"description":"AI agent uniqid linked to the workflow","type":"string","example":"AIAGENT123456","nullable":true},"auto_remove_responders":{"description":"Auto remove responders from the workflow","type":"boolean","nullable":true},"nurturing":{"description":"True if it is a nurturing workflow","type":"boolean","nullable":true},"is_newsletter":{"description":"True if it is a newsletter workflow","type":"boolean","nullable":true}},"type":"object"},"WorkflowItem":{"required":["id","name","steps","from_sharing","sharing","created_by","tags","permission","created_on","updated_on","folder","archived","programmed","auto_remove_responders","pin","image_url","nurturing","is_newsletter","ai_agent_id","ai_agent_uniqid"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My workflow"},"steps":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/ActionOutput"},{"$ref":"#\/components\/schemas\/EventOutput"}]}},"from_sharing":{"description":"Whether or not someone is sharing you this workflow","type":"boolean"},"sharing":{"description":"The sharing currently configured for this workflow. Null if you are not the admin of this list","type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_by":{"description":"The user id of the person that has created this workflow","type":"integer","example":1},"ai_agent_id":{"description":"Linked AI agent identifier","type":"integer","example":1,"nullable":true},"ai_agent_uniqid":{"description":"Linked AI agent uniqid","type":"string","example":"AIAGENT123456","nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"permission":{"$ref":"#\/components\/schemas\/SharingPermission"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"archived":{"type":"boolean"},"programmed":{"type":"boolean"},"auto_remove_responders":{"description":"Auto remove responders from the workflow","type":"boolean"},"pin":{"type":"boolean"},"image_url":{"description":"Image URL in PNG\/SVG format","type":"string","nullable":true},"nurturing":{"description":"True if it is a nurturing workflow","type":"boolean"},"is_newsletter":{"description":"True if it is a newsletter workflow","type":"boolean"}},"type":"object"},"WorkflowProgrammationCreate":{"required":["contactlist_ids","date_start","daily_send_limit","allowed_monday","allowed_tuesday","allowed_wednesday","allowed_thursday","allowed_friday","allowed_saturday","allowed_sunday","priority_email","time_stop_sending","time_start_sending","limit_total_sending","copy_prospect_if_scoring_above","blacklist_ids","exclude_programmation_ids"],"properties":{"contactlist_ids":{"type":"array","items":{"type":"integer"}},"date_start":{"type":"string","format":"date-time"},"daily_send_limit":{"type":"integer"},"allowed_monday":{"type":"boolean"},"allowed_tuesday":{"type":"boolean"},"allowed_wednesday":{"type":"boolean"},"allowed_thursday":{"type":"boolean"},"allowed_friday":{"type":"boolean"},"allowed_saturday":{"type":"boolean"},"allowed_sunday":{"type":"boolean"},"priority_email":{"description":"Only for super admins","type":"boolean","example":false},"date_stop":{"type":"string","format":"date-time","nullable":true},"stop_steps_at_end_date":{"type":"boolean","nullable":true},"time_start_sending":{"description":"Between 00:00:00 and 23:59:59. Must be lower than time_stop_sending. Must be GMT if you don't provide time_sending_timezone","type":"string","example":"08:00:00"},"time_stop_sending":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59"},"time_start_sending_monday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_monday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_thursday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_thursday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_friday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_friday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_saturday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_saturday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_sunday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_sunday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_sending_timezone":{"description":"Time zone name","type":"string","example":"Europe\/Paris","nullable":true},"limit_total_sending":{"description":"0 for no limit","type":"integer"},"copy_prospect_if_scoring_above":{"description":"Copy the prospect to the PRM only if the scoring is above this","type":"integer"},"ab_proportion":{"description":"The proportion of prospects to use for A\/B tests (only if ab_subject_2 or ab_subject_3 is also filled)","type":"integer","nullable":true},"ab_subject_2":{"description":"A\/B testing is disabled for IA models","type":"string","nullable":true},"ab_subject_3":{"description":"A\/B testing is disabled for IA models","type":"string","nullable":true},"blacklist_ids":{"type":"array","items":{"type":"integer"}},"exclude_programmation_ids":{"type":"array","items":{"type":"integer"}},"stats_sharings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"resend_to_bounce":{"description":"Resend to existing bounces","type":"boolean","nullable":true,"default":false},"tags_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"},"WorkflowProgrammationExclusion":{"required":["id","contact_list_contacts_id","email","linkedin_url","date_added"],"properties":{"id":{"type":"integer"},"contact_list_contacts_id":{"type":"integer","nullable":true},"email":{"type":"string","nullable":true},"linkedin_url":{"type":"string","nullable":true},"date_added":{"type":"string","format":"date-time"}},"type":"object"},"WorkflowProgrammationInfo":{"required":["id","workflow_name"],"properties":{"id":{"type":"integer"},"workflow_name":{"description":"Workflow name of the programmation.","type":"string"}},"type":"object"},"WorkflowProgrammationItem":{"required":["created_on","created_by","id","workflow_id","contactlist_ids","date_start","daily_send_limit","allowed_monday","allowed_tuesday","allowed_wednesday","allowed_thursday","allowed_friday","allowed_saturday","allowed_sunday","priority_email","date_stop","stop_steps_at_end_date","time_stop_sending","time_start_sending","limit_total_sending","copy_prospect_if_scoring_above","ab_proportion","ab_subject_2","ab_subject_3","ab_finished_at","blacklist_ids","exclude_programmation_ids","stopped","stopped_on","archived","archived_on","stats_sharings","pin","time_stop_sending_monday","time_start_sending_monday","time_start_sending_tuesday","time_stop_sending_tuesday","time_start_sending_wednesday","time_stop_sending_wednesday","time_start_sending_thursday","time_stop_sending_thursday","time_start_sending_friday","time_stop_sending_friday","time_start_sending_saturday","time_stop_sending_saturday","time_start_sending_sunday","time_stop_sending_sunday","resend_to_bounce","tags"],"properties":{"id":{"type":"integer"},"workflow_id":{"type":"integer"},"contactlist_ids":{"type":"array","items":{"type":"integer"}},"date_start":{"type":"string","format":"date-time"},"daily_send_limit":{"type":"integer"},"allowed_monday":{"type":"boolean"},"allowed_tuesday":{"type":"boolean"},"allowed_wednesday":{"type":"boolean"},"allowed_thursday":{"type":"boolean"},"allowed_friday":{"type":"boolean"},"allowed_saturday":{"type":"boolean"},"allowed_sunday":{"type":"boolean"},"priority_email":{"description":"Only for super admins","type":"boolean","example":false},"date_stop":{"type":"string","format":"date-time","nullable":true},"stop_steps_at_end_date":{"type":"boolean"},"time_start_sending":{"description":"Between 00:00:00 and 23:59:59. Must be lower than time_stop_sending. Must be GMT if you don't provide time_sending_timezone","type":"string","example":"08:00:00"},"time_stop_sending":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59"},"time_start_sending_monday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_monday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_thursday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_thursday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_friday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_friday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_saturday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_saturday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_sunday":{"description":"Between 00:00:00 and 23:59:59.","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_sunday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_sending_timezone":{"description":"Time zone name","type":"string","example":"Europe\/Paris","nullable":true},"limit_total_sending":{"description":"0 for no limit","type":"integer"},"copy_prospect_if_scoring_above":{"description":"Copy the prospect to the PRM only if the scoring is above this","type":"integer"},"ab_proportion":{"description":"The proportion of prospects to use for A\/B tests (only if ab_subject_2 or ab_subject_3 is also filled)","type":"integer"},"ab_subject_2":{"type":"string"},"ab_subject_3":{"type":"string"},"ab_finished_at":{"type":"string","format":"date-time","nullable":true},"blacklist_ids":{"type":"array","items":{"type":"integer"}},"exclude_programmation_ids":{"type":"array","items":{"type":"integer"}},"created_by":{"description":"The user id of the person that has created this workflow programmation","type":"integer","example":1,"nullable":true},"created_on":{"type":"string","format":"date-time"},"stopped":{"type":"boolean"},"stopped_on":{"type":"string","format":"date-time","nullable":true},"archived":{"type":"boolean"},"archived_on":{"type":"string","format":"date-time","nullable":true},"stats_sharings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pin":{"type":"boolean"},"resend_to_bounce":{"description":"Resend to existing bounces","type":"boolean"},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}},"type":"object"},"WorkflowProgrammationListed":{"required":["id","stopped","archived","workflow_id","workflow_name"],"properties":{"id":{"type":"integer"},"stopped":{"type":"boolean"},"archived":{"type":"boolean"},"workflow_id":{"type":"integer"},"workflow_name":{"type":"string"}},"type":"object"},"WorkflowProgrammationResultItem":{"required":["created_on","created_by","id","workflow_id","contact_lists","date_start","daily_send_limit","allowed_monday","allowed_tuesday","allowed_wednesday","allowed_thursday","allowed_friday","allowed_saturday","allowed_sunday","priority_email","date_stop","stop_steps_at_end_date","time_stop_sending","time_start_sending","limit_total_sending","copy_prospect_if_scoring_above","ab_proportion","ab_subject_2","ab_subject_3","stopped","stopped_on","archived","archived_on","workflow_name","has_email_step","has_smv_step","has_sms_step","has_linkedin_message_step","has_linkedin_invitation_step","has_linkedin_visit_step","has_call_step","stats_sharings","resend_to_bounce","tags"],"properties":{"id":{"type":"integer"},"workflow_id":{"type":"integer"},"contact_lists":{"type":"array","items":{"$ref":"#\/components\/schemas\/ContactListInfo"}},"workflow_name":{"type":"string"},"date_start":{"type":"string","format":"date-time"},"daily_send_limit":{"type":"integer"},"allowed_monday":{"type":"boolean"},"allowed_tuesday":{"type":"boolean"},"allowed_wednesday":{"type":"boolean"},"allowed_thursday":{"type":"boolean"},"allowed_friday":{"type":"boolean"},"allowed_saturday":{"type":"boolean"},"allowed_sunday":{"type":"boolean"},"priority_email":{"description":"Only for super admins","type":"boolean","example":false},"date_stop":{"type":"string","format":"date-time","nullable":true},"stop_steps_at_end_date":{"type":"boolean"},"time_start_sending":{"description":"Between 00:00:00 and 23:59:59. Must be lower than time_stop_sending. Must be GMT if you don't provide time_sending_timezone","type":"string","example":"08:00:00"},"time_stop_sending":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59"},"limit_total_sending":{"description":"0 for no limit","type":"integer"},"copy_prospect_if_scoring_above":{"description":"Copy the prospect to the PRM only if the scoring is above this","type":"integer"},"ab_proportion":{"description":"The proportion of prospects to use for A\/B tests (only if ab_subject_2 or ab_subject_3 is also filled)","type":"integer"},"ab_subject_2":{"type":"string"},"ab_subject_3":{"type":"string"},"created_by":{"description":"The user id of the person that has created this workflow programmation","type":"integer","example":1,"nullable":true},"created_on":{"type":"string","format":"date-time"},"stopped":{"type":"boolean"},"stopped_on":{"type":"string","format":"date-time","nullable":true},"archived":{"type":"boolean"},"archived_on":{"type":"string","format":"date-time","nullable":true},"has_email_step":{"type":"boolean"},"has_smv_step":{"type":"boolean"},"has_sms_step":{"type":"boolean"},"has_linkedin_message_step":{"type":"boolean"},"has_linkedin_invitation_step":{"type":"boolean"},"has_linkedin_visit_step":{"type":"boolean"},"has_call_step":{"type":"boolean"},"stats_sharings":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"resend_to_bounce":{"description":"Resend to existing bounces","type":"boolean"},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}},"type":"object"},"WorkflowProgrammationUpdate":{"properties":{"contactlist_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"date_start":{"type":"string","format":"date-time","nullable":true},"daily_send_limit":{"type":"integer","nullable":true},"allowed_monday":{"type":"boolean","nullable":true},"allowed_tuesday":{"type":"boolean","nullable":true},"allowed_wednesday":{"type":"boolean","nullable":true},"allowed_thursday":{"type":"boolean","nullable":true},"allowed_friday":{"type":"boolean","nullable":true},"allowed_saturday":{"type":"boolean","nullable":true},"allowed_sunday":{"type":"boolean","nullable":true},"priority_email":{"description":"Only for super admins","type":"boolean","example":false,"nullable":true},"date_stop":{"type":"string","format":"date-time","nullable":true},"stop_steps_at_end_date":{"type":"boolean","nullable":true},"time_start_sending":{"description":"Between 00:00:00 and 23:59:59. Must be lower than time_stop_sending. Must be GMT if you don't provide time_sending_timezone","type":"string","example":"08:00:00","nullable":true},"time_stop_sending":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_monday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_monday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_tuesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_wednesday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_thursday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_thursday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_friday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_friday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_saturday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_saturday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_start_sending_sunday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"08:00:00","nullable":true},"time_stop_sending_sunday":{"description":"Between 00:00:00 and 23:59:59","type":"string","example":"23:59:59","nullable":true},"time_sending_timezone":{"description":"Time zone name","type":"string","example":"Europe\/Paris","nullable":true},"limit_total_sending":{"description":"0 for no limit","type":"integer","nullable":true},"copy_prospect_if_scoring_above":{"description":"Copy the prospect to the PRM only if the scoring is above this","type":"integer","nullable":true},"ab_proportion":{"description":"The proportion of prospects to use for A\/B tests (only if ab_subject_2 or ab_subject_3 is also filled)","type":"integer","nullable":true},"ab_subject_2":{"description":"A\/B testing is disabled for IA models","type":"string","nullable":true},"ab_subject_3":{"description":"A\/B testing is disabled for IA models","type":"string","nullable":true},"blacklist_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"exclude_programmation_ids":{"type":"array","items":{"type":"integer"},"nullable":true},"stats_sharings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"pin":{"type":"boolean","nullable":true},"resend_to_bounce":{"description":"Resend to existing bounces","type":"boolean","nullable":true},"tags_ids":{"type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"},"WorkflowResultItem":{"required":["id","name","from_sharing","read_permission","write_permission","delete_permission","created_by","ai_agent_id","ai_agent_uniqid","tags","sharing","created_on","updated_on","folder","archived","programmed","auto_remove_responders","pin","image_url","nurturing","is_newsletter","has_email_step","has_smv_step","has_sms_step","has_linkedin_message_step","has_linkedin_invitation_step","has_linkedin_visit_step","has_call_step"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My workflow"},"from_sharing":{"description":"Whether or not someone is sharing you this workflow","type":"boolean"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"created_by":{"description":"The user id of the person that has created this workflow","type":"integer","example":1,"nullable":true},"ai_agent_id":{"description":"Linked AI agent identifier","type":"integer","example":1,"nullable":true},"ai_agent_uniqid":{"description":"Linked AI agent uniqid","type":"string","example":"AIAGENT123456","nullable":true},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}},"sharing":{"type":"array","items":{"$ref":"#\/components\/schemas\/SharingResponse"},"nullable":true},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"folder":{"oneOf":[{"$ref":"#\/components\/schemas\/FolderListed"}],"nullable":true},"archived":{"type":"boolean"},"programmed":{"type":"boolean"},"auto_remove_responders":{"description":"Auto remove responders from the workflow","type":"boolean"},"pin":{"type":"boolean"},"image_url":{"description":"Image URL in PNG\/SVG format","type":"string","nullable":true},"nurturing":{"description":"True if it is a nurturing workflow","type":"boolean"},"is_newsletter":{"description":"True if it is a newsletter workflow","type":"boolean"},"has_email_step":{"type":"boolean"},"has_smv_step":{"type":"boolean"},"has_sms_step":{"type":"boolean"},"has_linkedin_message_step":{"type":"boolean"},"has_linkedin_invitation_step":{"type":"boolean"},"has_linkedin_visit_step":{"type":"boolean"},"has_call_step":{"type":"boolean"}},"type":"object"},"WorkflowUpdate":{"properties":{"name":{"description":"Workflow name","type":"string","example":"My workflow","nullable":true},"steps":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/Action"},{"$ref":"#\/components\/schemas\/Event"}]},"nullable":true},"sharing":{"description":"The sharing currently configured for this workflow.","type":"array","items":{"$ref":"#\/components\/schemas\/Sharing"},"nullable":true},"tags_ids":{"description":"Tags ids","type":"array","items":{"type":"integer","example":1},"nullable":true},"folder_id":{"description":"Folder id","type":"integer","example":1,"nullable":true},"archived":{"type":"boolean","nullable":true},"auto_remove_responders":{"description":"Auto remove responders from the workflow","type":"boolean","nullable":true},"pin":{"type":"boolean","nullable":true},"nurturing":{"description":"True if it is a nurturing workflow","type":"boolean","nullable":true},"is_newsletter":{"description":"True if it is a newsletter workflow","type":"boolean","nullable":true},"ai_agent_uniqid":{"description":"AI agent uniqid assigned to the workflow","type":"string","nullable":false}},"type":"object"},"ZapierEventType":{"type":"string","enum":["manual","every_24_hours","every_12_hours","every_6_hours","every_1_hour","every_3_months","every_1_month","every_1_week"]},"ZapierSourceType":{"type":"string","enum":["statistics","prm"]},"ZapierItem":{"required":["id","name","source","event","url","active","created_on","updated_on","last_run","state","state_details","resend_synchronized_contacts"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Name of the Zapier hook"},"source":{"$ref":"#\/components\/schemas\/ZapierSourceType"},"event":{"$ref":"#\/components\/schemas\/ZapierEventType"},"url":{"type":"string","example":"Zapier webhook URL"},"active":{"type":"boolean","example":"Zapier hook is activated ?"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"last_run":{"type":"string","format":"date-time","nullable":true},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true},"state":{"oneOf":[{"$ref":"#\/components\/schemas\/State"}],"nullable":true},"state_details":{"type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}},"resend_synchronized_contacts":{"type":"boolean","example":"Resend synchronized contacts ?"}},"type":"object"},"ZapierResultItem":{"required":["id","name","source","event","url","active","created_on","updated_on","last_run","state","state_details","resend_synchronized_contacts"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Name of the Zapier hook"},"source":{"$ref":"#\/components\/schemas\/ZapierSourceType"},"event":{"$ref":"#\/components\/schemas\/ZapierEventType"},"url":{"type":"string","example":"Zapier webhook URL"},"active":{"type":"boolean","example":"Zapier hook is activated ?"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"last_run":{"type":"string","format":"date-time","nullable":true},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true},"state":{"oneOf":[{"$ref":"#\/components\/schemas\/State"}],"nullable":true},"state_details":{"type":"array","items":{"$ref":"#\/components\/schemas\/JobsResult"}},"resend_synchronized_contacts":{"type":"boolean","example":"Resend synchronized contacts ?"}},"type":"object"},"oauth.provider":{"description":"Oauth provider","type":"string","enum":["google","github","microsoft","sso"]},"stateFailure":{"required":["state","state_message"],"properties":{"state":{"description":"Success","type":"boolean","enum":[false]},"state_message":{"description":"Details of the error","type":"string"}},"type":"object"},"stateSuccess":{"required":["state"],"properties":{"state":{"description":"Success","type":"boolean","enum":[true]}},"type":"object"},"SearchResults":{"required":["number_of_results","number_of_pages","current_page","previous_page","next_page","results"],"properties":{"number_of_results":{"description":"Displays number of results","type":"integer","example":10},"number_of_pages":{"description":"Displays number of pages","type":"integer","example":3},"current_page":{"description":"Displays current page URL (This URL must be called with the GET method)","type":"string","example":"https:\/\/example.com\/example\/of\/dynamic\/url\/2"},"previous_page":{"description":"Displays previous page URL (This URL must be called with the GET method)","type":"string","example":"https:\/\/example.com\/example\/of\/dynamic\/url\/1","nullable":true},"next_page":{"description":"Displays next page URL (This URL must be called with the GET method)","type":"string","example":"https:\/\/example.com\/example\/of\/dynamic\/url\/3","nullable":true},"results":{"type":"array","items":{"type":"object"}}},"type":"object"},"Sharing":{"required":["sharing_type_to","read_permission","write_permission","delete_permission","ids_list","name"],"properties":{"sharing_type_to":{"$ref":"#\/components\/schemas\/SharingTypeTo"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"ids_list":{"description":"The list of ids that we will share to","type":"array","items":{"type":"integer"},"example":[1,2]},"name":{"type":"string","example":"Share to marketing and dev teams"}},"type":"object"},"SharingPermission":{"required":["read_permission","write_permission","delete_permission","is_admin"],"properties":{"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"is_admin":{"type":"boolean"}},"type":"object"},"SharingResponse":{"required":["sharing_type","sharing_type_to","read_permission","write_permission","delete_permission","sharing_targets","name"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Sharing"},{"properties":{"sharing_type":{"$ref":"#\/components\/schemas\/SharingType"},"sharing_type_to":{"$ref":"#\/components\/schemas\/SharingTypeTo"},"read_permission":{"type":"boolean"},"write_permission":{"type":"boolean"},"delete_permission":{"type":"boolean"},"sharing_targets":{"description":"The targets of the sharing","type":"array","items":{"$ref":"#\/components\/schemas\/SharingTarget"}},"created_on":{"type":"string","format":"date-time","example":"2022-07-11T10:13:42+00:00"},"name":{"type":"string","example":"Share to marketing and dev teams"}},"type":"object"}]},"SharingTarget":{"required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"My organization"}},"type":"object"},"SharingType":{"type":"string","enum":["ContactList","BlackList","DataField","EmailSignature","File","Integration","URLShortener","Tag","Template","Pool","Model","AiAgent","Workflow","PRMFilter","PRMContact","Report","ProgrammationStats","Filter"]},"SharingTypeTo":{"description":"ResellerCustomers is only allowed for Files, Models and Workflows","type":"string","enum":["Team","Organization","User","ResellerCustomers"]}},"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"},"ApiKeyAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}}},"tags":[{"name":"API","description":"API"},{"name":"API Keys","description":"API Keys"},{"name":"Affiliation","description":"Affiliation"},{"name":"AiAgents","description":"AiAgents"},{"name":"Blacklists","description":"Blacklists"},{"name":"Contact Lists","description":"Contact Lists"},{"name":"Crons","description":"Crons"},{"name":"Data Fields","description":"Data Fields"},{"name":"Email Signatures","description":"Email Signatures"},{"name":"Enrich","description":"Enrich"},{"name":"External API keys","description":"External API keys"},{"name":"Files","description":"Files"},{"name":"Folders","description":"Folders"},{"name":"Forms","description":"Forms"},{"name":"Integrations - Email","description":"Integrations - Email"},{"name":"Integrations - LinkedIn","description":"Integrations - LinkedIn"},{"name":"Jobs","description":"Jobs"},{"name":"Models - Email","description":"Models - Email"},{"name":"Models - LinkedIn Invitation","description":"Models - LinkedIn Invitation"},{"name":"Models - LinkedIn Message","description":"Models - LinkedIn Message"},{"name":"Models - SMS","description":"Models - SMS"},{"name":"Models - SMV","description":"Models - SMV"},{"name":"Organizations","description":"Organizations"},{"name":"OVH","description":"OVH"},{"name":"PRM","description":"PRM"},{"name":"Permissions","description":"Permissions"},{"name":"Pools","description":"Pools"},{"name":"Reporting","description":"Reporting"},{"name":"Resellers","description":"Resellers"},{"name":"Roles","description":"Roles"},{"name":"Statistics","description":"Statistics"},{"name":"Subscriptions","description":"Subscriptions"},{"name":"Tags","description":"Tags"},{"name":"Targeting - LinkedIn","description":"Targeting - LinkedIn"},{"name":"Targeting - Google","description":"Targeting - Google"},{"name":"Targeting - Database","description":"Targeting - Database"},{"name":"Teams","description":"Teams"},{"name":"URLs Shortener","description":"URLs Shortener"},{"name":"Unsubscribers","description":"Unsubscribers"},{"name":"Users","description":"Users"},{"name":"Webhooks","description":"Webhooks"},{"name":"Workflows","description":"Workflows"},{"name":"Zapier","description":"Zapier"}]}