SLslashfi

Archive a recipient

Changed on

Archive a recipient and hide it and its destinations from default list results.

post/v2/recipients/{recipientId}/archive

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/recipients/{recipientId}/archive
  • Auth
    API key in header X-API-Key

Path parameters

recipientIdstring required

Recipient id.

Response

The archived recipient.

idstring required

Recipient id.

namestring required

Display name visible to your organization.

recipientType'contact' | 'vendor' required

contact is a person (shown as "Person" in the Slash dashboard); vendor is a business.

recipientLegalNamestring required
recipientEmailstring
status'active' | 'archived' required
createdAtstring date-time required
archivedAtstring date-time

Changes