Activities
Create custom activity types and write new activity onto accounts.
post
Create a new activity for an account
Authorizations
Path parameters
idstringRequired
The ID of the account to create the activity for.
Body
body_htmlstringOptional
Optional HTML content to display in the activity.
contact_idstringOptional
Optional contact ID of the actor of the activity.
happened_atstringOptional
Timestamp (RFC3339) of when the activity happened. Defaults to the current time if empty.
linkstringOptional
Optional link to add to the activity.
link_textstringOptional
Optional link text to display on the activity. Defaults to "Open link" if not provided. Applies only if a link is provided.
slugstringRequired
The slug of the activity to create.
user_idstringOptional
Optional user ID of the actor of the activity.
Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
post
POST /accounts/{id}/activities HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"body_html": "text",
"contact_id": "text",
"happened_at": "text",
"link": "text",
"link_text": "text",
"slug": "text",
"user_id": "text"
}
{
"data": {
"success": true
},
"request_id": "text"
}
get
Get custom activity types
Authorizations
Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
get
GET /activity-types HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"icon_url": "text",
"id": "text",
"label": "text",
"slug": "text"
}
],
"pagination": {
"cursor": "text",
"has_next_page": true
},
"request_id": "text"
}
Last updated
Was this helpful?