Cardly

Delete Artwork via DELETE /art/{id}. Delete a piece of artwork owned by your organisation.

Delete Contact List via DELETE /contact-lists/{id}. Delete a contact list, disabling any automations linked to it.

Delete Contact by Email or External ID via DELETE /contact-lists/{listId}/contacts. Delete a contact identified by a body field rather than by a path id, disabling any automations linked to it. Matching is performed in order of external ID then email address, and at least one must be supplied. Cardly titles this operation and the by-id delete identically; the name here follows the vendor's own convention for the invitation and user pairs of the same shape.

Delete Contact via DELETE /contact-lists/{listId}/contacts/{id}. Delete a contact, disabling any automations linked to it.

Delete Invitation by Email via DELETE /invitations. Delete an invitation by email address, immediately invalidating it for acceptance.

Delete Invitation via DELETE /invitations/{id}. Delete an invitation by unique ID address, immediately invalidating it for acceptance.

Delete User by Email via DELETE /users. Delete a user by email address, immediately revoking their access to your organisation portal. **Please note:** Access can not be removed for users with `administrator` privileges on your account. These must be removed via your portal directly.

Delete user via DELETE /users/{id}. Delete a user by unique ID address, immediately revoking their access to your organisation portal. **Please note:** Access can not be removed for users with `administrator` privileges on your account. These must be removed via your portal directly.

Delete Webhook via DELETE /webhooks/{id}. Delete a given webhook and cease all activity and event subscriptions immediately.

Retrieve Account Balance via GET /account/balance. This endpoint allows you to quickly query the current balance for your organisation. Where relevant, API calls which consume or have the potential to consume balance will return your organisation's balance in the return structure for convenience. This will allow you to easily determine if additional balance should be added to your account if not utilising the automatic account topup feature.

List Credit History via GET /account/credit-history. Retrieve a section of balance history records pertaning to your organistaion. This will list both credits and debits, along with links / reasons for each, where applicable. This request accepts standard pagination options `limit, offset` along with the following additional filters:

List Gift Credit History via GET /account/gift-credit-history. Retrieve a section of gift credit history records pertaning to your organistaion. This will list both credits and debits, along with links / reasons for each, where applicable. This request accepts standard pagination options `limit, offset` along with the following additional filters:

List Artwork via GET /art. Retrieve the currently available artwork for your organisation. This request accepts standard pagination options `limit, offset` along with the following additional filters:

Retrieve Artwork via GET /art/{id}. Retrieve information on a specific piece of artwork.

List Contact Lists via GET /contact-lists. Retrieve active contact lists for your organisation.

Retrieve Contact List via GET /contact-lists/{id}. Retrieve information on a specific contact list.

List Contacts via GET /contact-lists/{listId}/contacts. Retrieve active contacts in a given list.

Retrieve Contact via GET /contact-lists/{listId}/contacts/{id}. Retrieve information on a specific contact from a given list, identified by Cardly's unique identifier for the record.

Search Contacts via GET /contact-lists/{listId}/contacts/find. Retrieve information on a specific contact from a given list, searching for the contact by an email address or previously supplied external identifier.

List Doodles via GET /doodles. Retrieve your currently available doodles. This request accepts standard pagination options `limit, offset` along with the following additional filters:

List Fonts via GET /fonts. Retrieve your currently available fonts. This request accepts standard pagination options `limit, offset` along with the following additional filters:

List Invitations via GET /invitations. Retrieve active invitations for your organisation. This request accepts standard pagination options `limit, offset` along with the following additional filters:

Retrieve Invitation via GET /invitations/{id}. Retrieve information on a specific invitation, identified by Cardly's unique identifier for the record.

Find Invitation via GET /invitations/find. Retrieve information on a specific invitation, searching by a provided email address.

List Media via GET /media. Retrieve the currently available media sizes for product artwork. This request accepts standard pagination options `limit, offset` along with the following additional filters:

List Orders via GET /orders. Retrieve orders placed by your organisation.

Retrieve Order via GET /orders/{id}. Retrieve information on a specific order.

List Templates via GET /templates. Retrieve your currently available templates.

List Users via GET /users. Retrieve active users for your organisation.

Retrieve User via GET /users/{id}. Retrieve information on a specific user, identified by Cardly's unique identifier for the record.

Find User via GET /users/find. Retrieve information on a specific user, searching by a provided email address.

List Webhooks via GET /webhooks. Retrieve any active or disabled webhooks set up for your organisation.

Get Webhook Details via GET /webhooks/{id}. Get details on an existing webhook.

List Writing Styles via GET /writing-styles. Retrieve your currently available writing styles.

Create Artwork via POST /art. Add a new piece of artwork.

Edit Artwork via POST /art/{id}. Update a piece of artwork with new descriptors or images. All parameters are optional, and only supplied parameters will be updated.

Create Contact List via POST /contact-lists. Add a new contact list, optionally with custom fields.

Update Contact List via POST /contact-lists/{id}. Rename a contact list, change its description, or add, edit and remove its custom fields. Cardly's own 2.1.0 document titles this operation "Create Contact List" and describes it as adding a new list, but both lines are copied from `POST /contact-lists`: this operation's own path parameter, `fields` property and 200 response all describe an UPDATE of the list named by {id}. Its request body is described by Cardly's 2.1.0 contract, which 2.2.0 retired -- the route is live (measured) but unversioned, so its accepted fields could change without notice.

Create Contact via POST /contact-lists/{listId}/contacts. Add a new contact to a given list. **Please note:** contacts added via API calls will be checked for uniqueness based on your externalId and email fields, if supplied. If a contact already exists for one of these fields the addition operation will be rejected.

Edit Contact via POST /contact-lists/{listId}/contacts/{id}. Edit an existing contact, providing updated information for the contact record.

Sync Contact via POST /contact-lists/{listId}/contacts/sync. Sync a contact based on an external ID or email address. If a matching contact does not exist, a new one is created, otherwise existing contact records are updated. Previously removed contacts will be reactivated if they match provided details. Contact matching is performed in order of matching external ID or email address. At least one of these details must be provided, and the first matching contact (if found) is used for update operations.

Echo Request via POST /echo. The `echo` endpoint will take any parameters, body structure and headers and return them to you in a JSON structure. You can use this endpoint to quickly debug other requests, validate your authentication, idempotency and other API features without any impact on your account or any risk of credit usage. This endpoint is special in that it will accept **any** HTTP verb and still provide an output to the caller. **Please note:** you must still authenticate to this endpoint and you'll receive appropriate error responses if your API key is invalid or not supplied.

Create Invitation via POST /invitations. Send an invitation to use your organisation portal, if the provided email address doesn't already have access.

Resend Invitation by Email via POST /invitations/resend. Resend an invitation to a specified email address if that invitation has not yet been accepted.

Resend Invitation via POST /invitations/resend/{id}. Resend an invitation identified by Cardly's unique ID.

Place Order via POST /orders/place. The `place` endpoint allows you to place an order for one or more items, being delivered to one or more distinct recipients. Generally, we recommend that individual orders are created for individual recipients to minimise potential validation and other rejection issues. Note that you must have sufficient credit on your account to place your order. If you have insufficient credit, a `402` response will be returned with detail on the required credit cost and your current balance.

Generate Preview via POST /orders/preview. The `preview` endpoint allows you to generate a quick, low-quality, watermarked preview document for a given piece of card art and template, along with passed user data. You will also be provided with delivery window estimates and a projected credit cost for the order based on your passed data. This call is intentionally nearly identical to the `PlaceOrder` function to facilitate testing and a quick migration to ordering. The main difference between these calls is a `PlaceOrder` request permits multiple line items with differing data and settings, while `Preview` deals with only a single card at a time.

Create Webhook via POST /webhooks. Create a new webhook for the specified targetUrl. Webhooks allow for near-realtime notifications of events within your Cardly account.

Update Webhook via POST /webhooks/{id}. Update a webhook with one or more changes based on the passed properties. Note that changes to the targetUrl or status are immediate, and will update where postbacks are sent for any postbacks queued for retry, or cease sending postbacks if *disabled* is true.