Skip to main content
POST
/
v1
/
accounts
/
{accountId}
/
contacts
cURL
curl -X POST \
  https://api.sakari.io/v1/accounts/{{ACCOUNT_ID}}/contacts \
  -H 'Content-Type: application/json' \
  -d '{
  "firstName": "Chris",
  "lastName": "Thomson",
  "mobile": {
    "number": "+1234567890",
    "country": "US"
  }
}'
{
  "success": true,
  "pagination": {
    "limit": 123,
    "offset": 123,
    "hasNext": true
  },
  "data": [
    {
      "id": "<string>",
      "email": "chris@sakari.io",
      "firstName": "Chris",
      "lastName": "Bloggs",
      "mobile": {
        "country": "<string>",
        "number": "123-456-7890",
        "verified": "2023-11-07T05:31:56Z",
        "valid": true,
        "lineType": "mobile"
      },
      "lists": [
        {
          "id": "<any>",
          "name": "<any>",
          "source": "<any>",
          "keyword": "<any>",
          "doubleOptIn": "<any>",
          "filter": "<any>",
          "optInConfirmation": "<any>",
          "optIn": "<any>",
          "optOut": "<any>"
        }
      ],
      "attributes": {},
      "optIn": "2023-11-07T05:31:56Z",
      "blocked": "2023-11-07T05:31:56Z",
      "activecampaign": {
        "id": 123
      },
      "hubspot": {
        "id": 123
      },
      "pipedrive": {
        "id": 123
      },
      "valid": true,
      "error": {
        "code": "CONT-010",
        "description": "Contact has requested no further communication"
      },
      "created": {
        "at": "2023-11-07T05:31:56Z",
        "by": {
          "id": "<any>",
          "name": "<any>",
          "firstName": "<any>",
          "lastName": "<any>",
          "email": "<any>",
          "source": "<any>",
          "subSource": "<any>"
        }
      },
      "updated": {
        "at": "2023-11-07T05:31:56Z",
        "by": {
          "id": "<any>",
          "name": "<any>",
          "firstName": "<any>",
          "lastName": "<any>",
          "email": "<any>",
          "source": "<any>",
          "subSource": "<any>"
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId
string
required

Account to apply operations to

Query Parameters

mergeStrategy
enum<string>

Determines how existing contacts with matching mobile numbers are treated

Available options:
append,
core,
remove

Body

email
string
Example:

"chris@sakari.io"

firstName
string
Example:

"Chris"

lastName
string
Example:

"Bloggs"

mobile
object
lists
object[]
attributes
object
optIn
string<date-time>
blocked
string<date-time>
activecampaign
object
hubspot
object
pipedrive
object
error
object

Response

successful operation

  • Option 1
  • Option 2
data
object[]
required
success
boolean
required
pagination
object
required