doc: improve contact#doc

resend · Jan 15, 2024 · 8ef870d · 8ef870d
1 parent 2b6fdc8
commit 8ef870d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/lib/resend/contacts.rb b/lib/resend/contacts.rb
@@ -25,7 +25,13 @@ def list(audience_id)
         Resend::Request.new(path, {}, "get").perform
       end
 
-      # https://resend.com/docs/api-reference/contacts/delete-contact
+      #
+      # Remove a contact from an audience
+      #
+      # @param audience_id [String] the audience id
+      # @param contact_id [String] either the contact id or contact email
+      #
+      # see also: https://resend.com/docs/api-reference/contacts/delete-contact
       def remove(audience_id, contact_id)
         path = "audiences/#{audience_id}/contacts/#{contact_id}"
         Resend::Request.new(path, {}, "delete").perform