Bulk upsert partner entries

POST

https://v1.api.partnerpage.io/api/directory/private/v1alpha/external/directories/{directoryId}/entries/partners/bulk/

Create or update partner entries in a directory in a single batch. Each row is identified by exactly one of entry_id or external_id; rows identified by external_id are upserted when no matching entry exists. Batch size is capped by the configured maximum. The response contains a per-entry result with action (created, updated, unchanged, or failed). Successful rows include the resulting entry. Failed rows include a top-level message for authorization or not-found failures, and errors when the row has structured field validation failures.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Per-entry results

Bodyapplication/json

🟠400

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://v1.api.partnerpage.io/api/directory/private/v1alpha/external/directories//entries/partners/bulk/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entries": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "title": "string",
            "headline": "string",
            "type": "string",
            "slug": "string",
            "custom_slug": "string",
            "status": "hidden",
            "icon": "string",
            "image": "string",
            "website": "http://example.com",
            "last_modified": {
                "modified": "string",
                "user": {
                    "id": "string",
                    "full_name": "string",
                    "email": "user@example.com",
                    "type": "string"
                }
            },
            "description": "string",
            "integration_description": "string",
            "location": "string",
            "user_assigned_filter_options": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "external_url": "http://example.com",
            "call_to_action_url": "http://example.com",
            "call_to_action_label": "string",
            "support_email": "string",
            "developer_name": "string",
            "availability": true,
            "entry_id": "31513983-613b-4481-b270-ae929f358bae",
            "external_id": "string"
        }
    ]
}'

Response Example

[
    {
        "entry_id": "31513983-613b-4481-b270-ae929f358bae",
        "external_id": "string",
        "action": "created",
        "entry": {
            "href": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "title": "string",
            "headline": "string",
            "type": "string",
            "slug": "string",
            "custom_slug": "string",
            "status": "hidden",
            "icon": "string",
            "image": "string",
            "website": "http://example.com",
            "last_modified": {
                "modified": "string",
                "user": {
                    "id": "string",
                    "full_name": "string",
                    "email": "user@example.com",
                    "type": "string"
                }
            },
            "user_assigned_filter_options": "string",
            "system_assigned_filter_options": "string",
            "mapped_assigned_filter_options": "string",
            "external_id": "string",
            "description": "string",
            "umami_share_id": "string",
            "integration_description": "string",
            "location": "string",
            "call_to_action_url": "http://example.com",
            "call_to_action_label": "string",
            "external_url": "http://example.com",
            "awards": [
                {
                    "title": "string",
                    "file": "string",
                    "order": 0,
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                }
            ],
            "directory": "5277859d-f92c-478c-acab-7680a97fea68",
            "approval_flow": "string",
            "support_email": "string",
            "developer_name": "string",
            "availability": true
        },
        "message": "string",
        "errors": null
    }
]

Modified at 2026-09-18 18:58:15

Delete a partner entry

Update the recommended order of a partner entry