GuidesAPI ReferenceZapier API
Transfers

Create Transfer

Create a new transfer rule. The transfer will be associated with the organization of the API key.

POST
/v1/transfers

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication for API access.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.sophiie.ai/v1/transfers" \  -H "Content-Type: application/json" \  -d '{    "label": "Sales Department Transfer",    "method": "WARM",    "destinationType": "DEPARTMENT",    "destination": "dep_sales_01",    "conditions": "When the customer asks to speak with a sales representative."  }'
{
  "transfer": {
    "id": 7,
    "label": "Sales Department Transfer",
    "name": "Sales Team",
    "method": "WARM",
    "destinationType": "DEPARTMENT",
    "destination": "dep_sales_01",
    "conditions": "When the customer asks to speak with a sales representative.",
    "summaryFormat": "Customer {name} is calling about {topic}. Key details: {summary}.",
    "settings": {
      "ignore_business_hours": false
    },
    "isEnabled": true,
    "scenarioId": null,
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-20T14:00:00.000Z"
  }
}
{
  "success": false,
  "message": "Bad request",
  "error": {
    "status": 400,
    "message": "Bad request"
  }
}
{
  "success": false,
  "message": "Invalid or expired token",
  "error": {
    "status": 401,
    "message": "Invalid or expired token"
  }
}
{
  "success": false,
  "message": "Conflict",
  "error": {
    "status": 409,
    "message": "Conflict"
  }
}
{
  "success": false,
  "message": "Internal server error",
  "error": {
    "status": 500,
    "message": "Internal server error"
  }
}

Send SMS POST

Send an SMS message to a lead. The SMS will be associated with the organization of the API key. If messageThreadId is not provided, a new message thread and inquiry will be created.

Delete Transfer DELETE

Delete an existing transfer rule. Only transfers belonging to the organization associated with the API key can be deleted. This performs a soft delete.