object ContactsApiListsAddMultipleRecipientsToListResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiListsAddSingleRecipientResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiListsCreateNewListRequest

{
  "type": "object",
  "title": "Create a List request",
  "example": {
    "name": "your list name"
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    }
  }
}

object ContactsApiListsDeleteListByIdRequest

{
  "nullable": true
}

object ContactsApiListsDeleteListByIdResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

array ContactsApiListsDeleteMultipleListsRequest

{
  "type": "array",
  "items": {
    "type": "integer"
  },
  "example": [
    1,
    2,
    3,
    4
  ]
}

object ContactsApiListsDeleteMultipleListsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiListsDeleteRecipientResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiListsGetAllListsResponse

{
  "type": "object",
  "title": "List All Lists response",
  "required": [
    "lists"
  ],
  "properties": {
    "lists": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactdb_list"
      }
    }
  }
}

object ContactsApiListsGetAllRecipients404Response

{
  "type": "object",
  "example": {
    "errors": [
      {
        "field": "list_id",
        "message": "Returned if list_id is invalid"
      }
    ]
  },
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "list_id"
          },
          "message": {
            "type": "string",
            "example": "Returned if list_id is invalid"
          }
        }
      }
    }
  }
}

object ContactsApiListsGetAllRecipientsResponse

{
  "type": "object",
  "properties": {
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactdb_recipient"
      }
    }
  }
}

object ContactsApiListsUpdateListNameRequest

{
  "type": "object",
  "title": "Update a List request",
  "example": {
    "name": "newlistname"
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The new name for your list. "
    }
  }
}

object ContactsApiListsUpdateListNameResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the list"
    },
    "name": {
      "type": "string",
      "description": "The new name for the list"
    },
    "recipient_count": {
      "type": "integer",
      "description": "The number of recipients on the list"
    }
  }
}

array ContactsApiRecipientsAddRecipientRequest

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "email"
    ],
    "properties": {
      "age": {
        "type": "integer"
      },
      "email": {
        "type": "string",
        "format": "email",
        "description": "The email address of the recipient."
      },
      "last_name": {
        "type": "string",
        "description": "The last name of the recipient."
      },
      "first_name": {
        "type": "string",
        "description": "The first name of the recipient."
      }
    }
  },
  "example": [
    {
      "age": 25,
      "email": "example@example.com",
      "last_name": "User",
      "first_name": ""
    },
    {
      "age": 25,
      "email": "example2@example.com",
      "last_name": "User",
      "first_name": "Example"
    }
  ]
}

array ContactsApiRecipientsDeleteMultipleRecipientsRequest

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "example": [
    "recipient_id1",
    "recipient_id2"
  ]
}

object ContactsApiRecipientsDeleteMultipleRecipientsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiRecipientsDeleteRecipientByIdResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiRecipientsGetAllRecipients400Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiRecipientsGetAllRecipientsResponse

{
  "type": "object",
  "title": "List Recipients response",
  "required": [
    "recipients"
  ],
  "properties": {
    "recipients": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

object ContactsApiRecipientsGetRecipientListsResponse

{
  "type": "object",
  "properties": {
    "lists": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactdb_list"
      }
    }
  }
}

object ContactsApiRecipientsGetSingleRecipient404Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiRecipientsGetSingleRecipientResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiRecipientsGetUploadStatusResponse

{
  "type": "object",
  "properties": {
    "status": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "": {
            "type": "string"
          },
          "id": {
            "type": "string",
            "default": "",
            "description": "Valid values are \"worker_delay\" and \"worker_delay_seconds\" (the second value appears only if \"worker_delay\" has a value of \"delayed\")."
          },
          "value": {
            "type": "string",
            "default": "",
            "description": "Valid values for the ID \"worker_delay\" are \"OK\" or \"Delayed\". Valid values for the ID \"worker_delay_seconds\" is the time of delay to upload."
          }
        }
      }
    }
  }
}

object ContactsApiRecipientsSearchBySegmentConditionsRequest

{
  "type": "object",
  "example": {
    "list_id": -27497588,
    "conditions": [
      {
        "field": "birthday",
        "value": "01/12/1985",
        "and_or": "",
        "operator": "eq"
      },
      {
        "field": "birthday",
        "value": "01/12/1985",
        "and_or": "",
        "operator": "eq"
      },
      {
        "field": "birthday",
        "value": "01/12/1985",
        "and_or": "",
        "operator": "eq"
      },
      {
        "field": "birthday",
        "value": "01/12/1985",
        "and_or": "",
        "operator": "eq"
      }
    ]
  },
  "required": [
    "list_id",
    "conditions"
  ],
  "properties": {
    "list_id": {
      "type": "integer",
      "format": "int32"
    },
    "conditions": {
      "type": "array",
      "items": {
        "x-field": "birthday",
        "x-value": "01/12/1985",
        "x-and_or": "",
        "x-operator": "eq"
      }
    }
  }
}

object ContactsApiRecipientsSearchBySegmentConditionsResponse

{
  "type": "object",
  "properties": {
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "created_at": {
            "type": "integer"
          },
          "first_name": {
            "type": "string"
          },
          "updated_at": {
            "type": "integer"
          },
          "last_opened": {
            "type": "integer"
          },
          "last_clicked": {
            "type": "integer"
          },
          "last_emailed": {
            "type": "integer"
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "value": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "string"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "recipient_count": {
      "type": "integer"
    }
  }
}

object ContactsApiRecipientsSearchRecipientByFieldResponse

{
  "type": "object",
  "properties": {
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactdb_recipient"
      }
    }
  }
}

array ContactsApiRecipientsUpdateMultipleRecipientsRequest

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "email"
    ],
    "properties": {
      "email": {
        "type": "string",
        "format": "email"
      },
      "last_name": {
        "type": "string",
        "description": "The last name of the recipient. This is one of the default custom fields."
      },
      "first_name": {
        "type": "string",
        "description": "The first name of the recipient. This is one of the default custom fields."
      }
    }
  },
  "example": [
    {
      "email": "jones@example.com",
      "last_name": "Jones",
      "first_name": "Guy"
    }
  ]
}

object ContactsApiSegmentsDeleteSegmentResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiSegmentsGetAllSegmentsResponse

{
  "type": "object",
  "title": "List All Segments response",
  "required": [
    "segments"
  ],
  "properties": {
    "segments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactdb_segments"
      }
    }
  }
}

object ContactsApiSegmentsGetSegmentRecipients400Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiSegmentsGetSegmentRecipients404Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsApiSegmentsGetSegmentRecipientsResponse

{
  "type": "object",
  "title": "List Recipients On a Segment response",
  "required": [
    "recipients"
  ],
  "properties": {
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactdb_recipient"
      }
    }
  }
}

object ContactsApiSegmentsUpdateSegmentRequest

{
  "type": "object",
  "example": {
    "name": "The Millers",
    "list_id": 5,
    "conditions": [
      {
        "field": "last_name",
        "value": "Miller",
        "and_or": "",
        "operator": "eq"
      }
    ]
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "list_id": {
      "type": "number",
      "description": "The list ID you would like this segment to be built from."
    },
    "conditions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactdb_segments_conditions"
      },
      "description": "The conditions by which this segment should be created."
    }
  }
}

object ContactsCheckExportStatusResponse

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/error"
      }
    }
  }
}

object ContactsCheckImportStatusResponse

{
  "type": "object",
  "properties": {
    "errors": {
      "$ref": "#/components/schemas/error"
    }
  }
}

object ContactsDeleteBulkContacts400Response

{
  "type": "object",
  "required": [
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

object ContactsDeleteBulkContactsResponse

{
  "type": "object",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "object",
      "description": "The deletion job ID."
    }
  },
  "description": "The deletion job has been accepted and is being processed."
}

object ContactsExportListsSegments400Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/error"
      }
    }
  }
}

object ContactsExportListsSegmentsRequest

{
  "type": "object",
  "properties": {
    "list_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "IDs of the contact lists you want to export."
    },
    "file_type": {
      "enum": [
        "csv",
        "json"
      ],
      "type": "string",
      "default": "csv",
      "description": "File type for export file. Choose from `json` or `csv`."
    },
    "segment_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "IDs of the contact segments you want to export."
    },
    "max_file_size": {
      "type": "integer",
      "default": 5000,
      "description": "The maximum size of an export file in MB. Note that when this option is specified, multiple output files may be returned from the export."
    },
    "notifications": {
      "type": "object",
      "properties": {
        "email": {
          "type": "boolean"
        }
      }
    }
  }
}

object ContactsExportListsSegmentsResponse

{
  "type": "object",
  "required": [
    "_metadata"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the export job."
    },
    "_metadata": {
      "$ref": "#/components/schemas/metadata"
    }
  }
}

object ContactsGetAllExports400Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "error_id": {
            "type": "string"
          }
        }
      }
    }
  }
}

object ContactsGetAllExportsResponse

{
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Export jobs ID."
          },
          "urls": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "One or more download URLs for the contact file(s) if the status is `ready`."
          },
          "lists": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "ID": {
                  "type": "string"
                },
                "Name": {
                  "type": "string"
                }
              }
            }
          },
          "status": {
            "type": "string",
            "description": "Allowed values: `pending`, `ready`, or `failure`."
          },
          "user_id": {
            "type": "string",
            "description": "User ID."
          },
          "segments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "ID": {
                  "type": "string"
                },
                "Name": {
                  "type": "string"
                }
              }
            }
          },
          "_metadata": {
            "type": "object",
            "properties": {
              "next": {
                "type": "string"
              },
              "prev": {
                "type": "string"
              },
              "self": {
                "type": "string"
              }
            }
          },
          "created_at": {
            "type": "string",
            "description": "This ISO8601 timestamp when the export was created."
          },
          "expires_at": {
            "type": "string",
            "description": "This ISO8601 timestamp when the export expires."
          },
          "export_type": {
            "type": "string",
            "description": "Allowed types: `contacts_export`, `list_export`, or `segment_export`."
          },
          "completed_at": {
            "type": "string",
            "description": "This ISO8601 timestamp when the export was completed."
          }
        }
      }
    },
    "_metadata": {
      "type": "object",
      "properties": {
        "next": {
          "type": "string",
          "description": "Link to next page."
        },
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Link to this page."
        }
      }
    }
  }
}

object ContactsGetBatchedByIds404Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsGetBatchedByIdsRequest

{
  "type": "object",
  "example": {
    "ids": [
      "1234",
      "1235"
    ]
  },
  "required": [
    "ids"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 100
    }
  },
  "description": "Array of IDs"
}

object ContactsGetBatchedByIdsResponse

{
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contact-details3"
      }
    }
  }
}

object ContactsGetRecentContacts400Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/error"
      }
    }
  }
}

object ContactsGetRecentContacts404Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ContactsGetRecentContactsResponse

{
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contact-details3"
      }
    },
    "_metadata": {
      "$ref": "#/components/schemas/selfmetadata"
    },
    "contact_count": {
      "type": "integer"
    }
  }
}

object ContactsGetTotalCountResponse

{
  "type": "object",
  "required": [
    "contact_count"
  ],
  "properties": {
    "contact_count": {
      "type": "integer",
      "description": "The total number of contacts."
    },
    "billable_count": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "The count of contacts this month for billing purposes."
    },
    "billable_breakdown": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "description": "The sum of all the subuser's billable contacts"
        },
        "breakdown": {
          "type": "object",
          "description": "A map of each subuser's billable contact usage. Each key is the subuser's ID and each value is the usage thus far this month.",
          "minProperties": 0
        }
      },
      "description": "`billable_breakdown` will only appear to the parent user in an account with subusers."
    }
  }
}

object ContactsImportCsv400Response

{
  "type": "object",
  "required": [
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/error"
      },
      "uniqueItems": true
    }
  }
}