Move to a pipeline stage

PATCH/api/v2/contacts/{username_or_id}/pipeline_stage

Moves a contact to another stage on your pipeline board.

Rate limit 300 requests per minute

Headers

x-api-keyheaderRequired
Your API key.
Content-TypeheaderRequired
application/json

Path parameters

username_or_idstringRequired
Instagram username or contact id.

Body

pipeline_stagestringRequired
Name or id of an active stage. Get them from List pipeline stages.
changed_bystring
Email of the team member, shown in the activity log.

Errors

Error	When
400`missing_fields`	`pipeline_stage` is missing.
400`invalid_pipeline_stage`	No active stage with that name or id.
400`invalid_changed_by`	changed_by is not a valid email address.
403`user_not_in_organization`	The changed_by email belongs to someone outside your organization.
404`unknown_changed_by`	No user with the changed_by email.
404`contact_not_found`	No contact with that username or id in your organization.

Request

curl -X PATCH "https://app.dmtracker.ai/api/v2/contacts/jane.fitness/pipeline_stage" \
  -H "x-api-key: $DMTRACKER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline_stage": "Meeting Booked"
  }'

Response 200

{
  "status": "success",
  "message": "Contact pipeline stage updated successfully",
  "data": {
    "id": "7c1e9a52-3f4b-4d2a-9e61-0b8f2d5c4a17",
    "username": "jane.fitness",
    "full_name": "Jane Cooper",
    "pipeline_stage": {
      "id": "1f7d9a3c-5e2b-4c80-a6f1-8b4e0d3c7a25",
      "name": "Meeting Booked",
      "color": "#FFB340",
      "position": 5
    }
  }
}

Shortened. data is the full contact object.