Insert a New Record

Use this endpoint to add a new record to our system. By default, each project can only have one instance of a phone number. To allow duplicate phone numbers within a project, contact your Client Success Account Team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Required Permissions

  • Record Insert

Custom Fields

Drips allows for the inclusion of custom fields with each API call. These custom fields are stored with the record and can be used in webhooks and templates, but they are not included in reports.


Form Data
string
required

The numeric phone number of the record.

The length of the phone number will vary by the CountryCode used. Please do not include CountryCode within the Phone field.
Size Range: 9,10

int32
Defaults to 1

The country code of the record's phone.

Allowed Values: 1, 61, 44

string
required

The postal code or regional code for the record.

Size Range: 5,6
This allows us to target the record by time zone.

string

The abbreviation for the state or region depending on country code.
The full state name is accepted as well.

string

The record's first name.

It is important to include the records first name as it can be included in SMS message templates.

string

The records last name.

string

The record's associated email address.

string

Your internal ID associated with the current record.

string

A phone number to send this record to upon transfer.

While all projects have default settings for call transfers, you can specify a specific DID for individual records. If you provide a DID at the record level, it will always override the project's default settings.

Size Range: 9,10

int32
Defaults to 1

The country code that is used when overriding DID.

Allowed Values: 1, 61, 44

string

A phone number to send this record to upon transfer from an inbound action.

Like DID, you can also specify a new InboundDID specifically for if they call inbound vs us placing an outbound call.

Size Range: 9,10

int32
Defaults to 1

The country code that is used when overriding inbound DIDs.

Allowed Values: 1, 61, 44

float

The monetary cost of the record.

To provide comprehensive analytics on your costs, we recommend submitting the cost associated with generating each individual record. The information will help us accurately track your expenses and offer valuable insights.

float

The additional monetary cost associated with this record.

In addition to the cost of generating the record, you can submit any external costs associated with processing the record. This includes fees from third-party systems, such as record distribution platforms.

string

Drive to Site Projects Only
This is the URL specific to the endpoint you would like us to drive users back to. The Long URL must be posted within a record on insert.

Allowed Values: 1000 character limit.

string

This will show the full results of the operation requested.

In order to utilize async call responses (Webhooks), you need to store the token returned in the original response.

string

You can categorize records into different groups for more granular reporting. To maintain data integrity and simplify analysis, limit the number of unique subgroups.

Avoid using values in subgroups that are specific to individual records, like unique campaign IDs. Excessive variation in these fields can hinder reporting accuracy. We recommend limiting subgroups to no more than 10 distinct values. If you need more options, refer to our documentation on custom fields.

string

A value used for categorizing records for detailed reporting.

Avoid using values in subgroups that are specific to individual records, like unique campaign IDs. Excessive variation in these fields can hinder reporting accuracy. We recommend limiting subgroups to no more than 10 distinct values. If you need more options, refer to our documentation on custom fields.

string

A value used for categorizing records for detailed reporting.

Avoid using values in subgroups that are specific to individual records, like unique campaign IDs. Excessive variation in these fields can hinder reporting accuracy. We recommend limiting subgroups to no more than 10 distinct values. If you need more options, refer to our documentation on custom fields.

string

A value used for categorizing records for detailed reporting.

Avoid using values in subgroups that are specific to individual records, like unique campaign IDs. Excessive variation in these fields can hinder reporting accuracy. We recommend limiting subgroups to no more than 10 distinct values. If you need more options, refer to our documentation on custom fields.

Response

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json