Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Email Sequence

EmailSequenceActivityLogs.update

Modifies EmailSequenceActivityLog or EmailSequenceActivityLogs with given id(s)

patch/entities/EmailSequenceActivityLogs/{id}

Path parameters

idstring uuid required

ID of EmailSequenceActivityLog to update

Query parameters

validation-levelinteger

Specify validation level of EmailSequenceActivityLog on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

actor_idstring uuid

Id of the actor.

application_idstring uuid

Id of the application.

email_sequence_idstring uuid

Id of the email sequence.

end_timestring date-time

Timestamp when the run finished. Empty for runs still in progress.

is_test_runboolean

True when the run was a dry-run / test execution and did not produce real-side effects.

start_timestring date-time

Timestamp when the run started.

status1 | 2 | 3 | 4 | 5

Outcome of the run (e.g. Ok, Error, Cancelled).

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired

Example request

{
  "actor_id": "01234567-abcd-dcba-ffff-000000000000",
  "application_id": "01234567-abcd-dcba-ffff-000000000000",
  "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
  "end_time": "2019-01-01T00:00:00",
  "start_time": "2019-01-01T00:00:00",
  "status": 1
}

Response

Modification confirmation. Returns resulting EmailSequenceActivityLog

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "actor_id": "01234567-abcd-dcba-ffff-000000000000",
    "application_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "end_time": "2019-01-01T00:00:00",
    "start_time": "2019-01-01T00:00:00",
    "status": 1,
    "record_name": "string",
    "record_email": "string"
  }
}