post https://api.middesk.com/v1/signals/batches
This endpoint is used to create a new Signal Batch. Once created, the Signal Batch will automatically begin the process of providing signal for all the Businesses specified in the batch concurrently. Results for a signal batch can be retrieved using the List all Signals endpoint and passing the batch_id returned by this endpoint as a query parameter.
CSV Format
The first row in your CSV should include all Column Titles for which you'd like to provide information (minimally all required headers, you may leave optional columns out entirely). Every following row should be a sequence of values associated to each Column Title.
Any potential errors due to invalid column values are explained in the Errors column.
| Column Title | Description | Example | Required | Errors |
|---|---|---|---|---|
| name | The Business name | Middesk | Required | Name can't be blank |
| address, address1, address2 | The full Business address. Submit up to three addresses. | 577 Howard St, San Francisco, CA 94105 | Required if address components are not provided. At least one address required. | Address can't be blank |
| address_line1, address1_line1, address2_line1 | The Business street address | 577 Howard St | Required if address is not provided | N/A |
| address_line2, address1_line2, address2_line2 | The Business secondary street address (e.g. Floor #, Suite #) | Suite 400 | Required if address is not provided | N/A |
| address_city, address1_city, address2_city | The city in which the Business operates | San Francisco | Required if address is not provided | N/A |
| address_state, address1_state, address2_state | The state in which the Business operates. Please use a two character state abbreviation | CA | Required if address is not provided | N/A |
| address_postal_code, address1_postal_code, address2_postal_code | The postal code in which the Business operates | 94105 | Required if address is not provided | N/A |
| person_name1, person_name2 ... person_name3 | The name of a person associated with the Business | Kyle Mack | Not Required | N/A |
| external_id | A custom id that can be attached to this | 12345678 | Not Required | The custom id must be unique in the collection of businesses you submit within the batch. |
| tin | The Tax Identification Number (TIN) of the Business | 123410000 | Not Required | N/A |