Deal in Phase verschieben

Verschiebt den Deal in eine andere Phase derselben Pipeline. `phase_id` muss zu pipelines_id des Deals gehören.

post /api/v1/deals/{id}/move

Sicherheit

ApiKeyAuth

Parameter

Name	In	Typ		Details
`id`	path	`integer`	Pflicht	Ressourcen-ID

Request-Body Pflicht

application/json

Beispiel

{
    "phase_id": 4
}

Schema

{
    "type": "object",
    "required": [
        "phase_id"
    ],
    "description": "Move the deal to another phase in the same pipeline. `phase_id` (alias `pipelines_phases_id`) must belong to the deal's `pipelines_id`.\n",
    "properties": {
        "phase_id": {
            "type": "integer",
            "description": "Target pipeline phase id (alias `pipelines_phases_id`). Must belong to the deal's pipeline."
        },
        "pipelines_phases_id": {
            "type": "integer",
            "description": "Alias for `phase_id`."
        }
    }
}

Antworten

200 Deal verschoben

application/json

{
    "allOf": [
        {
            "title": "API envelope",
            "type": "object",
            "properties": {
                "success": {
                    "type": "boolean"
                },
                "message": {
                    "type": "string",
                    "nullable": true
                },
                "errors": {
                    "nullable": true
                },
                "meta": {
                    "type": "object",
                    "nullable": true,
                    "additionalProperties": true
                }
            }
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "title": "Deal",
                    "type": "object",
                    "required": [
                        "id",
                        "is_active"
                    ],
                    "properties": {
                        "id": {
                            "type": "integer"
                        },
                        "deals_unique_id": {
                            "type": "string",
                            "nullable": true
                        },
                        "name": {
                            "type": "string",
                            "nullable": true
                        },
                        "is_active": {
                            "type": "boolean"
                        },
                        "deal_status": {
                            "type": "string",
                            "nullable": true
                        },
                        "pipelines_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "pipeline_name": {
                            "type": "string",
                            "nullable": true
                        },
                        "partners_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "partner_name": {
                            "type": "string",
                            "nullable": true
                        },
                        "contacts_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "contact_display_name": {
                            "type": "string",
                            "nullable": true
                        },
                        "phase_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "phase_name": {
                            "type": "string",
                            "nullable": true
                        },
                        "tags_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "solar_sites_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "started_on": {
                            "type": "string",
                            "nullable": true
                        },
                        "created_at": {
                            "type": "string",
                            "format": "date-time",
                            "nullable": true
                        },
                        "updated_at": {
                            "type": "string",
                            "format": "date-time",
                            "nullable": true
                        }
                    }
                }
            }
        }
    ]
}

401 Missing or invalid API key

application/json

{
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean",
            "example": false
        },
        "message": {
            "type": "string",
            "example": "Missing API key (X-Api-Key)"
        }
    }
}

404 Resource not found

application/json

{
    "title": "API envelope",
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string",
            "nullable": true
        },
        "errors": {
            "nullable": true
        },
        "meta": {
            "type": "object",
            "nullable": true,
            "additionalProperties": true
        }
    }
}

422 Validation failed

application/json

{
    "title": "API envelope",
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string",
            "nullable": true
        },
        "errors": {
            "nullable": true
        },
        "meta": {
            "type": "object",
            "nullable": true,
            "additionalProperties": true
        }
    }
}