Delete a thread

DELETE

/v1/email/threads/{thread_id}

await bird.email.threads.delete("thr_01abc", { permanent: true });

client.email.threads.delete("thr_01krdgeqcxet5s7t44vh8rt9mg", permanent=True)

if err := client.Email.Threads.Delete(context.Background(), "thr_123", bird.EmailThreadsDeleteParams{Permanent: true}); err != nil {
	log.Fatal(err)
}

$bird->email->threads->delete('thr_01krdgeqcxet5s7t44vh8rt9mg');

bird email threads delete <thread-id> --yes

curl -X DELETE "https://us1.platform.bird.com/v1/email/threads/{thread_id}" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "permanent=false"

Moves the conversation and all of its messages to the trash. Trashed messages are permanently deleted after 30 days, or sooner if the mailbox's retention period ends first. Pass permanent=true to permanently delete the conversation and its messages immediately.

Parameter

thread_id

string

Thread identifier. Starts with thr_.

Parameter Kueri

permanent

boolean

Permanently delete the conversation and its messages immediately instead of moving them to the trash.

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideGetting started with email Explore the capabilityEmail Follow the learning pathBuild your first integration Implementation guideSend your first email

Try the practice and get an implementation brief

await bird.email.threads.delete("thr_01abc", { permanent: true });

client.email.threads.delete("thr_01krdgeqcxet5s7t44vh8rt9mg", permanent=True)

if err := client.Email.Threads.Delete(context.Background(), "thr_123", bird.EmailThreadsDeleteParams{Permanent: true}); err != nil {
	log.Fatal(err)
}

$bird->email->threads->delete('thr_01krdgeqcxet5s7t44vh8rt9mg');

bird email threads delete <thread-id> --yes

curl -X DELETE "https://us1.platform.bird.com/v1/email/threads/{thread_id}" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "permanent=false"