{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sendgrid-verified-senders-v3/list-verified-sender":{"get":{"operationId":"communication_sendgrid_verified_senders_v3_list_verified_sender","summary":"Get All Verified Senders","description":"GET /v3/verified_senders","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Specifies the number of results to be returned by the API. This parameter can be used to limit the results returned or in combination with…","schema":{"type":"number","description":"Specifies the number of results to be returned by the API. This parameter can be used to limit the results returned or in combination with…"}},{"name":"lastSeenID","in":"query","required":false,"description":"Returns senders with an ID number occurring after the passed in ID. In other words, the `lastSeenID` provides a starting point from which…","schema":{"type":"number","description":"Returns senders with an ID number occurring after the passed in ID. In other words, the `lastSeenID` provides a starting point from which…"}},{"name":"id","in":"query","required":false,"description":"Returns information about only the Sender Identity passed in the request.","schema":{"type":"integer","description":"Returns information about only the Sender Identity passed in the request."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-verified-senders-v3/create-verified-sender":{"post":{"operationId":"communication_sendgrid_verified_senders_v3_create_verified_sender","summary":"Create Verified Sender Request","description":"POST /v3/verified_senders","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-verified-senders-v3/update-verified-sender":{"post":{"operationId":"communication_sendgrid_verified_senders_v3_update_verified_sender","summary":"Edit Verified Sender","description":"PATCH /v3/verified_senders/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-verified-senders-v3/delete-verified-sender":{"post":{"operationId":"communication_sendgrid_verified_senders_v3_delete_verified_sender","summary":"Delete Verified Sender","description":"DELETE /v3/verified_senders/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-verified-senders-v3/list-verified-sender-domain":{"get":{"operationId":"communication_sendgrid_verified_senders_v3_list_verified_sender_domain","summary":"Domain Warn List","description":"GET /v3/verified_senders/domains","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-verified-senders-v3/resend-verified-sender":{"post":{"operationId":"communication_sendgrid_verified_senders_v3_resend_verified_sender","summary":"Resend Verified Sender Request","description":"POST /v3/verified_senders/resend/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-verified-senders-v3/list-verified-sender-steps-completed":{"get":{"operationId":"communication_sendgrid_verified_senders_v3_list_verified_sender_steps_completed","summary":"Completed Steps","description":"GET /v3/verified_senders/steps_completed","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-verified-senders-v3/verify-sender-token":{"get":{"operationId":"communication_sendgrid_verified_senders_v3_verify_sender_token","summary":"Verify Sender Request","description":"GET /v3/verified_senders/verify/{token}","tags":["communication"],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}