Skip to main content
POST
Record a sales follow-up step

Authorizations

x-api-key
string
header
required

Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.

Path Parameters

organizationId
string
required

Body

application/json
requestId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind
enum<string>
required
Available options:
reviewed,
contacted,
replied,
meeting,
note,
closed,
dismissed,
reopened
contactUserId
string | null
Maximum string length: 64
note
string | null
Maximum string length: 500
nextAction
string | null
Maximum string length: 240
followUpOn
string<date> | null

UTC calendar date (YYYY-MM-DD) of the next follow-up. Null clears it.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
assignToMe
boolean
default:false
confirmedOpportunity
enum<string> | null
Available options:
expansion,
commercial

Response

Step recorded, or the original retry returned.

ok
boolean
required
actionId
string
required