UPupflow
Actions

Get Action

This endpoint can be used to retrieve a specific action by its ID.

get/actions/{actionId}

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Response

Action details.

idstring uuid required

The Action ID.

namestring required

The action's name.

type'EMAIL' | 'SMS' | 'CALL' | 'TASK' | 'LETTER' | 'REGISTERED_LETTER' required

The action's type

createdAtstring date-time required

The date at which the action was created (ISO 8601 format).

dueDatestring date-time required

The date when the action is due (ISO 8601 format).

performedAtstring date-time nullable

The date when the action was performed (ISO 8601 format).

state'TODO' | 'IGNORED' | 'EXECUTED' | 'IN_PROGRESS' | 'FAILED' required

State of the action.

source'WORKFLOW' | 'CAMPAIGN' | 'BILLING'

The source of the action.

updatedAtstring date-time

The date at which the action was last updated (ISO 8601 format).

Example response

{
  "id": "00a70b35-2be3-4c43-aefb-397190134655",
  "name": "1st reminder: payment not received",
  "type": "EMAIL",
  "customer": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "externalId": "1a2c3b",
    "companyName": "Upflow SAS",
    "accountingRef": "UPFL-SAS"
  },
  "createdAt": "2015-05-05T12:30:00Z",
  "dueDate": "2015-05-05T12:30:00Z",
  "performedAt": "2015-05-05T12:30:00Z",
  "dunningPlan": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "name": "Standard dunning plan"
  },
  "performedBy": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "firstName": "John",
    "lastName": "Doe",
    "email": "user@email.com"
  },
  "assignedTo": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "firstName": "John",
      "lastName": "Doe",
      "email": "user@email.com"
    }
  ],
  "recipients": [
    {
      "type": "EMAIL",
      "email": "recipient@company.com"
    },
    {
      "type": "CONTACT",
      "email": "contact@email.com",
      "phone": "+12673148110"
    }
  ],
  "updatedAt": "2015-05-05T12:30:00Z",
  "carryingInvoice": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "externalId": "92842AB37",
    "customId": "FAC123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.