PUT /attachments/{id}

Updates an attachment with a specified ID.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

ID of the attachment.

_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "file"
  • "self"
relatedId String Yes

ID of the linked object.

_embedded Object No

Embedded objects that are requested by the expand query parameter.

_embedded.file Object No
name String No

Name of original attachment.

fileId String Yes

ID of the linked file object.

description String No

Description of the attachment.

updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

relatedType String Yes

Linked object type.

Valid values:

  • "organization"
  • "transaction-timeline-comment"
  • "customer-timeline-comment"
  • "transaction"
  • "subscription"
  • "customer"
  • "customer-edd-timeline-comment"
  • "order-timeline-comment"
  • "invoice-timeline-comment"
  • "plan"
  • "gateway-timeline-comment"
  • "product"
  • "dispute"
  • "payment"
  • "invoice"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.