{"swaggerDoc":{"swagger":"2.0","info":{"description":"This is the qooqie API documentation\n","version":"1.1.1","title":"qooqie API","contact":{"email":"mark@qooqie.com"}},"host":"api.qooqie.com","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"security":[{"JWT":[]}],"paths":{"/campaigns":{"post":{"tags":["campaigns"],"summary":"Add a new leadgenerator campaign with a calltracking phone number","operationId":"addCustomer","parameters":[{"in":"body","name":"body","description":"Campaign object that needs to be added","required":true,"schema":{"$ref":"#/definitions/AddCampaign"}}],"responses":{"200":{"description":"Request accepted"},"405":{"description":"Invalid input"}}},"put":{"tags":["campaigns"],"summary":"Update an existing leadgenerator campaign","operationId":"updateCampaign","parameters":[{"in":"body","name":"body","description":"Customer object that needs to be updated","required":true,"schema":{"$ref":"#/definitions/UpdateCampaign"}}],"responses":{"200":{"description":"Request accepted"},"400":{"description":"Invalid externalID supplied"},"404":{"description":"Customer not found"},"405":{"description":"Validation exception"}}}},"/campaigns/additional":{"post":{"tags":["campaigns"],"summary":"Request a new calltracking phone number (extra campaign) for an existing leadgenerator customer (external_id)","operationId":"AdditionalCampaign","parameters":[{"in":"body","name":"body","description":"Campaign object that needs to be added","required":true,"schema":{"$ref":"#/definitions/AdditionalCampaign"}}],"responses":{"200":{"description":"Request accepted"},"405":{"description":"Invalid input"}}}},"/campaigns/restore":{"put":{"tags":["campaigns"],"summary":"Unquarantine a campaign calltracking phone number","operationId":"restoreCustomer","parameters":[{"in":"body","name":"body","description":"Customer object that needs to be restored","required":true,"schema":{"$ref":"#/definitions/RestoreCampaign"}}],"responses":{"200":{"description":"Request accepted"},"400":{"description":"Invalid externalID supplied"},"404":{"description":"Campaign not found"},"405":{"description":"Validation exception"}}}},"/campaigns/{externalId}":{"delete":{"tags":["campaigns"],"summary":"Quarantine a campaign calltracking phone number","operationId":"quarantineCustomer","parameters":[{"name":"api_key","in":"header","required":false,"type":"string"},{"name":"externalId","in":"path","description":"External ID of the campaign to quarantine","required":true,"type":"string"}],"responses":{"200":{"description":"Request accepted"},"400":{"description":"Invalid externalID supplied"},"404":{"description":"Campaign not found"}}}},"/campaigns/request_international_number":{"post":{"tags":["campaigns"],"summary":"Request a new international number used for a campaign","operationId":"RequestInternationalNumber","consumes":"multipart/form-data","parameters":[{"in":"body","name":"body","description":"Request object that needs to be added","required":true,"schema":{"$ref":"#/definitions/RequestInternationalNumber"}}],"responses":{"200":{"description":"Request accepted"},"405":{"description":"Invalid input"}}}}},"securityDefinitions":{"JWT":{"description":"","type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"AddCampaign":{"type":"object","required":["externalId","name","phoneNumber","postcode","streetNumber","whisper"],"properties":{"externalId":{"type":"string"},"phoneNumber":{"type":"string"},"areacode":{"type":"string"},"regionCode":{"type":"string","minLength":2,"maxLength":2},"name":{"type":"string"},"companyNumber":{"type":"string"},"postcode":{"type":"string"},"street":{"type":"string"},"streetNumber":{"type":"string"},"place":{"type":"string"},"companyName":{"type":"string"},"email":{"type":"string"},"whisper":{"type":"boolean"},"portingNumber":{"type":"string"},"mediaType":{"type":"string"}},"example":{"phoneNumber":"31850199999","portingNumber":"31850193099","regionCode":"NL","areacode":"10","companyNumber":"24431378","name":"Qooqie N.V.","postcode":"3011 KA","street":"Goudsesingel","streetNumber":"8a","place":"Rotterdam","companyName":"Qooqie N.V.","externalId":"24431378","email":"info@qooqie.com","whisper":true,"mediaType":"leadgenerator"}},"AdditionalCampaign":{"type":"object","required":["externalId","name","phoneNumber","postcode","streetNumber","whisper","mediaType"],"properties":{"externalId":{"type":"string"},"phoneNumber":{"type":"string"},"areacode":{"type":"string"},"regionCode":{"type":"string","minLength":2,"maxLength":2},"name":{"type":"string"},"companyNumber":{"type":"string"},"postcode":{"type":"string"},"street":{"type":"string"},"streetNumber":{"type":"string"},"place":{"type":"string"},"companyName":{"type":"string"},"email":{"type":"string"},"whisper":{"type":"boolean"},"portingNumber":{"type":"string"},"mediaType":{"type":"string"}},"example":{"phoneNumber":"31850199999","portingNumber":"31850193099","regionCode":"NL","areacode":"10","companyNumber":"24431378","name":"Qooqie N.V.","postcode":"3011 KA","street":"Goudsesingel","streetNumber":"8a","place":"Rotterdam","companyName":"Qooqie N.V.","externalId":"24431378","email":"info@qooqie.com","whisper":true,"mediaType":"leadgenerator"}},"UpdateCampaign":{"type":"object","required":["externalId","phoneNumber","postcode","streetNumber","name","whisper"],"properties":{"externalId":{"type":"string"},"phoneNumber":{"type":"string"},"areacode":{"type":"string"},"regionCode":{"type":"string","minLength":2,"maxLength":2},"name":{"type":"string"},"companyNumber":{"type":"string"},"postcode":{"type":"string"},"street":{"type":"string"},"streetNumber":{"type":"string"},"place":{"type":"string"},"companyName":{"type":"string"},"email":{"type":"string"},"whisper":{"type":"boolean"}},"example":{"phoneNumber":"31850199999","regionCode":"NL","areacode":"10","companyNumber":"24431378","name":"Qooqie N.V.","postcode":"3011 KA","street":"Goudsesingel","streetNumber":"8a","place":"Rotterdam","companyName":"Qooqie N.V.","externalId":"24431378","email":"info@qooqie.com","whisper":true}},"RestoreCampaign":{"type":"object","required":["externalId","phoneNumber","postcode","streetNumber","name","whisper"],"properties":{"externalId":{"type":"string"},"phoneNumber":{"type":"string"},"areacode":{"type":"string"},"regionCode":{"type":"string","minLength":2,"maxLength":2},"name":{"type":"string"},"companyNumber":{"type":"string"},"postcode":{"type":"string"},"street":{"type":"string"},"streetNumber":{"type":"string"},"place":{"type":"string"},"companyName":{"type":"string"},"email":{"type":"string"},"whisper":{"type":"boolean"}},"example":{"phoneNumber":"31850199999","regionCode":"NL","areacode":"10","companyNumber":"24431378","name":"Qooqie N.V.","postcode":"3011 KA","street":"Goudsesingel","streetNumber":"8a","place":"Rotterdam","companyName":"Qooqie N.V.","externalId":"24431378","email":"info@qooqie.com","whisper":true}},"RequestInternationalNumber":{"type":"object","required":["externalId","name","phoneNumber","postcode","streetNumber","whisper","regionCode","areacode"],"properties":{"externalId":{"type":"string"},"phoneNumber":{"type":"string"},"areacode":{"type":"string"},"regionCode":{"type":"string","minLength":2,"maxLength":2},"name":{"type":"string"},"companyNumber":{"type":"string"},"postcode":{"type":"string"},"street":{"type":"string"},"streetNumber":{"type":"string"},"place":{"type":"string"},"companyName":{"type":"string"},"email":{"type":"string"},"whisper":{"type":"string"},"mediaType":{"type":"string"},"doc1":{"type":"file"},"doc2":{"type":"file"},"doc3":{"type":"file"}},"example":{"phoneNumber":"31850199999","regionCode":"NL","areacode":"10","companyNumber":"24431378","name":"Qooqie N.V.","postcode":"3011 KA","street":"Goudsesingel","streetNumber":"8a","place":"Rotterdam","companyName":"Qooqie N.V.","externalId":"24431378","email":"info@qooqie.com","whisper":true,"mediaType":"leadgenerator"}}},"basePath":"/rest/1.0"},"customOptions":{}}