/
Create an attachment

Create an attachment

Request

Attaches a file to one or multiple objects, such as: customer, dispute, transaction, order, plan, product, invoice, or timeline comment. Attachments enable you to quickly find and use files related to specific entities.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Attachment resource.

fileIdstring, <= 50 charactersrequired

ID of the linked file object.

Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
relatedTypestringrequired

Linked object type.

Enum:"customer""customer-timeline-comment""dispute""gateway-timeline-comment""invoice""invoice-timeline-comment""order-timeline-comment""organization""payment""plan"
relatedIdstringrequired

ID of the linked object.

namestring

Name of original attachment.

descriptionstring

Description of the attachment.

curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/attachments \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
    "relatedType": "customer",
    "relatedId": "string",
    "name": "string",
    "description": "string"
  }'

Responses

Attachment created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the attachment.

Example:"att_0YV7J787J0DW0918MQQMDHWA7M"
fileIdstring, <= 50 charactersrequired

ID of the linked file object.

Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
relatedTypestringrequired

Linked object type.

Enum:"customer""customer-timeline-comment""dispute""gateway-timeline-comment""invoice""invoice-timeline-comment""order-timeline-comment""organization""payment""plan"
relatedIdstringrequired

ID of the linked object.

namestring

Name of original attachment.

descriptionstring

Description of the attachment.

createdTimestring, (date-time)(CreatedTime)read-only

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

updatedTimestring, (date-time)(UpdatedTime)read-only

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

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "att_0YV7J787J0DW0918MQQMDHWA7M",
  "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
  "relatedType": "customer",
  "relatedId": "string",
  "name": "string",
  "description": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ],
  "_embedded": {
    "file": {}
  }
}