SynqDocs
Management APIBrands

Change a brand's sign-in page

Changes the parts sent and keeps the rest. At most 4 ways shown first (`too_many_shown`) and at least one way to sign in on (`no_way_to_sign_in`). Turning a way off takes effect everywhere at once: read `GET …/sign-in-page/impact` first to see who it affects. Needs `org.brands.edit`. Recorded as `brand.updated`, each part as `sign_in_page.<part>`.

PATCH/v1/orgs/{org}/brands/{brand}/sign-in-page

Changes the parts sent and keeps the rest. At most 4 ways shown first (too_many_shown) and at least one way to sign in on (no_way_to_sign_in). Turning a way off takes effect everywhere at once: read GET …/sign-in-page/impact first to see who it affects. Needs org.brands.edit. Recorded as brand.updated, each part as sign_in_page.<part>.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
brand*string

The brand's id

Match^brd_[0-9a-hjkmnp-tv-z]{26}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Changes the parts sent and keeps the rest: methods replaces the whole list, place moves only the ways it names, email replaces the whole step after the address, returning the page for people coming back

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/sign-in-page" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "methods": [      {        "method": "google",        "placement": "shown",        "off_for": "everyone"      }    ],    "place": [      {        "method": "discord",        "placement": "shown",        "position": 1      }    ],    "email": {      "password": true,      "code": true,      "lead": "password"    },    "returning": "last_only"  }'
{  "methods": [    {      "method": "google",      "name": "Google",      "kind": "provider",      "placement": "shown",      "off_for": null,      "available": true,      "link_only": false,      "community_links": false,      "icon_url": null    }  ],  "max_shown": 4,  "email": {    "password": true,    "code": true,    "lead": "password"  },  "returning": "last_only"}