Links › Switch several links on or off
Links
Switch several links on or off
PATCH/api/{ORG}/linksPermalink
Answers the BulkResult.
- Permission
- Links · edit
- Plan
- Plans that include the API: Pricing
- Retry
- Safe with an
Idempotency-Key
Example request
curl -X PATCH "https://console.brevily.com/api/NORTHWIND/links" \ -H "x-api-key: brv_ak_7Fq2Lw9xK3" \ -H "x-api-secret: $BREVILY_SECRET" \ -H "Idempotency-Key: 4f9c1e2a-autumn" \ -H "Content-Type: application/json" \ -d '{ "ids": [ "example" ], "status": "ACTIVE" }'const res = await fetch("https://console.brevily.com/api/NORTHWIND/links", { method: "PATCH", headers: { "x-api-key": "brv_ak_7Fq2Lw9xK3", "x-api-secret": process.env.BREVILY_SECRET, "Idempotency-Key": "4f9c1e2a-autumn", "Content-Type": "application/json", }, body: JSON.stringify({ "ids": [ "example" ], "status": "ACTIVE" }),});const answer = await res.json();Example answer
{ "done": 1, "skipped": 0, "more": false}{ "code": "VALIDATION_FAILED", "message": "Check the form. ids: Not a value this field takes.", "details": { "fields": { "ids": "Not a value this field takes." } }, "requestId": "18188559082372202519"}Made-up values. Send your own Idempotency-Key, one per change.
PathPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
ORG | string | required | Your organisation’s code. | 3 to 20 characters |
BodyPermalink
JSON. An unknown field is refused with a 400 naming it.
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
ids | string[] | required | The links, 1 to 100. | — |
status | string | required | Switch them on or off. | ACTIVE, DISABLED |
AnswerPermalink
BulkResult
| Name | Type | Description | Allowed values |
|---|---|---|---|
done | integer | Links changed. | — |
skipped | integer | Links that could not change that way, or already had. | — |
more | boolean | Select all matched more than one run takes: run it again for the rest. | — |
ErrorsPermalink
| Status | Code | When |
|---|---|---|
| 400 | VALIDATION_FAILED |
A field, a parameter or the body is wrong; details.fields says which. |
| 400 | IDEMPOTENCY_KEY_INVALID |
The Idempotency-Key is longer than 255 characters. |
| 401 | UNAUTHENTICATED |
No key, a key that does not match, or one expired or revoked. |
| 403 | ACCESS_DENIED |
The key lacks Links · edit, or the organisation’s plan does not include it. |
| 404 | NOT_FOUND |
No organisation with that code for this key, or no such record in it. |
| 409 | CONFLICT |
|
| 409 | IDEMPOTENCY_IN_FLIGHT |
The first call with this Idempotency-Key is still running. |
| 413 | PAYLOAD_TOO_LARGE |
|
| 415 | UNSUPPORTED_MEDIA |
|
| 422 | IDEMPOTENCY_MISMATCH |
The same Idempotency-Key was sent with a different request. |
| 429 | RATE_LIMITED |
Too many calls: wait Retry-After seconds. |
Rate limitsPermalink
Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.
Type a call, a field or a guide.