Adresse erstellen

Create an address. Body must include exactly one of `contacts_id` or `partners_id`.

post /api/v1/addresses

Sicherheit

ApiKeyAuth

Parameter

Name	In	Typ		Details
`Idempotency-Key`	header	`string`	Optional	Unique key for safe create retries (Make/Zapier/n8n). Replays the stored successful response for the same key + request body within 7 days.

Request-Body Pflicht

application/json

Beispiel

{
    "contacts_id": 12,
    "address_line_1": "Musterstraße 1",
    "zip_code": "80331",
    "city": "München",
    "countries_id": 82,
    "is_primary": true
}

Schema

{
    "allOf": [
        {
            "type": "object",
            "description": "Address fields for create/update (linked to a contact or partner).",
            "required": [
                "address_line_1"
            ],
            "properties": {
                "id": {
                    "type": "integer",
                    "description": "Existing address id (update only)"
                },
                "label": {
                    "type": "string"
                },
                "attention": {
                    "type": "string"
                },
                "address_line_1": {
                    "type": "string"
                },
                "address_line_2": {
                    "type": "string"
                },
                "zip_code": {
                    "type": "string"
                },
                "city": {
                    "type": "string"
                },
                "district": {
                    "type": "string"
                },
                "state": {
                    "type": "string"
                },
                "country_code": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 2
                },
                "countries_id": {
                    "type": "integer"
                },
                "latitude": {
                    "type": "number"
                },
                "longitude": {
                    "type": "number"
                },
                "delivery_instructions": {
                    "type": "string"
                },
                "is_primary": {
                    "type": "boolean"
                },
                "is_active": {
                    "type": "boolean"
                }
            }
        },
        {
            "type": "object",
            "description": "Exactly one of contacts_id or partners_id is required.",
            "properties": {
                "contacts_id": {
                    "type": "integer"
                },
                "partners_id": {
                    "type": "integer"
                }
            }
        }
    ]
}

Antworten

201 Adresse erstellt

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": "Address",
                    "type": "object",
                    "description": "Address in responses.\n",
                    "required": [
                        "address_line_1",
                        "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
                        },
                        "address_line_1": {
                            "type": "string"
                        },
                        "address_line_2": {
                            "type": "string",
                            "nullable": true
                        },
                        "zip_code": {
                            "type": "string",
                            "nullable": true
                        },
                        "city": {
                            "type": "string",
                            "nullable": true
                        },
                        "district": {
                            "type": "string",
                            "nullable": true
                        },
                        "state": {
                            "type": "string",
                            "nullable": true
                        },
                        "is_primary": {
                            "type": "boolean"
                        },
                        "country": {
                            "oneOf": [
                                {
                                    "title": "Country",
                                    "type": "object",
                                    "required": [
                                        "id",
                                        "name"
                                    ],
                                    "properties": {
                                        "id": {
                                            "type": "integer"
                                        },
                                        "name": {
                                            "type": "string"
                                        },
                                        "iso2": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "iso3": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "numeric_code": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "phone_code": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "capital": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "currency": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "currency_symbol": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "native": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "region": {
                                            "type": "string",
                                            "nullable": true
                                        },
                                        "subregion": {
                                            "type": "string",
                                            "nullable": true
                                        }
                                    }
                                },
                                {
                                    "type": "null"
                                }
                            ]
                        }
                    }
                }
            }
        }
    ]
}

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