Link Branding
Retrieve all branded links [GET]
Link Brandingの設定一覧取得Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
|
Create a branded link [POST]
Link Brandingの作成Link Brandingは最大3000まで作成可能です。
Body引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain | Yes | string | Link Brandingを設定するドメイン名. Example: example.com |
subdomain | Yes | string | Link Brandingを設定するサブドメイン名. Example: mail |
default | No | boolean | 送信者のドメインがLink Brandingのドメインと一致しない場合に、このドメインをデフォルトとして使用するか否かを指定します. Example: true |
Request
1
|
|
1 2 3 4 5 |
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
Retrieve a branded link [GET]
Link Brandingの取得URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
ID | Yes | integer | Link BrandingのID Example: 1234 |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
Update a branded link [PATCH]
Link Brandingの更新URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
ID | Yes | integer | Link BrandingのID Example: 1234 |
Request
1
|
|
1 2 3 |
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
Delete a branded link [DELETE]
Link Brandingの削除URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
ID | Yes | integer | Link BrandingのID Example: 1234 |
Request
1
|
|
Response
1
|
|
- "default"としてマークされた確認(validated)済みのLink Branding
- レガシーLink Whitelabel(旧Whitelabel Wizardで作成されたもの)
- SendGridのデフォルトLink Branding(i.e. 100.ct.sendgrid.net)
Retrieve the default branded link [GET]
デフォルトのLink Brandingの取得URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain | No | string | Link Brandingのドメインにマッチする送信者ドメイン. |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
Validate a branded link [POST]
Link Brandingの確認Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
|
Request
1
|
|
Response
1 2 3 4 5 6 7 8 |
|
Retrieve a subuser's branded link [GET]
関連するLink Brandingの一覧取得URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
username | Yes | string | Link Brandingが割り当てられているサブユーザのユーザ名. |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
Disassociate a branded link from a subuser [DELETE]
Link Brandingのサブユーザへの割り当て解除URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
username | Yes | string | Link Brandingが割り当てられているサブユーザのユーザ名. |
Request
1
|
|
Response
1
|
|
Associate a branded link with a subuser [POST]
Link Brandingのサブユーザへの割り当てURI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
link_id | Yes | string | サブユーザに割り当てるLink BrandingのID |
Body引数 | 必須 | 条件 | 説明 |
---|---|---|---|
username | Yes | string | Link Brandingと関連付けるサブユーザのユーザ名. Example: janeexampexample@example.com |
Request
1
|
|
1 2 3 |
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|