Members a contact list

Parameters

Request

curl -X POST 'https://app.mailyte.com/api/v1/contact-lists/01JBT8XQ2M9WYC3K4F6R7S8T9V/members' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/contact-lists/01JBT8XQ2M9WYC3K4F6R7S8T9V/members', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/contact-lists/01JBT8XQ2M9WYC3K4F6R7S8T9V/members",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/contact-lists/01JBT8XQ2M9WYC3K4F6R7S8T9V/members');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/contact-lists/01JBT8XQ2M9WYC3K4F6R7S8T9V/members")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject

  ONE shape for both directions — adding members and removing one answer the same five counters, with the irrelevant ones at zero — so a caller writing a "sync my list" routine never has to branch on which call it just made.

  • objectstringcontact_list_membership
  • list_idstring

    The list this happened to, echoed from the path so the response can be logged on its own.

  • addedinteger

    Newly attached. Re-adding an existing member is a no-op that still counts as added — the request "this contact is on this list" was satisfied either way. Zero on a removal.

  • removedinteger

    Detached. Removing somebody who was not a member is a no-op and counts 0. Zero on an add.

  • skippedinteger

    Ids that resolved to nothing in this organization. Both endpoints quietly ignore ids they cannot see — answering "no such contact" would confirm which ids exist in someone else's account — so without this counter a caller submitting 500 ids and having 40 ignored would have no way to know. It does not name them, for the same reason.

  • contact_countinteger

    The size of the list AFTER the change, so you never have to follow up with a GET. Counts every member whatever their state, exactly as `contact_list.contact_count` does.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.