Create sender profile

curl --request POST \
  --url https://beta.getsales.io/unibox/v1/api/sender-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "name": "<string>",
  "label": "<string>",
  "linkedin_account_sid": "<string>",
  "email_account_sid": "<string>",
  "linkedin_history_since": "<string>",
  "email_history_since": "<string>",
  "avatar_url": "<string>",
  "assignee_user_sid": "<string>"
}
'

import requests

url = "https://beta.getsales.io/unibox/v1/api/sender-profiles"

payload = {
    "name": "<string>",
    "label": "<string>",
    "linkedin_account_sid": "<string>",
    "email_account_sid": "<string>",
    "linkedin_history_since": "<string>",
    "email_history_since": "<string>",
    "avatar_url": "<string>",
    "assignee_user_sid": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Team-SID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Team-SID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    label: '<string>',
    linkedin_account_sid: '<string>',
    email_account_sid: '<string>',
    linkedin_history_since: '<string>',
    email_history_since: '<string>',
    avatar_url: '<string>',
    assignee_user_sid: '<string>'
  })
};

fetch('https://beta.getsales.io/unibox/v1/api/sender-profiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://beta.getsales.io/unibox/v1/api/sender-profiles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'label' => '<string>',
    'linkedin_account_sid' => '<string>',
    'email_account_sid' => '<string>',
    'linkedin_history_since' => '<string>',
    'email_history_since' => '<string>',
    'avatar_url' => '<string>',
    'assignee_user_sid' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Team-SID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://beta.getsales.io/unibox/v1/api/sender-profiles"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"linkedin_account_sid\": \"<string>\",\n  \"email_account_sid\": \"<string>\",\n  \"linkedin_history_since\": \"<string>\",\n  \"email_history_since\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"assignee_user_sid\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Team-SID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://beta.getsales.io/unibox/v1/api/sender-profiles")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"linkedin_account_sid\": \"<string>\",\n  \"email_account_sid\": \"<string>\",\n  \"linkedin_history_since\": \"<string>\",\n  \"email_history_since\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"assignee_user_sid\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/unibox/v1/api/sender-profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"linkedin_account_sid\": \"<string>\",\n  \"email_account_sid\": \"<string>\",\n  \"linkedin_history_since\": \"<string>\",\n  \"email_history_since\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"assignee_user_sid\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "name": "<string>",
    "created_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "label": "<string>",
    "linkedin_account_sid": "<string>",
    "linkedin_source": "cloud",
    "linkedin_status": "active",
    "linkedin_status_reason": "<string>",
    "linkedin_has_sn": true,
    "linkedin_recruiter_status": "active",
    "linkedin_history_since": "<string>",
    "linkedin_history_scope": "all",
    "email_account_sid": "<string>",
    "avatar_url": "<string>",
    "assignee_user_sid": "<string>",
    "history_sync": {
      "status": "pending",
      "requested_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>",
      "threads_seen": 1,
      "threads_imported": 1,
      "messages_imported": 1,
      "skipped": 1,
      "synced_through": "<string>",
      "error": "<string>"
    },
    "mailboxes": [
      {
        "email_account_sid": "<string>",
        "address": "<string>",
        "display_name": "<string>",
        "provider": "<string>",
        "status": "<string>",
        "status_reason": "<string>",
        "is_primary": true,
        "sending_limits": {
          "daily_limit": 123,
          "min_interval_seconds": 123,
          "sending_window": {}
        },
        "warmup_config": {
          "enabled": true,
          "ramp_start_daily": 123,
          "ramp_step_per_day": 123,
          "target_daily": 123
        },
        "signature_html": "<string>",
        "bcc": [
          "<string>"
        ],
        "track_opens": true,
        "track_clicks": true,
        "email_tracking_domain_sid": "<string>",
        "history_since": "<string>",
        "history_scope": "all",
        "connected_at": "<string>",
        "synced_at": "<string>"
      }
    ],
    "deleted_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "already_exists": true,
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

sender_profiles

Create sender profile

Create a sender profile: the person the team sends as. It has no sending window and no timezone: a schedule is a workflow’s, counters count in the workspace’s day. No channel is needed at birth: bind LinkedIn afterwards (attach_sender_profile_linkedin, start_sender_profile_linkedin_connect) and mailboxes with the mailbox verbs. Account refs may ride the create: a live sender profile already holding one comes back already_exists true; refs at two sender profiles are 409.

Contract:

MCP tool create_sender_profile, registry package mcp.unibox/sender_profiles, mount unibox.sender-profiles.
Operation create, response envelope create.
Flags: none.

POST

api

sender-profiles

Create sender profile

curl --request POST \
  --url https://beta.getsales.io/unibox/v1/api/sender-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "name": "<string>",
  "label": "<string>",
  "linkedin_account_sid": "<string>",
  "email_account_sid": "<string>",
  "linkedin_history_since": "<string>",
  "email_history_since": "<string>",
  "avatar_url": "<string>",
  "assignee_user_sid": "<string>"
}
'

import requests

url = "https://beta.getsales.io/unibox/v1/api/sender-profiles"

payload = {
    "name": "<string>",
    "label": "<string>",
    "linkedin_account_sid": "<string>",
    "email_account_sid": "<string>",
    "linkedin_history_since": "<string>",
    "email_history_since": "<string>",
    "avatar_url": "<string>",
    "assignee_user_sid": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Team-SID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Team-SID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    label: '<string>',
    linkedin_account_sid: '<string>',
    email_account_sid: '<string>',
    linkedin_history_since: '<string>',
    email_history_since: '<string>',
    avatar_url: '<string>',
    assignee_user_sid: '<string>'
  })
};

fetch('https://beta.getsales.io/unibox/v1/api/sender-profiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://beta.getsales.io/unibox/v1/api/sender-profiles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'label' => '<string>',
    'linkedin_account_sid' => '<string>',
    'email_account_sid' => '<string>',
    'linkedin_history_since' => '<string>',
    'email_history_since' => '<string>',
    'avatar_url' => '<string>',
    'assignee_user_sid' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Team-SID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://beta.getsales.io/unibox/v1/api/sender-profiles"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"linkedin_account_sid\": \"<string>\",\n  \"email_account_sid\": \"<string>\",\n  \"linkedin_history_since\": \"<string>\",\n  \"email_history_since\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"assignee_user_sid\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Team-SID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://beta.getsales.io/unibox/v1/api/sender-profiles")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"linkedin_account_sid\": \"<string>\",\n  \"email_account_sid\": \"<string>\",\n  \"linkedin_history_since\": \"<string>\",\n  \"email_history_since\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"assignee_user_sid\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/unibox/v1/api/sender-profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"linkedin_account_sid\": \"<string>\",\n  \"email_account_sid\": \"<string>\",\n  \"linkedin_history_since\": \"<string>\",\n  \"email_history_since\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"assignee_user_sid\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "name": "<string>",
    "created_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "label": "<string>",
    "linkedin_account_sid": "<string>",
    "linkedin_source": "cloud",
    "linkedin_status": "active",
    "linkedin_status_reason": "<string>",
    "linkedin_has_sn": true,
    "linkedin_recruiter_status": "active",
    "linkedin_history_since": "<string>",
    "linkedin_history_scope": "all",
    "email_account_sid": "<string>",
    "avatar_url": "<string>",
    "assignee_user_sid": "<string>",
    "history_sync": {
      "status": "pending",
      "requested_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>",
      "threads_seen": 1,
      "threads_imported": 1,
      "messages_imported": 1,
      "skipped": 1,
      "synced_through": "<string>",
      "error": "<string>"
    },
    "mailboxes": [
      {
        "email_account_sid": "<string>",
        "address": "<string>",
        "display_name": "<string>",
        "provider": "<string>",
        "status": "<string>",
        "status_reason": "<string>",
        "is_primary": true,
        "sending_limits": {
          "daily_limit": 123,
          "min_interval_seconds": 123,
          "sending_window": {}
        },
        "warmup_config": {
          "enabled": true,
          "ramp_start_daily": 123,
          "ramp_step_per_day": 123,
          "target_daily": 123
        },
        "signature_html": "<string>",
        "bcc": [
          "<string>"
        ],
        "track_opens": true,
        "track_clicks": true,
        "email_tracking_domain_sid": "<string>",
        "history_since": "<string>",
        "history_scope": "all",
        "connected_at": "<string>",
        "synced_at": "<string>"
      }
    ],
    "deleted_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "already_exists": true,
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID

string

header

required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_sender_profile.

name

string

required

Display persona name. The sender profile keeps it for life: attaching an account never overwrites it.

Required string length: 1 - 255

label

string | null

The free text under the name in the list ("Outbound EU"). An empty string is stored as null.

Maximum string length: 255

linkedin_account_sid

string | null

Optional: bind a gtm-api LinkedIn account the tenant already holds at birth (ln_ac_…, not existence-checked here). Otherwise use the channel verbs afterwards.

Required string length: 18

Pattern: ^ln_ac_

email_account_sid

string | null

Optional: bind a gtm mailbox at birth (em_ac_…). It becomes the primary mailbox.

Required string length: 18

Pattern: ^em_ac_

linkedin_history_since

string | null

The history window of the LinkedIn account bound at birth: import its conversations from this day (YYYY-MM-DD) on, or none of the past with now (from the create on); omitted or null = all of them. Stored only when linkedin_account_sid rides the create.

Pattern: ^(now|\d{4}-\d{2}-\d{2})$

email_history_since

string | null

The history window of the mailbox bound at birth, as for linkedin_history_since. Stored only when email_account_sid rides the create.

Pattern: ^(now|\d{4}-\d{2}-\d{2})$

linkedin_history_scope

enum<string> | null

The import scope of the LinkedIn account bound at birth: playtable_people (omitted or null, the default) takes only conversations with a person the workspace keeps in a playtable, all every conversation. Stored only with linkedin_account_sid.

Available options:

all,

playtable_people

email_history_scope

enum<string> | null

The import scope of the mailbox bound at birth, as for linkedin_history_scope. Stored only when email_account_sid rides the create.

Available options:

all,

playtable_people

avatar_url

string | null

Display photo URL; a LinkedIn account bound to the sender profile replaces it with the account's own photo.

Maximum string length: 2048

assignee_user_sid

string | null

Operator of the sender profile (external user sid, not existence-checked): the default assignee for the tasks its threads spawn.

Required string length: 18

Response

create success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

create

item

object

required

Show child attributes

already_exists

boolean

required

Overview

Playtables API

Unibox API

Signals API

Integrations API

ID and Teams API

Create sender profile

Authorizations

Body

Response