Campaigns

Yumeru API (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://api-docs.yumeru.ai/_mock/openapi/

Index

Operations

Health

Operations

Usage

Operations

Agents

Operations

Campaigns

Operations

Create a new campaign

Request

Create a new campaign for a specific organization

Path
organizationIdstringrequired
Bodyapplication/json
namestringrequired
agentIdnumberrequired
descriptionstring
timezonestring
fromNumberstringrequired
retryAttemptsnumber[ 0 .. 3 ]
maxConcurrentCallsnumber>= 1
maxMinutesPerDaynumber>= 1
executeNewCallEverynumber[ 1 .. 60 ]
workingHoursArray of objects
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "agentId": 0,
    "description": "string",
    "timezone": "string",
    "fromNumber": "string",
    "retryAttempts": 3,
    "maxConcurrentCalls": 1,
    "maxMinutesPerDay": 1,
    "executeNewCallEvery": 1,
    "workingHours": [
      {
        "dayOfWeek": 6,
        "startTime": "string",
        "endTime": "string",
        "enabled": true
      }
    ]
  }'

Responses

Campaign created successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​namestringrequired
data.​statusstringrequired
Enum"draft""active""paused""completed""failed""archived"
data.​workingHoursArray of objectsrequired
data.​workingHours[].​dayOfWeeknumber[ 0 .. 6 ]required
data.​workingHours[].​startTimestring^([01]?\d|2[0-3]):[0-5]\d$
data.​workingHours[].​endTimestring^([01]?\d|2[0-3]):[0-5]\d$
data.​workingHours[].​enabledboolean
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "name": "string",
    "status": "draft",
    "workingHours": [ … ]
  }
}

List campaigns

Request

List all campaigns for a specific organization

Path
organizationIdstringrequired
Query
statusstring
Enum"draft""active""paused""completed""failed""archived"
pagenumber>= 1
limitnumber[ 1 .. 100 ]
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns?limit=1&page=1&status=draft' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of campaigns

Bodyapplication/json
successbooleanrequired
Valuetrue
dataArray of objectsrequired
data[].​idnumberrequired
data[].​namestringrequired
data[].​statusstringrequired
Enum"draft""active""paused""completed""failed""archived"
data[].​totalMinutesnumberrequired
data[].​completedContactsnumberrequired
data[].​failedContactsnumberrequired
data[].​averageCallDurationnumber or nullrequired
data[].​successRatenumber or nullrequired
totalnumberrequired
pagenumberrequired
totalPagesnumberrequired
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "total": 0,
  "page": 0,
  "totalPages": 0
}

Get campaign details

Request

Get details for a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign details

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​organizationIdstringrequired
data.​namestringrequired
data.​descriptionstring or nullrequired
data.​statusstringrequired
Enum"draft""active""paused""completed""failed""archived"
data.​archivedbooleanrequired
data.​archivedAtstring or nullrequired
data.​deletedByUserbooleanrequired
data.​deletedAtstring or nullrequired
data.​agentIdnumberrequired
data.​fromNumberstringrequired
data.​timezonestring or nullrequired
data.​retryAttemptsnumber or nullrequired
data.​maxConcurrentCallsnumber or nullrequired
data.​maxMinutesPerDaynumber or nullrequired
data.​executeNewCallEverynumber or nullrequired
data.​workingHoursArray of objectsrequired
data.​workingHours[].​dayOfWeeknumber[ 0 .. 6 ]required
data.​workingHours[].​startTimestring^([01]?\d|2[0-3]):[0-5]\d$
data.​workingHours[].​endTimestring^([01]?\d|2[0-3]):[0-5]\d$
data.​workingHours[].​enabledboolean
data.​totalMinutesnumberrequired
data.​completedContactsnumberrequired
data.​failedContactsnumberrequired
data.​averageCallDurationnumber or nullrequired
data.​successRatenumber or nullrequired
data.​createdAtstringrequired
data.​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "organizationId": "string",
    "name": "string",
    "description": "string",
    "status": "draft",
    "archived": true,
    "archivedAt": "string",
    "deletedByUser": true,
    "deletedAt": "string",
    "agentId": 0,
    "fromNumber": "string",
    "timezone": "string",
    "retryAttempts": 0,
    "maxConcurrentCalls": 0,
    "maxMinutesPerDay": 0,
    "executeNewCallEvery": 0,
    "workingHours": [ … ],
    "totalMinutes": 0,
    "completedContacts": 0,
    "failedContacts": 0,
    "averageCallDuration": 0,
    "successRate": 0,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Update campaign details

Request

Update the details of a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
Bodyapplication/json
namestring
agentIdnumber
descriptionstring
timezonestring
fromNumberstring
retryAttemptsnumber[ 0 .. 3 ]
maxConcurrentCallsnumber>= 1
maxMinutesPerDaynumber[ 1 .. 1440 ]
executeNewCallEverynumber[ 1 .. 60 ]
workingHoursArray of objects
curl -i -X PATCH \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "agentId": 0,
    "description": "string",
    "timezone": "string",
    "fromNumber": "string",
    "retryAttempts": 3,
    "maxConcurrentCalls": 1,
    "maxMinutesPerDay": 1,
    "executeNewCallEvery": 1,
    "workingHours": [
      {
        "dayOfWeek": 6,
        "startTime": "string",
        "endTime": "string",
        "enabled": true
      }
    ]
  }'

Responses

Campaign updated successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​organizationIdstringrequired
data.​namestringrequired
data.​descriptionstring or nullrequired
data.​statusstringrequired
Enum"draft""active""paused""completed""failed""archived"
data.​agentIdnumberrequired
data.​fromNumberstringrequired
data.​timezonestring or nullrequired
data.​retryAttemptsnumber or nullrequired
data.​maxConcurrentCallsnumber or nullrequired
data.​maxMinutesPerDaynumber or nullrequired
data.​executeNewCallEverynumber or nullrequired
data.​workingHoursArray of objectsrequired
data.​workingHours[].​dayOfWeeknumber[ 0 .. 6 ]required
data.​workingHours[].​startTimestring^([01]?\d|2[0-3]):[0-5]\d$
data.​workingHours[].​endTimestring^([01]?\d|2[0-3]):[0-5]\d$
data.​workingHours[].​enabledboolean
data.​createdAtstringrequired
data.​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "organizationId": "string",
    "name": "string",
    "description": "string",
    "status": "draft",
    "agentId": 0,
    "fromNumber": "string",
    "timezone": "string",
    "retryAttempts": 0,
    "maxConcurrentCalls": 0,
    "maxMinutesPerDay": 0,
    "executeNewCallEvery": 0,
    "workingHours": [ … ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Delete a campaign

Request

Delete a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
curl -i -X DELETE \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign deleted successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
Response
application/json
{
  "success": true
}

Update campaign status

Request

Update the status of a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
Bodyapplication/json
actionstringrequired
Enum"start""pause""resume""stop"
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}/status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "start"
  }'

Responses

Campaign status updated

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​statusstringrequired
Enum"draft""active""paused""completed""failed""archived"
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "status": "draft"
  }
}

Import contacts

Request

Import contacts for a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
Bodyapplication/json
contactsArray of objectsrequired
contacts[].​firstNamestring
contacts[].​lastNamestring
contacts[].​fullNamestring
contacts[].​emailstring
contacts[].​phonestring^\+?[1-9]\d{1,14}$
contacts[].​jobTitlestring
contacts[].​linkedinUrlstring
contacts[].​companyobject
contacts[].​metadataobject
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}/contacts' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contacts": [
      {
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "email": "string",
        "phone": "string",
        "jobTitle": "string",
        "linkedinUrl": "string",
        "company": {
          "name": "string",
          "website": "string",
          "industry": "string",
          "size": "string",
          "linkedinUrl": "string"
        },
        "metadata": {
          "property1": null,
          "property2": null
        }
      }
    ]
  }'

Responses

Contacts imported successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​importednumberrequired
data.​failednumberrequired
data.​errorsArray of stringsrequired
Response
application/json
{
  "success": true,
  "data": {
    "imported": 0,
    "failed": 0,
    "errors": [ … ]
  }
}

Get campaign contacts

Request

Get all contacts for a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
Query
statusstring
Enum"pending""queued""completed""failed""in_progress"
pagenumber>= 1
limitnumber[ 1 .. 100 ]
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}/contacts?limit=1&page=1&status=pending' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of campaign contacts

Bodyapplication/json
successbooleanrequired
Valuetrue
dataArray of objectsrequired
data[].​idnumberrequired
data[].​targetIdnumberrequired
data[].​emailstring or nullrequired
data[].​firstNamestring or nullrequired
data[].​lastNamestring or nullrequired
data[].​phonestring or nullrequired
data[].​jobTitlestring or nullrequired
data[].​linkedinUrlstring or nullrequired
data[].​locationstring or nullrequired
data[].​senioritystring or nullrequired
data[].​rolestring or nullrequired
data[].​biostring or nullrequired
data[].​enrichmentConfidencenumber or nullrequired
data[].​statusstringrequired
Enum"pending""queued""completed""failed""in_progress""archived"
data[].​attemptsnumberrequired
data[].​metadataobject or nullrequired
data[].​metadata.​property name*any or nulladditional property
data[].​callsArray of objectsrequired
data[].​calls[].​idstringrequired
data[].​calls[].​statusstringrequired
Enum"pending""queued""in_progress""completed""failed"
data[].​calls[].​startedAtstring or nullrequired
data[].​calls[].​endedAtstring or nullrequired
data[].​calls[].​recordingUrlstring or nullrequired
data[].​calls[].​durationMsnumber or nullrequired
data[].​calls[].​failureReasonstring or nullrequired
data[].​calls[].​metadataobject
data[].​companyobject or nullrequired
data[].​company.​idnumberrequired
data[].​company.​namestringrequired
data[].​company.​websitestring or nullrequired
data[].​company.​industrystring or nullrequired
data[].​company.​sizestring or nullrequired
data[].​company.​linkedinUrlstring or nullrequired
data[].​company.​enrichedbooleanrequired
data[].​company.​metadataobject
totalnumberrequired
pagenumberrequired
totalPagesnumberrequired
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "total": 0,
  "page": 0,
  "totalPages": 0
}

Get call details

Request

Get details for a specific call

Path
organizationIdstringrequired
campaignIdstringrequired
callIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}/calls/{callId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Call details

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idstringrequired
data.​statusstringrequired
Enum"pending""queued""in_progress""completed""failed"
data.​startedAtstring or nullrequired
data.​endedAtstring or nullrequired
data.​recordingUrlstring or nullrequired
data.​durationMsnumber or nullrequired
data.​failureReasonstring or nullrequired
data.​disconnectReasonstring or nullrequired
data.​metadataobject
data.​contactobjectrequired
data.​contact.​idnumberrequired
data.​contact.​emailstring or nullrequired
data.​contact.​firstNamestring or nullrequired
data.​contact.​lastNamestring or nullrequired
data.​contact.​phonestring or nullrequired
data.​contact.​jobTitlestring or nullrequired
data.​contact.​linkedinUrlstring or nullrequired
data.​contact.​locationstring or nullrequired
data.​contact.​senioritystring or nullrequired
data.​contact.​rolestring or nullrequired
data.​contact.​biostring or nullrequired
data.​contact.​companyobject or nullrequired
data.​contact.​company.​idnumberrequired
data.​contact.​company.​namestringrequired
data.​contact.​company.​websitestring or nullrequired
data.​contact.​company.​industrystring or nullrequired
data.​contact.​company.​sizestring or nullrequired
data.​contact.​company.​linkedinUrlstring or nullrequired
data.​contact.​company.​enrichedbooleanrequired
data.​contact.​company.​metadataobject
data.​campaignobjectrequired
data.​campaign.​idnumberrequired
data.​campaign.​namestringrequired
data.​campaign.​statusstringrequired
Enum"draft""active""paused""completed""failed""archived"
data.​campaign.​agentIdnumberrequired
data.​campaign.​fromNumberstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": "string",
    "status": "pending",
    "startedAt": "string",
    "endedAt": "string",
    "recordingUrl": "string",
    "durationMs": 0,
    "failureReason": "string",
    "disconnectReason": "string",
    "metadata": { … },
    "contact": { … },
    "campaign": { … }
  }
}

Get calls by target ID

Request

Get all calls for a specific target

Path
organizationIdstringrequired
campaignIdstringrequired
targetIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}/targets/{targetId}/calls' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of calls

Bodyapplication/json
successbooleanrequired
Valuetrue
dataArray of objectsrequired
data[].​idstringrequired
data[].​statusstringrequired
Enum"pending""queued""in_progress""completed""failed"
data[].​startedAtstring or nullrequired
data[].​endedAtstring or nullrequired
data[].​recordingUrlstring or nullrequired
data[].​durationMsnumber or nullrequired
data[].​failureReasonstring or nullrequired
data[].​metadataobject
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ]
}

Export campaign contacts

Request

Export all contacts for a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}/export' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign executive report

Bodyapplication/json
successbooleanrequired
Valuetrue
dataArray of objectsrequired
data[].​contactobjectrequired
data[].​contact.​idnumberrequired
data[].​contact.​emailstring or nullrequired
data[].​contact.​firstNamestring or nullrequired
data[].​contact.​lastNamestring or nullrequired
data[].​contact.​phonestring or nullrequired
data[].​contact.​jobTitlestring or nullrequired
data[].​contact.​linkedinUrlstring or nullrequired
data[].​contact.​locationstring or nullrequired
data[].​contact.​senioritystring or nullrequired
data[].​contact.​rolestring or nullrequired
data[].​contact.​biostring or nullrequired
data[].​contact.​companyobject or nullrequired
data[].​contact.​company.​namestringrequired
data[].​contact.​company.​websitestring or nullrequired
data[].​contact.​company.​industrystring or nullrequired
data[].​contact.​company.​sizestring or nullrequired
data[].​contact.​company.​linkedinUrlstring or nullrequired
data[].​lastCallobject or nullrequired
data[].​lastCall.​idstringrequired
data[].​lastCall.​statusstringrequired
Enum"pending""queued""in_progress""completed""failed"
data[].​lastCall.​startedAtstring or nullrequired
data[].​lastCall.​endedAtstring or nullrequired
data[].​lastCall.​recordingUrlstring or nullrequired
data[].​lastCall.​durationMsnumber or nullrequired
data[].​lastCall.​failureReasonstring or nullrequired
data[].​lastCall.​metadataobject
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ]
}

Archive a campaign

Request

Archive a specific campaign

Path
organizationIdstringrequired
campaignIdstringrequired
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/campaigns/{campaignId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign archived successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​statusstringrequired
Enum"draft""active""paused""completed""failed""archived"
data.​archivedbooleanrequired
data.​archivedAtstring or nullrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "status": "draft",
    "archived": true,
    "archivedAt": "string"
  }
}

Meetings

Operations

Webhooks

Operations