Create an activity

POSThttp://localhost:4000/api/activities/create

Adds a note or event to the timeline of a client.

Your API key needs the clients.MANAGE permission.

Body Params

clientIdintegerrequired

ID of the client this activity belongs to.

typestringrequired

Kind of activity. See List activity types.

messagestring

The note text.

favoriteboolean

True when the activity is pinned.

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/activities/create \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"clientId":1042,"type":"NOTE","message":"Called and left a message."}'

Response

Click Try It! to send a request and see the response here, or choose an example: