---
updatedAt: 2026-04-29T14:50:55.000Z
agentTools:
  siteIndex: https://developers.liveramp.com/llms.txt
  projectIndex: https://developers.liveramp.com/clean-room-api/llms.txt
---

# Create destination connection

Creates a destination connection (partner account) for the organisation. requires name and partner id; credential and publicKey are optional depending on partner type.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "v1.0.0",
    "title": "External APIs for Customer Integration",
    "description": "APIs to create and fetch Clean Room and related details from LiveRamp (previously Habu) for Customer Integration.",
    "contact": {
      "name": "LiveRamp (previously Habu)",
      "url": "https://liveramp.com/",
      "email": "platform_admin@habu.com"
    }
  },
  "security": [
    {
      "application": []
    }
  ],
  "paths": {
    "/destinations": {
      "post": {
        "summary": "Create destination connection",
        "operationId": "createDestination",
        "description": "Creates a destination connection (partner account) for the organisation. requires name and partner id; credential and publicKey are optional depending on partner type.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateDestinationRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Destination connection created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PartnerAccount"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "tags": [
          "Destinations"
        ]
      }
    }
  },
  "components": {
    "responses": {
      "BadRequest": {
        "description": "Bad Request - Incorrect syntax or request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      },
      "NotFound": {
        "description": "The specified resource was not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Authorization information was missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      },
      "Forbidden": {
        "description": "This action is not allowed",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      }
    },
    "schemas": {
      "PartnerAccount": {
        "type": "object",
        "properties": {
          "ID": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organizationID": {
            "type": "string"
          },
          "partner": {
            "$ref": "#/components/schemas/Partner"
          },
          "credential": {
            "$ref": "#/components/schemas/PrimageOrganizationCredential"
          },
          "timeAudit": {
            "$ref": "#/components/schemas/TimeAudit"
          },
          "userAudit": {
            "$ref": "#/components/schemas/UserAudit"
          },
          "jobCount": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JobCount"
            }
          },
          "latestJobRunStatusCount": {
            "$ref": "#/components/schemas/LatestJobRunStatusCount"
          },
          "configStatus": {
            "$ref": "#/components/schemas/ConfigStatus"
          },
          "errorMessage": {
            "type": "string"
          },
          "publicKey": {
            "type": "string"
          }
        }
      },
      "ConfigStatus": {
        "type": "string",
        "enum": [
          "UNKNOWN_CONFIG_STATUS",
          "CONFIG_PENDING",
          "CONFIG_CONFIGURED",
          "CONFIG_FAILED",
          "CONFIG_AVAILABLE"
        ]
      },
      "LatestJobRunStatusCount": {
        "type": "object",
        "properties": {
          "numSuccess": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          },
          "numProcessing": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          },
          "numThresholdWarning": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          },
          "numPartiallyFailed": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          },
          "numFailed": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          },
          "numQueued": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "JobCount": {
        "type": "object",
        "properties": {
          "jobType": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "PrimageOrganizationCredential": {
        "type": "object",
        "properties": {
          "ID": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "credentials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PrimageCredential"
            }
          }
        }
      },
      "PrimageCredential": {
        "type": "object",
        "properties": {
          "ID": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "Partner": {
        "type": "object",
        "properties": {
          "ID": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "logoUrl": {
            "type": "string"
          },
          "credentialSourceName": {
            "type": "string"
          },
          "partnerConfigArray": {
            "$ref": "#/components/schemas/PartnerConfigs"
          },
          "timeAudit": {
            "$ref": "#/components/schemas/TimeAudit"
          },
          "userAudit": {
            "$ref": "#/components/schemas/UserAudit"
          },
          "type": {
            "$ref": "#/components/schemas/PicanmixType"
          },
          "credentialSources": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "partnerConfigMap": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/PartnerConfigs"
            }
          }
        }
      },
      "CreateDestinationRequest": {
        "type": "object",
        "required": [
          "name",
          "partner"
        ],
        "description": "Request to create a destination connection (partner account).",
        "properties": {
          "name": {
            "type": "string",
            "description": "Display name for the destination connection"
          },
          "partner": {
            "type": "object",
            "required": [
              "ID"
            ],
            "properties": {
              "ID": {
                "type": "string",
                "description": "Partner id (from list destination partners)"
              }
            },
            "description": "Partner to connect; only ID is required for create"
          },
          "credential": {
            "$ref": "#/components/schemas/PrimageOrganizationCredential",
            "description": "Optional; required for partners with a credential source. Use existing ID or name + credentials for new."
          },
          "publicKey": {
            "type": "string",
            "description": "Optional; only allowed for certain partners (e.g. S3 IAM Role Export, GCS Export)"
          }
        }
      },
      "PartnerConfigs": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/PartnerConfig"
        }
      },
      "PartnerConfig": {
        "type": "object",
        "properties": {
          "ID": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "index": {
            "type": "integer",
            "format": "int32"
          },
          "type": {
            "type": "string"
          },
          "encrypted": {
            "type": "boolean"
          }
        }
      },
      "PicanmixType": {
        "type": "string",
        "enum": [
          "UNKNOWN_PICANMIX_TYPE",
          "USER_LIST",
          "OFFLINE_CONVERSIONS",
          "EXPORTS",
          "QUESTION_USER_LIST"
        ]
      },
      "TimeAudit": {
        "type": "object",
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp for when the object was created"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp for when the object was last updated"
          },
          "deletedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp for when the object was deleted (if applicable)"
          }
        }
      },
      "UserAudit": {
        "type": "object",
        "properties": {
          "createdBy": {
            "type": "string",
            "description": "Identifier of the user who created the object"
          },
          "updatedBy": {
            "type": "string",
            "description": "Identifier of the user who last updated the object"
          }
        }
      },
      "ReturnObject": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ]
      }
    },
    "securitySchemes": {
      "application": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://api.habu.com/v1/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "servers": [
    {
      "description": "External APIs for Customer Integration",
      "url": "https://api.habu.com/v1/"
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false
  }
}
```