On this page

Delete Contacts

Operation overview

DELETE/v3/marketing/contacts

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint can be used to delete one or more contacts.

The query parameter ids must set to a comma-separated list of contact IDs for bulk contact deletion.

The query parameter delete_all_contacts must be set to "true" to delete all contacts.

You must set either ids or delete_all_contacts.

Deletion jobs are processed asynchronously.

Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Query string

Property nameTypeRequiredDescription

delete_all_contactsstringOptional

Must be set to "true" to delete all contacts.

idsstringOptional

A comma-separated list of contact IDs.

Responses

202400401403404500

The deletion job has been accepted and is being processed.

Schema

Property nameTypeRequiredDescriptionChild properties

job_idobject

The deletion job ID.

Delete All Contacts

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  "delete_all_contacts": "true"
6};
7
8const request = {
9  url: `/v3/marketing/contacts`,
10  method: 'DELETE',
11  qs: queryParams
12}
13
14client.request(request)
15  .then(([response, body]) => {
16    console.log(response.statusCode);
17    console.log(response.body);
18  })
19  .catch(error => {
20    console.error(error);
21  });

Delete Contacts by ids

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  "ids": "1, 2"
6};
7
8const request = {
9  url: `/v3/marketing/contacts`,
10  method: 'DELETE',
11  qs: queryParams
12}
13
14client.request(request)
15  .then(([response, body]) => {
16    console.log(response.statusCode);
17    console.log(response.body);
18  })
19  .catch(error => {
20    console.error(error);
21  });