Update Export#

Updates the external_reference_id of an Export owned by your account. No other attribute of an Export can be changed.

Request#

HTTP Method: PATCH

URI Path: /v3/exports/{id}

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Export.

Request Body Object Attributes#

Name

Type

Nullable

Is Required?

Description

external_reference_id

string

True

No

Optional identifier for the Export in the customer’s external system. Maximum length is 100 characters. Send null to remove it.

Examples#

http

 1PATCH /v3/exports/88a29a27-11fe-4db0-a508-eca1d7cf0b68 HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Authorization: Bearer [access token]
 6
 7{
 8  "data": {
 9    "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68",
10    "type": "exports",
11    "attributes": {
12      "external_reference_id": "report-2026-09"
13    }
14  }
15}

curl

1curl -i -X PATCH https://api.didww.com/v3/exports/88a29a27-11fe-4db0-a508-eca1d7cf0b68 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"external_reference_id": "report-2026-09"}, "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68", "type": "exports"}}'

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68",
 7    "type": "exports",
 8    "attributes": {
 9      "status": "completed",
10      "created_at": "2026-10-21T07:37:13.085Z",
11      "external_reference_id": "report-2026-09",
12      "url": "https://api.didww.com/v3/exports/a8bf7c0e-0c08-44ca-b0e2-db34a1d2006a.csv.gz",
13      "callback_url": null,
14      "callback_method": null,
15      "export_type": "cdr_out",
16      "filters": {
17        "from": "2026-09-01 00:00:00",
18        "to": "2026-09-30 23:59:59",
19        "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753"
20      }
21    }
22  },
23  "meta": {
24    "api_version": "2026-11-19"
25  }
26}

Other Responses#

Code

Success

Description

422

No

Unprocessable Entity

404

No

Not Found

400

No

Bad Request

401

No

Unauthorized

403

No

The access token carries the read scope, which does not cover this method (title Insufficient scope). The response carries WWW-Authenticate: Bearer error="insufficient_scope". See Scopes.

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.