PATCH/desk/api/v2/scheduledemails/{id}.json

Update a scheduledemail.

Update all the given properties for this resource. Any omitted properties will be unchanged.

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

ScheduledEmailAPIBody handles the get/create/update request/response for scheduledemail.

    • Name
      included
      Type
      object
      Description
      Included allows adding referenced objects on the API response. The included keys should map to the `types` in the Relationship slices/objects.
    • Name
      scheduledemail
      Type
      object
      Description
      ScheduledEmail represents a ScheduledEmail.
    • Name
      sendNow
      Type
      boolean

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      ScheduledEmailAPIBody handles the get/create/update request/response for scheduledemail.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    200 OK

    ScheduledEmailAPIBody
    {  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",        "createdAt": "2024-10-10T18:19:26.131Z",
    Download Swagger