Customer profile

These endpoints use the same Instaply API authentication headers (token, Content-Type) as other me.instaply.com/api/… calls.

Get customer profile

Endpoint: GET https://me.instaply.com/api/customers/:customerId/profile

Replace :customerId with the customer identifier.

Example response:

{
  "id": "cust_001",
  "type": "prospect",
  "editable": true,
  "pictureHref": "https://api.instaply.com/files/…",
  "displayName": "Alan Johnson",
  "emailAddress": "aj@example.com",
  "phoneNumber": "+15551234567",
  "firstName": "Alan",
  "lastName": "Johnson",
  "company": "JLB Credit",
  "channel": "SMS",
  "customerData": [
    {
      "name": "COMPANY",
      "value": "Acme"
    }
  ],
  "lastSurveys": {
    "nps": {
      "createdAt": 123456789,
      "text": "8"
    },
    "preferredChannel": {
      "createdAt": 123456789,
      "text": "MESSAGE"
    }
  }
}

Example (curl):

curl -sS "https://me.instaply.com/api/customers/cust_001/profile" \
  -H "token: your-api-token" \
  -H "Content-Type: application/json"

Update customer profile

Endpoint: POST https://me.instaply.com/api/customers/:customerId/profile/update

Request body — all fields are optional; only supplied fields are updated.

{
  "firstName": "Jane",
  "lastName": "Doe",
  "company": "Acme Corp"
}

Example (curl):

curl -X POST "https://me.instaply.com/api/customers/cust_001/profile/update" \
  -H "token: your-api-token" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Doe",
    "company": "Acme Corp"
  }'