# Set the return URL

`PUT https://app.booksbyinstant.com/api/integrator/v1/return-url`

Setting the same URL again is a 200 that changes nothing.

operationId `setReturnUrl`; tag Return URL.

## Example request

cURL:

```bash
curl -X PUT 'https://app.booksbyinstant.com/api/integrator/v1/return-url' \
  -H "Authorization: Bearer $INTEGRATOR_CREDENTIAL" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/"
}'
```

JavaScript:

```javascript
// Node 18 or later, in an ES module (.mjs), which allows the top-level await.
const res = await fetch("https://app.booksbyinstant.com/api/integrator/v1/return-url", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.INTEGRATOR_CREDENTIAL}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com/"
  }),
});
const data = await res.json();
```

Python:

```python
import os
import requests

res = requests.put(
    "https://app.booksbyinstant.com/api/integrator/v1/return-url",
    headers={
        "Authorization": f"Bearer {os.environ['INTEGRATOR_CREDENTIAL']}",
    },
    json={
        "url": "https://example.com/",
    },
)
data = res.json()
```

## Authorization

- Bearer token `live_<100 hex>`: `Authorization: Bearer <secret>`. A 401 answers `WWW-Authenticate: Bearer realm="instant-integrator-api"`.

## Request body

At most 4096 bytes.

`application/json`, required: object; no other fields

- `url` (string; required; at most 2000 characters; matches `^https://`): Where a member's browser comes back after a connection: an https URL without credentials. Instant never fetches it, so only its syntax is checked.

Example, built from the schema:

```json
{
  "url": "https://example.com/"
}
```

## Responses

### 200

The return URL.

`application/json`: object

- `returnUrl` (string; required)

Example, built from the schema:

```json
{
  "returnUrl": "string"
}
```

### 400

The body is not one JSON object, or a field is invalid; `error` says which. Also when the URL is not an https URL without credentials.

`application/json`: object; `Error`

Every answer that is not a success.

- `error` (string; required): Instant's sentence for people. A 4xx keeps the refusal's own sentence; a 5xx always says "Instant is temporarily unavailable. Please try again shortly."
- `code` (string; required): Stable, and what a caller branches on: VALIDATION_ERROR (400), UNAUTHENTICATED (401), FORBIDDEN (403), NOT_FOUND (404), CONFLICT (409), LIMIT_EXCEEDED (413), UNSUPPORTED_MEDIA_TYPE (415), UNREADABLE_FILE (422), RATE_LIMITED (429) and UNAVAILABLE (5xx). More codes may be added; treat one you do not know by its status.
- `retryAfter` (integer; at least `1`): Seconds to wait before retrying, also sent as the `Retry-After` header. Present only when there is a wait, as on a 429.
- `existingId` (string · uuid): On a 409 that names the object already there, such as a customer with that reference: its id.

Example, built from the schema:

```json
{
  "error": "string",
  "code": "VALIDATION_ERROR",
  "retryAfter": 1,
  "existingId": "01900000-0000-7000-8000-000000000000"
}
```

### 401

The credential is missing, malformed, unknown, revoked or rotated, or its integrator is disabled. All of these answer the same way.

Headers:

- `WWW-Authenticate` (string): Bearer realm="instant-integrator-api"

`application/json`: the `Error` object, as in 400.

### 413

The body is over 4096 bytes.

`application/json`: the `Error` object, as in 400.

### 415

The body is not sent as `application/json`.

`application/json`: the `Error` object, as in 400.

### 5XX

Instant is temporarily unavailable. Retry later, with backoff.

`application/json`: the `Error` object, as in 400.

---

Page: https://booksbyinstant.com/docs/set-return-url/ · Overview: https://booksbyinstant.com/docs/index.md