ContactControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
create_contactpost /contactsCreate a contact
delete_contactdelete /contacts/{contactId}Delete contact
get_all_contactsget /contacts/paginatedGet all contacts
get_contactget /contacts/{contactId}Get contact
get_contact_v_cardget /contacts/{contactId}/downloadGet contact vCard vcf file
get_contactsget /contactsGet all contacts

create_contact

crate::models::ContactDto create_contact(create_contact_options) Create a contact

Parameters

NameTypeDescriptionRequiredNotes
create_contact_optionsCreateContactOptionscreateContactOptions[required]

Return type

crate::models::ContactDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_contact

delete_contact(contact_id) Delete contact

Parameters

NameTypeDescriptionRequiredNotes
contact_idStringcontactId[required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_all_contacts

crate::models::PageContactProjection get_all_contacts(before, page, since, size, sort) Get all contacts

Parameters

NameTypeDescriptionRequiredNotes
beforeOption<String>Filter by created at before the given timestamp
pageOption<i32>Optional page in list pagination[default to 0]
sinceOption<String>Filter by created at after the given timestamp
sizeOption<i32>Optional page size in list pagination[default to 20]
sortOption<String>Optional createdAt sort direction ASC or DESC[default to ASC]

Return type

crate::models::PageContactProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_contact

crate::models::ContactDto get_contact(contact_id) Get contact

Parameters

NameTypeDescriptionRequiredNotes
contact_idStringcontactId[required]

Return type

crate::models::ContactDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_contact_v_card

String get_contact_v_card(contact_id) Get contact vCard vcf file

Parameters

NameTypeDescriptionRequiredNotes
contact_idStringcontactId[required]

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_contacts

Veccrate::models::ContactProjection get_contacts() Get all contacts

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::ContactProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]