{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sendgrid-mc-contacts-v3/list-contact":{"get":{"operationId":"communication_sendgrid_mc_contacts_v3_list_contact","summary":"Get Sample Contacts","description":"GET /v3/marketing/contacts","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-mc-contacts-v3/update-contact":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_update_contact","summary":"Add or Update a Contact","description":"PUT /v3/marketing/contacts","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-mc-contacts-v3/delete-contact":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_delete_contact","summary":"Delete Contacts","description":"DELETE /v3/marketing/contacts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"delete_all_contacts":{"type":"string","description":"Must be set to `\"true\"` to delete all contacts."},"ids":{"type":"string","description":"A comma-separated list of contact IDs."}}}}}},"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-mc-contacts-v3/get-contact":{"get":{"operationId":"communication_sendgrid_mc_contacts_v3_get_contact","summary":"Get a Contact by ID","description":"GET /v3/marketing/contacts/{id}","tags":["communication"],"parameters":[{"name":"id","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"}},"/v1/communication:sendgrid-mc-contacts-v3/list-batched-contact":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_list_batched_contact","summary":"Get Batched Contacts by IDs","description":"POST /v3/marketing/contacts/batch","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-mc-contacts-v3/delete-contact-identifier":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_delete_contact_identifier","summary":"Delete a Contact Identifier","description":"DELETE /v3/marketing/contacts/{contact_id}/identifiers","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contact_id"],"properties":{"contact_id":{"type":"string","description":"Must be set to the `contact_id` of the contact you want to remove the identifier from."},"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-mc-contacts-v3/list-contact-count":{"get":{"operationId":"communication_sendgrid_mc_contacts_v3_list_contact_count","summary":"Get Total Contact Count","description":"GET /v3/marketing/contacts/count","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-mc-contacts-v3/list-export-contact":{"get":{"operationId":"communication_sendgrid_mc_contacts_v3_list_export_contact","summary":"Get All Existing Exports","description":"GET /v3/marketing/contacts/exports","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-mc-contacts-v3/export-contact":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_export_contact","summary":"Export Contacts","description":"POST /v3/marketing/contacts/exports","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-mc-contacts-v3/get-export-contact":{"get":{"operationId":"communication_sendgrid_mc_contacts_v3_get_export_contact","summary":"Export Contacts Status","description":"GET /v3/marketing/contacts/exports/{id}","tags":["communication"],"parameters":[{"name":"id","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"}},"/v1/communication:sendgrid-mc-contacts-v3/import-contact":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_import_contact","summary":"Import Contacts","description":"PUT /v3/marketing/contacts/imports","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-mc-contacts-v3/get-import-contact":{"get":{"operationId":"communication_sendgrid_mc_contacts_v3_get_import_contact","summary":"Import Contacts Status","description":"GET /v3/marketing/contacts/imports/{id}","tags":["communication"],"parameters":[{"name":"id","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"}},"/v1/communication:sendgrid-mc-contacts-v3/search-contact":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_search_contact","summary":"Search Contacts","description":"POST /v3/marketing/contacts/search","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-mc-contacts-v3/list-contact-by-email":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_list_contact_by_email","summary":"Get Contacts by Emails","description":"POST /v3/marketing/contacts/search/emails","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-mc-contacts-v3/get-contact-by-identifiers":{"post":{"operationId":"communication_sendgrid_mc_contacts_v3_get_contact_by_identifiers","summary":"Get Contacts by Identifiers","description":"POST /v3/marketing/contacts/search/identifiers/{identifier_type}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier_type"],"properties":{"identifier_type":{"type":"string","enum":["email","phone_number_id","external_id","anonymous_id"],"description":"The type of identifier to search for. You can use only one type of identifier per search."},"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"}}},"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"}}}}}}}