E-Mail teilweise aktualisieren

patch /api/v1/emails/{id}

Sicherheit

ApiKeyAuth

Parameter

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

Request-Body Pflicht

application/json

Schema

{
    "type": "object",
    "description": "Email fields for create/update (linked to a contact or partner).",
    "required": [
        "email"
    ],
    "properties": {
        "id": {
            "type": "integer",
            "description": "Existing email id (update only)"
        },
        "contact_email_types_id": {
            "type": "integer"
        },
        "label": {
            "type": "string"
        },
        "email": {
            "type": "string",
            "format": "email"
        },
        "is_primary": {
            "type": "boolean"
        },
        "is_verified": {
            "type": "boolean"
        },
        "is_active": {
            "type": "boolean"
        }
    }
}

Antworten

200 E-Mail aktualisiert

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": "Email",
                    "type": "object",
                    "description": "Email in responses.",
                    "required": [
                        "email",
                        "is_primary"
                    ],
                    "properties": {
                        "id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "contacts_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "partners_id": {
                            "type": "integer",
                            "nullable": true
                        },
                        "label": {
                            "type": "string",
                            "nullable": true
                        },
                        "email": {
                            "type": "string",
                            "format": "email"
                        },
                        "is_primary": {
                            "type": "boolean"
                        }
                    }
                }
            }
        }
    ]
}

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
        }
    }
}