Calls

The calls you are able to fetch might be filtered by your service account's permissions, and the organization you represent.

The collection you are paginating is sorted by creation datetime, descending. This means that the first page contains the most recently created calls.

GET/api/v1/calls

Authorization

bearer

Query parameters

Response

200400401403default

Body

application/json

edges*array of CallEdgeDto (object)

pageInfo*PageInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/calls', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200default

{
  "edges": [
    {
      "node": {
        "uuid": "5cf67f69-34d0-46fe-b904-20d56248a844",
        "status": "requested",
        "requestedAt": "2024-11-21T06:47:19.489Z",
        "externalMetadata": {
          "applicationName": "basicall",
          "referenceId": "ref_1234567890",
          "agentReferenceId": "agent_1234567890",
          "statusCode": "completed",
          "statusDescription": "The call was completed successfully",
          "additionalProperties": {
            "foo": "bar"
          }
        },
        "attempts": [
          {
            "userUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
            "attemptAt": "2024-11-21T06:47:19.489Z",
            "createdAt": "2024-11-21T06:47:19.489Z"
          }
        ],
        "attemptsCount": 1,
        "result": {
          "resultCode": "confirmed",
          "completedAt": "2024-11-21T06:47:19.489Z",
          "notes": "text",
          "duration": 120.23,
          "donorRetentionRating": 7
        },
        "lastUpdatedAt": "2024-11-21T06:47:19.489Z",
        "cancelledAt": "2024-11-21T06:47:19.489Z",
        "completedAt": "2024-11-21T06:47:19.489Z",
        "expiredAt": "2024-11-21T06:47:19.489Z",
        "notes": "text",
        "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
        "relatedCaseUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
        "callingOrganizationUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
        "type": "happy_call"
      },
      "cursor": "48094b0e-15b3-430f-ab5a-16ecf12b9171"
    }
  ],
  "pageInfo": {
    "startCursor": "48094b0e-15b3-430f-ab5a-16ecf12b9171",
    "endCursor": "494d74df-6fbc-46a3-811e-1c17230340a1",
    "hasPreviousPage": true,
    "hasNextPage": false
  }
}

Create a call

This endpoint creates a call for a person (and pledge case), if your service account allows you to.

The person you are allowed to create a call for is also limited by your service account.

We advice you to provide your own 'uuid' value, as you can use this as a mechanism to ensure the call is only created once. If the call is accidentally posted twice, the uuid will ensure it is only saved the first time, and a 409 CONFLICT status will be returned when posted a second time with the same uuid. When you don't supply a uuid, the system will generate one for you, which will be returned in the response body.

This endpoint will return the created call in the response body.

Determining where the call will be managed

When creating a call through the API, you need to determine where the call will be managed. You can do this by supplying or not supplying an externalMetadata-property in the request body. Based upon the value of this property, different input validation and domain rules apply.

When you don't supply external metadata, we consider the call to be primarily managed in TapRaise.app, and it needs to adhere to TapRaise's domain rules that are there to ensure it's validity and quality.

When you supply external metadata, we consider the call to be primarily managed at that source, and do NOT apply the domain rules we apply on calls managed in TapRaise. We consider it as external data that cannot be updated in TapRaise.app.

Be sure to check the descriptions for fields in the request body to see which fields are required, optional or forbidden for each scenario.

POST/api/v1/calls

Authorization

bearer

Body

application/json

uuidstring (uuid)

UUID (v4). The call's globally unique identifier in the system. If not provided, a new UUID will be generated.

Example: "82b431f0-f401-4afd-b6db-9d1d751232d9"

statusenum

The current status of the call:

• requested → a call is requested and should be made. Initial status.
• completed → a call is done and completed. End status.
• cancelled → a call was requested but is cancelled and thus never called. End status.
• expired → a call was expired since the person was not reached within a specified number of attempts. End status.

Status is not allowed to be set when creating a call that is managed in TapRaise. It will by default get assigned status requested after creation. Externally sourced calls are allowed to be created with any status from the whitelist.

Example: "requested"

completedrequestedcancelledexpired

requestedAt*string (date-time)

ISO8601 compatible datetime string

externalMetadataall of

When provided the call is considered to be managed in this external system, and the call is not editable in TapRaise and does not need to adhere to the TapRaise domain rules. See the general description of this endpoint for more information.

attemptsarray of CallAttemptInput (object)

Contains a collection of attempts that were made to complete the call. Not to be supplied when a call is managed in TapRaise, as then the call will be created as requested and locally will not have any attempts yet.

resultall of

The result of a completed call. As we don't allow a call to be created completed, when to be managed in TapRaise.app, this field is not allowed to be set in that case.

requestedByUserUuidstring (uuid)

UUID (v4) of the user that requested this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

cancelledAtstring

Date when call got cancelled, formatted as ISO8601 date string.

Example: "2023-05-01T00:00:00.000Z"

completedAtstring

Date when call got completed, formatted as ISO8601 date string.

Example: "2023-05-01T00:00:00.000Z"

notesstring

The notes of the call

personUuid*string (uuid)

UUID (v4) of the person that is being called.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

relatedCaseUuidstring (uuid)

UUID (v4) of any of the person's pledge cases that is related to this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

callingOrganizationUuidstring (uuid)

UUID (v4) of the organization that will perform this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

type*enum

The type of call:

• verification → used for verifying the personal details when a donor was newly recruited.
• happy_call → used for existing donors to keep them engaged.
• winback → used for donors to get them resubscribed.

Call type is not allowed to be set when creating a call that is managed externally. It will by default get assigned type verification after creation.

Example: "verification"

verificationhappy_callwinback

Response

201400401403409

Call was created

Body

application/json

uuid*string (uuid)

UUID (v4)

Example: "5cf67f69-34d0-46fe-b904-20d56248a844"

status*enum

The current status of the call:

• requested → a call is requested and should be made. Initial status.
• completed → a call is done and completed. End status.
• cancelled → a call was requested but is cancelled and thus never called. End status.
• expired → a call was expired since the person was not reached within a specified number of attempts. End status.

Example: "requested"

completedrequestedcancelledexpired

requestedAt*string (date-time)

ISO8601 compatible datetime string

externalMetadata*nullable all of

attempts*array of CallAttemptDto (object)

Contains a collection of attempts that were made to complete the call

attemptsCount*number

The number of call attempts

Example: 1

result*nullable all of

The result of a completed call

lastUpdatedAt*string (date-time)

ISO8601 compatible datetime string

cancelledAt*nullable string (date-time)

ISO8601 compatible datetime string

completedAt*nullable string (date-time)

ISO8601 compatible datetime string

expiredAt*nullable string (date-time)

ISO8601 compatible datetime string

notes*nullable string

The notes of the call

personUuid*string (uuid)

UUID (v4) of the person that is being called.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

relatedCaseUuid*nullable string (uuid)

UUID (v4) of any of the person's pledge cases that is related to this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

callingOrganizationUuid*nullable string (uuid)

UUID (v4) of the organization that will perform this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

type*enum

The current type of the call:

• verification → used for verifying the personal details when a donor was newly recruited.
• happy_call → used for existing donors to keep them engaged.
• winback → used for donors to get them resubscribed.

Example: "happy_call"

verificationhappy_callwinback

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/calls', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestedAt": "2024-11-21T06:47:19.489Z",
      "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
      "type": "verification"
    }),
});
const data = await response.json();

Response

201

{
  "uuid": "5cf67f69-34d0-46fe-b904-20d56248a844",
  "status": "requested",
  "requestedAt": "2024-11-21T06:47:19.489Z",
  "externalMetadata": {
    "applicationName": "basicall",
    "referenceId": "ref_1234567890",
    "agentReferenceId": "agent_1234567890",
    "statusCode": "completed",
    "statusDescription": "The call was completed successfully",
    "additionalProperties": {
      "foo": "bar"
    }
  },
  "attempts": [
    {
      "userUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
      "attemptAt": "2024-11-21T06:47:19.489Z",
      "createdAt": "2024-11-21T06:47:19.489Z"
    }
  ],
  "attemptsCount": 1,
  "result": {
    "resultCode": "confirmed",
    "completedAt": "2024-11-21T06:47:19.489Z",
    "notes": "text",
    "duration": 120.23,
    "donorRetentionRating": 7
  },
  "lastUpdatedAt": "2024-11-21T06:47:19.489Z",
  "cancelledAt": "2024-11-21T06:47:19.489Z",
  "completedAt": "2024-11-21T06:47:19.489Z",
  "expiredAt": "2024-11-21T06:47:19.489Z",
  "notes": "text",
  "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "relatedCaseUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "callingOrganizationUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "type": "happy_call"
}

Add a call attempt

This endpoint adds a call attempt to a call, if your service account allows you to. A call attempt is a record of a call being made to a person. It is used to keep track of how many times a person has been called, and when the last call was made. It is also used to determine if a person should be called again, based on the maximum number of call attempts allowed for a person. The maximum number of call attempts is determined by the owning organization of the person. The owning organization is the organization that the person belongs to. The owning organization is determined by the person's owning organization uuid.

PUT/api/v1/calls/{uuid}/actions/add-attempt

Authorization

bearer

Path parameters

uuid*string (uuid)

The uuid of the call

Body

application/json

userUuidstring (uuid)

UUID (v4) of the user that attempted the call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

attemptAtstring

Timestamp when a call was attempted, formatted as ISO8601 date string.

Example: "2023-05-01T00:00:00.000Z"

Response

200400401403404

Call attempt was added

Body

application/json

uuid*string (uuid)

UUID (v4)

Example: "5cf67f69-34d0-46fe-b904-20d56248a844"

status*enum

The current status of the call:

• requested → a call is requested and should be made. Initial status.
• completed → a call is done and completed. End status.
• cancelled → a call was requested but is cancelled and thus never called. End status.
• expired → a call was expired since the person was not reached within a specified number of attempts. End status.

Example: "requested"

completedrequestedcancelledexpired

requestedAt*string (date-time)

ISO8601 compatible datetime string

externalMetadata*nullable all of

attempts*array of CallAttemptDto (object)

Contains a collection of attempts that were made to complete the call

attemptsCount*number

The number of call attempts

Example: 1

result*nullable all of

The result of a completed call

lastUpdatedAt*string (date-time)

ISO8601 compatible datetime string

cancelledAt*nullable string (date-time)

ISO8601 compatible datetime string

completedAt*nullable string (date-time)

ISO8601 compatible datetime string

expiredAt*nullable string (date-time)

ISO8601 compatible datetime string

notes*nullable string

The notes of the call

personUuid*string (uuid)

UUID (v4) of the person that is being called.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

relatedCaseUuid*nullable string (uuid)

UUID (v4) of any of the person's pledge cases that is related to this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

callingOrganizationUuid*nullable string (uuid)

UUID (v4) of the organization that will perform this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

type*enum

The current type of the call:

• verification → used for verifying the personal details when a donor was newly recruited.
• happy_call → used for existing donors to keep them engaged.
• winback → used for donors to get them resubscribed.

Example: "happy_call"

verificationhappy_callwinback

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/calls/{uuid}/actions/add-attempt', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "uuid": "5cf67f69-34d0-46fe-b904-20d56248a844",
  "status": "requested",
  "requestedAt": "2024-11-21T06:47:19.489Z",
  "externalMetadata": {
    "applicationName": "basicall",
    "referenceId": "ref_1234567890",
    "agentReferenceId": "agent_1234567890",
    "statusCode": "completed",
    "statusDescription": "The call was completed successfully",
    "additionalProperties": {
      "foo": "bar"
    }
  },
  "attempts": [
    {
      "userUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
      "attemptAt": "2024-11-21T06:47:19.489Z",
      "createdAt": "2024-11-21T06:47:19.489Z"
    }
  ],
  "attemptsCount": 1,
  "result": {
    "resultCode": "confirmed",
    "completedAt": "2024-11-21T06:47:19.489Z",
    "notes": "text",
    "duration": 120.23,
    "donorRetentionRating": 7
  },
  "lastUpdatedAt": "2024-11-21T06:47:19.489Z",
  "cancelledAt": "2024-11-21T06:47:19.489Z",
  "completedAt": "2024-11-21T06:47:19.489Z",
  "expiredAt": "2024-11-21T06:47:19.489Z",
  "notes": "text",
  "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "relatedCaseUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "callingOrganizationUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "type": "happy_call"
}

Mark a call as completed

This endpoint marks a call as completed, if your service account allows you to. A call can marked as completed when a call has been made to a person.

PUT/api/v1/calls/{uuid}/actions/complete

Authorization

bearer

Path parameters

uuid*string (uuid)

The uuid of the call

Body

application/json

userUuidstring (uuid)

UUID (v4) of the user that completes the call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

result*all of

The result of a completed call.

Response

200400401403404

Call that was marked as completed

Body

application/json

uuid*string (uuid)

UUID (v4)

Example: "5cf67f69-34d0-46fe-b904-20d56248a844"

status*enum

The current status of the call:

• requested → a call is requested and should be made. Initial status.
• completed → a call is done and completed. End status.
• cancelled → a call was requested but is cancelled and thus never called. End status.
• expired → a call was expired since the person was not reached within a specified number of attempts. End status.

Example: "requested"

completedrequestedcancelledexpired

requestedAt*string (date-time)

ISO8601 compatible datetime string

externalMetadata*nullable all of

attempts*array of CallAttemptDto (object)

Contains a collection of attempts that were made to complete the call

attemptsCount*number

The number of call attempts

Example: 1

result*nullable all of

The result of a completed call

lastUpdatedAt*string (date-time)

ISO8601 compatible datetime string

cancelledAt*nullable string (date-time)

ISO8601 compatible datetime string

completedAt*nullable string (date-time)

ISO8601 compatible datetime string

expiredAt*nullable string (date-time)

ISO8601 compatible datetime string

notes*nullable string

The notes of the call

personUuid*string (uuid)

UUID (v4) of the person that is being called.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

relatedCaseUuid*nullable string (uuid)

UUID (v4) of any of the person's pledge cases that is related to this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

callingOrganizationUuid*nullable string (uuid)

UUID (v4) of the organization that will perform this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

type*enum

The current type of the call:

• verification → used for verifying the personal details when a donor was newly recruited.
• happy_call → used for existing donors to keep them engaged.
• winback → used for donors to get them resubscribed.

Example: "happy_call"

verificationhappy_callwinback

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/calls/{uuid}/actions/complete', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "result": {
        "completedAt": "2023-05-01T00:00:00.000Z",
        "resultCode": "confirmed"
      }
    }),
});
const data = await response.json();

Response

200

{
  "uuid": "5cf67f69-34d0-46fe-b904-20d56248a844",
  "status": "requested",
  "requestedAt": "2024-11-21T06:47:19.489Z",
  "externalMetadata": {
    "applicationName": "basicall",
    "referenceId": "ref_1234567890",
    "agentReferenceId": "agent_1234567890",
    "statusCode": "completed",
    "statusDescription": "The call was completed successfully",
    "additionalProperties": {
      "foo": "bar"
    }
  },
  "attempts": [
    {
      "userUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
      "attemptAt": "2024-11-21T06:47:19.489Z",
      "createdAt": "2024-11-21T06:47:19.489Z"
    }
  ],
  "attemptsCount": 1,
  "result": {
    "resultCode": "confirmed",
    "completedAt": "2024-11-21T06:47:19.489Z",
    "notes": "text",
    "duration": 120.23,
    "donorRetentionRating": 7
  },
  "lastUpdatedAt": "2024-11-21T06:47:19.489Z",
  "cancelledAt": "2024-11-21T06:47:19.489Z",
  "completedAt": "2024-11-21T06:47:19.489Z",
  "expiredAt": "2024-11-21T06:47:19.489Z",
  "notes": "text",
  "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "relatedCaseUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "callingOrganizationUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "type": "happy_call"
}

Cancel a call

This endpoint cancells a call.

The person who is allowed to cancel a call is limited by your service account.

This endpoint will return the cancelled call in the response body.

PUT/api/v1/calls/{uuid}/actions/cancel

Authorization

bearer

Path parameters

uuid*string

Body

application/json

cancelledAtstring

Timestamp when a call was cancelled, formatted as ISO8601 date string.

Example: "2023-05-01T00:00:00.000Z"

Response

200400401403404409

Call was cancelled

Body

application/json

uuid*string (uuid)

UUID (v4)

Example: "5cf67f69-34d0-46fe-b904-20d56248a844"

status*enum

The current status of the call:

• requested → a call is requested and should be made. Initial status.
• completed → a call is done and completed. End status.
• cancelled → a call was requested but is cancelled and thus never called. End status.
• expired → a call was expired since the person was not reached within a specified number of attempts. End status.

Example: "requested"

completedrequestedcancelledexpired

requestedAt*string (date-time)

ISO8601 compatible datetime string

externalMetadata*nullable all of

attempts*array of CallAttemptDto (object)

Contains a collection of attempts that were made to complete the call

attemptsCount*number

The number of call attempts

Example: 1

result*nullable all of

The result of a completed call

lastUpdatedAt*string (date-time)

ISO8601 compatible datetime string

cancelledAt*nullable string (date-time)

ISO8601 compatible datetime string

completedAt*nullable string (date-time)

ISO8601 compatible datetime string

expiredAt*nullable string (date-time)

ISO8601 compatible datetime string

notes*nullable string

The notes of the call

personUuid*string (uuid)

UUID (v4) of the person that is being called.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

relatedCaseUuid*nullable string (uuid)

UUID (v4) of any of the person's pledge cases that is related to this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

callingOrganizationUuid*nullable string (uuid)

UUID (v4) of the organization that will perform this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

type*enum

The current type of the call:

• verification → used for verifying the personal details when a donor was newly recruited.
• happy_call → used for existing donors to keep them engaged.
• winback → used for donors to get them resubscribed.

Example: "happy_call"

verificationhappy_callwinback

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/calls/{uuid}/actions/cancel', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "uuid": "5cf67f69-34d0-46fe-b904-20d56248a844",
  "status": "requested",
  "requestedAt": "2024-11-21T06:47:19.489Z",
  "externalMetadata": {
    "applicationName": "basicall",
    "referenceId": "ref_1234567890",
    "agentReferenceId": "agent_1234567890",
    "statusCode": "completed",
    "statusDescription": "The call was completed successfully",
    "additionalProperties": {
      "foo": "bar"
    }
  },
  "attempts": [
    {
      "userUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
      "attemptAt": "2024-11-21T06:47:19.489Z",
      "createdAt": "2024-11-21T06:47:19.489Z"
    }
  ],
  "attemptsCount": 1,
  "result": {
    "resultCode": "confirmed",
    "completedAt": "2024-11-21T06:47:19.489Z",
    "notes": "text",
    "duration": 120.23,
    "donorRetentionRating": 7
  },
  "lastUpdatedAt": "2024-11-21T06:47:19.489Z",
  "cancelledAt": "2024-11-21T06:47:19.489Z",
  "completedAt": "2024-11-21T06:47:19.489Z",
  "expiredAt": "2024-11-21T06:47:19.489Z",
  "notes": "text",
  "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "relatedCaseUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "callingOrganizationUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "type": "happy_call"
}

Expires a call at a given date

This endpoint marks a call as expired. If no expiry date is provided, the call will be set to have expired on the timestamp this request was processed.

The person who is allowed to add an expiry date is limited by your service account.

Whether your service account is allowed to expire a call, is dependent on your service account's access scope.

PUT/api/v1/calls/{uuid}/actions/expire

Authorization

bearer

Path parameters

uuid*string

Body

application/json

expiredAtstring

Expiry date of a call, formatted as ISO8601 date string.

Example: "2023-05-01T00:00:00.000Z"

Response

200400401403404

Call expiry date was set

Body

application/json

uuid*string (uuid)

UUID (v4)

Example: "5cf67f69-34d0-46fe-b904-20d56248a844"

status*enum

The current status of the call:

• requested → a call is requested and should be made. Initial status.
• completed → a call is done and completed. End status.
• cancelled → a call was requested but is cancelled and thus never called. End status.
• expired → a call was expired since the person was not reached within a specified number of attempts. End status.

Example: "requested"

completedrequestedcancelledexpired

requestedAt*string (date-time)

ISO8601 compatible datetime string

externalMetadata*nullable all of

attempts*array of CallAttemptDto (object)

Contains a collection of attempts that were made to complete the call

attemptsCount*number

The number of call attempts

Example: 1

result*nullable all of

The result of a completed call

lastUpdatedAt*string (date-time)

ISO8601 compatible datetime string

cancelledAt*nullable string (date-time)

ISO8601 compatible datetime string

completedAt*nullable string (date-time)

ISO8601 compatible datetime string

expiredAt*nullable string (date-time)

ISO8601 compatible datetime string

notes*nullable string

The notes of the call

personUuid*string (uuid)

UUID (v4) of the person that is being called.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

relatedCaseUuid*nullable string (uuid)

UUID (v4) of any of the person's pledge cases that is related to this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

callingOrganizationUuid*nullable string (uuid)

UUID (v4) of the organization that will perform this call.

Example: "f5e2ba11-1786-4ba9-bd5a-0d99317f4706"

type*enum

The current type of the call:

• verification → used for verifying the personal details when a donor was newly recruited.
• happy_call → used for existing donors to keep them engaged.
• winback → used for donors to get them resubscribed.

Example: "happy_call"

verificationhappy_callwinback

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/calls/{uuid}/actions/expire', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "uuid": "5cf67f69-34d0-46fe-b904-20d56248a844",
  "status": "requested",
  "requestedAt": "2024-11-21T06:47:19.489Z",
  "externalMetadata": {
    "applicationName": "basicall",
    "referenceId": "ref_1234567890",
    "agentReferenceId": "agent_1234567890",
    "statusCode": "completed",
    "statusDescription": "The call was completed successfully",
    "additionalProperties": {
      "foo": "bar"
    }
  },
  "attempts": [
    {
      "userUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
      "attemptAt": "2024-11-21T06:47:19.489Z",
      "createdAt": "2024-11-21T06:47:19.489Z"
    }
  ],
  "attemptsCount": 1,
  "result": {
    "resultCode": "confirmed",
    "completedAt": "2024-11-21T06:47:19.489Z",
    "notes": "text",
    "duration": 120.23,
    "donorRetentionRating": 7
  },
  "lastUpdatedAt": "2024-11-21T06:47:19.489Z",
  "cancelledAt": "2024-11-21T06:47:19.489Z",
  "completedAt": "2024-11-21T06:47:19.489Z",
  "expiredAt": "2024-11-21T06:47:19.489Z",
  "notes": "text",
  "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "relatedCaseUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "callingOrganizationUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
  "type": "happy_call"
}