Change contact stage

Contacts API · contacts.stage

URL · Fields · Example · Response · Try it

URL and authentication

POST https://YOUR-BACKEND/api/automation/v1/execute

Send Authorization: Bearer <connection key>, Accept: application/json and Content-Type: application/json. Create a connection.

This operation requires write access and CRM permission edit_contacts. The gateway invokes PATCH /api/v1/app/lead-contacts/{id}/stage internally. Use the POST URL above with your automation key, including for read and delete operations.

Request parameters

Fields

Compatibility no-op: validates stageId but does not move the contact. To change the contact stage use contacts.update with contact_stage_id.

Fields below belong inside data. Dot paths describe nested objects; * means each array item. nullable permits null and sometimes validates a supplied field. in: lists allowed values; min: and max: limit the value, length or item count. exists: and exists_in_company: require a valid record ID. Conditional rules such as required_if and required_with refer to other fields in the same payload. Use YYYY-MM-DD for date-only values and timestamps with timezone offsets for follow-ups.

Example request

Replace the example IDs and values with records in your installation. Supply any additional custom fields required by your company.

{
  "operation": "contacts.stage",
  "parameters": {
    "id": 1
  },
  "data": {
    "stageId": 1
  },
  "idempotency_key": "example-event-12345"
}

Response

Returns a success acknowledgement, but this compatibility operation does not change the contact stage.

The gateway preserves the underlying HTTP status and JSON body. Successful requests return HTTP 200. A response may also include localized message fields.

Illustrative response excerpt (additional fields may be returned):

{
  "status": "success",
  "data": {
    "message": "Record saved successfully."
  }
}

Errors

Validation failures may return message / errors, or an error string with an optional fields array. The tester shows the actual HTTP status and full body. Read about limits and retries.

Try it

id must be a positive integer record ID.