{"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-lmc-contactdb-v3/list-custom-field":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_custom_field","summary":"Retrieve all custom fields","description":"GET /v3/contactdb/custom_fields","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/create-custom-field":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_create_custom_field","summary":"Create a Custom Field","description":"POST /v3/contactdb/custom_fields","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/get-custom-field":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_get_custom_field","summary":"Retrieve a Custom Field","description":"GET /v3/contactdb/custom_fields/{custom_field_id}","tags":["communication"],"parameters":[{"name":"custom_field_id","in":"query","required":true,"description":"The ID of the custom field that you want to retrieve.","schema":{"type":"integer","description":"The ID of the custom field that you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/delete-custom-field":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_delete_custom_field","summary":"Delete a Custom Field","description":"DELETE /v3/contactdb/custom_fields/{custom_field_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["custom_field_id"],"properties":{"custom_field_id":{"type":"integer","description":"The ID of the custom field that you want to retrieve."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"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-lmc-contactdb-v3/list-contact-db-list":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_contact_db_list","summary":"Retrieve all lists","description":"GET /v3/contactdb/lists","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/create-contact-db-list":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_create_contact_db_list","summary":"Create a List","description":"POST /v3/contactdb/lists","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/delete-contact-db-lists":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_delete_contact_db_lists","summary":"Delete Multiple lists","description":"DELETE /v3/contactdb/lists","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/get-contact-db-list":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_get_contact_db_list","summary":"Retrieve a single list","description":"GET /v3/contactdb/lists/{list_id}","tags":["communication"],"parameters":[{"name":"list_id","in":"query","required":true,"schema":{"type":"integer"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/update-contact-db-list":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_update_contact_db_list","summary":"Update a List","description":"PATCH /v3/contactdb/lists/{list_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"integer"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/delete-contact-db-list":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_delete_contact_db_list","summary":"Delete a List","description":"DELETE /v3/contactdb/lists/{list_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"integer"},"delete_contacts":{"type":"boolean","enum":[true,false],"description":"Adds the ability to delete all contacts on the list in addition to deleting the list."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"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-lmc-contactdb-v3/list-recipients-from-contact-db-list":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_recipients_from_contact_db_list","summary":"Retrieve all recipients on a List","description":"GET /v3/contactdb/lists/{list_id}/recipients","tags":["communication"],"parameters":[{"name":"list_id","in":"query","required":true,"description":"The id of the list of recipients you want to retrieve.","schema":{"type":"integer","description":"The id of the list of recipients you want to retrieve."}},{"name":"page","in":"query","required":false,"description":"Page index of first recipient to return (must be a positive integer)","schema":{"type":"integer","description":"Page index of first recipient to return (must be a positive integer)"}},{"name":"page_size","in":"query","required":false,"description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)","schema":{"type":"integer","description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/add-recipients-to-contact-db-list":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_add_recipients_to_contact_db_list","summary":"Add Multiple Recipients to a List","description":"POST /v3/contactdb/lists/{list_id}/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"integer","description":"The id of the list of recipients you want to retrieve."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/add-recipient-to-contact-db-list":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_add_recipient_to_contact_db_list","summary":"Add a Single Recipient to a List","description":"POST /v3/contactdb/lists/{list_id}/recipients/{recipient_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","recipient_id"],"properties":{"list_id":{"type":"integer","description":"The ID of the list that you want to add the recipient to."},"recipient_id":{"type":"string","description":"The ID of the recipient you are adding to the list."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"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-lmc-contactdb-v3/delete-recipient-from-contact-db-list":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_delete_recipient_from_contact_db_list","summary":"Delete a Single Recipient from a Single List","description":"DELETE /v3/contactdb/lists/{list_id}/recipients/{recipient_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","recipient_id"],"properties":{"list_id":{"type":"integer","description":"The ID of the list that you want to add the recipient to."},"recipient_id":{"type":"string","description":"The ID of the recipient you are adding to the list."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"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-lmc-contactdb-v3/list-recipient":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_recipient","summary":"Retrieve recipients","description":"GET /v3/contactdb/recipients","tags":["communication"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page index of first recipients to return (must be a positive integer)","schema":{"type":"integer","description":"Page index of first recipients to return (must be a positive integer)"}},{"name":"page_size","in":"query","required":false,"description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)","schema":{"type":"integer","description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/add-recipient":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_add_recipient","summary":"Add recipients","description":"POST /v3/contactdb/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/update-recipient":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_update_recipient","summary":"Update Recipient","description":"PATCH /v3/contactdb/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/delete-recipients":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_delete_recipients","summary":"Delete Recipients","description":"DELETE /v3/contactdb/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/get-recipient":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_get_recipient","summary":"Retrieve a single recipient","description":"GET /v3/contactdb/recipients/{recipient_id}","tags":["communication"],"parameters":[{"name":"recipient_id","in":"query","required":true,"description":"The ID of the recipient that you want to retrieve.","schema":{"type":"string","description":"The ID of the recipient that you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/delete-recipient":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_delete_recipient","summary":"Delete a Recipient","description":"DELETE /v3/contactdb/recipients/{recipient_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipient_id"],"properties":{"recipient_id":{"type":"string","description":"The ID of the recipient that you want to retrieve."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"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-lmc-contactdb-v3/get-recipient-list":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_get_recipient_list","summary":"Retrieve the lists that a recipient is on","description":"GET /v3/contactdb/recipients/{recipient_id}/lists","tags":["communication"],"parameters":[{"name":"recipient_id","in":"query","required":true,"description":"The ID of the recipient for whom you are retrieving lists.","schema":{"type":"string","description":"The ID of the recipient for whom you are retrieving lists."}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/get-billable":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_get_billable","summary":"Retrieve the count of billable recipients","description":"GET /v3/contactdb/recipients/billable_count","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/list-recipient-count":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_recipient_count","summary":"Retrieve a Count of Recipients","description":"GET /v3/contactdb/recipients/count","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/list-search-recipient":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_search_recipient","summary":"Search recipients","description":"GET /v3/contactdb/recipients/search","tags":["communication"],"parameters":[{"name":"{field_name}","in":"query","required":false,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/search-recipient":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_search_recipient","summary":"Search recipients","description":"POST /v3/contactdb/recipients/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-lmc-contactdb-v3/list-reserved-field":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_reserved_field","summary":"Retrieve reserved fields","description":"GET /v3/contactdb/reserved_fields","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/list-segment":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_segment","summary":"Retrieve all segments","description":"GET /v3/contactdb/segments","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/create-segment":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_create_segment","summary":"Create a Segment","description":"POST /v3/contactdb/segments","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/get-segment":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_get_segment","summary":"Retrieve a segment","description":"GET /v3/contactdb/segments/{segment_id}","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"schema":{"type":"integer"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/update-segment":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_update_segment","summary":"Update a segment","description":"PATCH /v3/contactdb/segments/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"integer"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"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-lmc-contactdb-v3/delete-segment":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_delete_segment","summary":"Delete a segment","description":"DELETE /v3/contactdb/segments/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"integer"},"delete_contacts":{"type":"boolean","description":"True to delete all contacts matching the segment in addition to deleting the segment"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"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-lmc-contactdb-v3/list-recipient-for-segment":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_recipient_for_segment","summary":"Retrieve recipients on a segment","description":"GET /v3/contactdb/segments/{segment_id}/recipients","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"description":"The ID of the segment from which you want to retrieve recipients.","schema":{"type":"integer","description":"The ID of the segment from which you want to retrieve recipients."}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/list-status":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_status","summary":"Get Recipient Upload Status","description":"GET /v3/contactdb/status","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"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-lmc-contactdb-v3/list-export-recipient":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_list_export_recipient","summary":"Get All Existing Exports","description":"GET /v3/contactdb/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-lmc-contactdb-v3/export-recipient":{"post":{"operationId":"communication_sendgrid_lmc_contactdb_v3_export_recipient","summary":"Export Recipients","description":"POST /v3/contactdb/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-lmc-contactdb-v3/get-export-recipient":{"get":{"operationId":"communication_sendgrid_lmc_contactdb_v3_get_export_recipient","summary":"Export Recipients Status","description":"GET /v3/contactdb/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"}}},"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"}}}}}}}