View as Markdown Open in ChatGPT Open in Claude
POST
Email API · User · v1.0

Add a contact to a group for the authenticated user

Add a contact to a group for the authenticated user

https://email.1spoc.com/api/user/groups/{groupId}/contacts
infoOverview

About this API

Add a contact to a group for the authenticated user

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader
Field nameAuthorization: Bearer <TOKEN>
Example valueYOUR_ACCESS_TOKEN
routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

NameTypeRequirementDescription
groupIdstringRequiredResource identifier for groupId.
uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

Top-Level Fields

NameTypeRequirementDescription
emailstringRequiredEmail address of the contact to add.
statusstringNot specifiedSubscription status of the contact (e.g., subscribed, unsubscribed, bounced). Defaults to subscribed.
last_namestringNot specifiedLast name of the contact.
first_namestringNot specifiedFirst name of the contact.
{}
{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the contact to add."
    },
    "status": {
      "type": "string",
      "nullable": true,
      "description": "Subscription status of the contact (e.g., subscribed, unsubscribed, bounced). Defaults to subscribed."
    },
    "last_name": {
      "type": "string",
      "nullable": true,
      "description": "Last name of the contact."
    },
    "first_name": {
      "type": "string",
      "nullable": true,
      "description": "First name of the contact."
    }
  }
}
codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

shield_lockCredentials protectedAdd secrets only in your secure server environment.
downloadSDK
curl --request POST 'https://email.1spoc.com/api/user/groups/{groupId}/contacts' \
  --header 'Authorization: Bearer <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{}'
const response = await fetch('https://email.1spoc.com/api/user/groups/{groupId}/contacts', {
  method: 'POST',
  headers: {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
const response = await fetch('https://email.1spoc.com/api/user/groups/{groupId}/contacts', {
  method: 'POST',
  headers: {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json
import requests

url = 'https://email.1spoc.com/api/user/groups/{groupId}/contacts'
headers = {
  "Authorization": "Bearer <TOKEN>",
  "Content-Type": "application/json"
}
payload = json.loads(r'''{}''')
response = requests.post(url, headers=headers, json=payload)

response.raise_for_status()
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
String body = """
{}
""";
var request = HttpRequest.newBuilder(URI.create("https://email.1spoc.com/api/user/groups/{groupId}/contacts"))
    .header("Authorization", "Bearer <TOKEN>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
<?php
$curl = curl_init();
$payload = '{}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://email.1spoc.com/api/user/groups/{groupId}/contacts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>","Content-Type: application/json"],
    CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var json = """
{}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://email.1spoc.com/api/user/groups/{groupId}/contacts", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
)

func main() {
    request, err := http.NewRequest("POST", "https://email.1spoc.com/api/user/groups/{groupId}/contacts", bytes.NewBufferString("{}"))
    if err != nil { panic(err) }
    request.Header.Set("Content-Type", "application/json")
    request.Header.Set("Accept", "application/json")
    request.Header.Set("Authorization", "Bearer <TOKEN>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}
downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{}
{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    },
    "status": {
      "type": "string"
    },
    "added_at": {
      "type": "string",
      "format": "date-time"
    },
    "group_id": {
      "type": "string",
      "format": "uuid"
    },
    "last_name": {
      "type": "string",
      "nullable": true
    },
    "contact_id": {
      "type": "string",
      "format": "uuid"
    },
    "first_name": {
      "type": "string",
      "nullable": true
    }
  }
}
ruleHTTP Responses

Status Codes

201Contact added to group successfully.
400Missing or invalid fields (e.g., missing email or groupId).
401Unauthorized (missing or invalid user access token)
404Group not found.
409Contact is already a member of this group.
500Internal server error
Global API SearchProducts, versions, endpoints, paths, and payload fields
Esc
Full search page
manage_searchSearch the complete API catalogEnter at least two characters to begin.