Convert a lead

Writes the lead into an account, a contact and an opportunity in one step. Needs all three objects available, and refuses a caller whose field access is narrowed anywhere.

POST/api/v1/objects/{objectId}/records/{recordId}/actions/convert

認証

AuthorizationOAuth2 アクセストークン · header必須

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

スコープ:api.access

パスパラメーター

objectIdstring必須

An object's id

最小長 1 · 最大長 255

recordIdstring必須

A record's id

最小長 1 · 最大長 255

ヘッダーパラメーター

Idempotency-Keystring必須

Replays the first answer for a repeated request

最小長 8 · 最大長 128

リクエストボディ

必須application/json

accountobject必須

プロパティを表示

idstring

最小長 1 · 最大長 255

modestring必須

許可される値:newexisting

namestring

最小長 1 · 最大長 500

acknowledgedMatchesboolean

デフォルト: false

contactobject必須

プロパティを表示

firstNamestring

最大長 200

idstring

最小長 1 · 最大長 255

lastNamestring

最小長 1 · 最大長 200

modestring必須

許可される値:newexistingskip

opportunityobject必須

プロパティを表示

amountstring

^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致

closeDatestring<date>

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ に一致

createboolean

デフォルト: false

namestring

最小長 1 · 最大長 500

stagestring

デフォルト: "01-商談見極め"

許可される値:01-商談見極め02-課題の合意03-担当者合意04-決裁者合意05-価格とスケジュール合意06-契約手続き中07-ペンディング（事務手続きのやり取り）08-受注09-失注

レスポンス

201

The records the conversion wrote

accountIdstring必須

最小長 1 · 最大長 255

contactIdstring | null必須

プロパティを表示

いずれか:

string

string

null

null

opportunityIdstring | null必須

プロパティを表示

いずれか:

string

string

null

null

unmappedstring[]必須

400

The request body, query or parameters were refused

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

401

The access token is missing, invalid or revoked

errorstring必須

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

404

No such record, or none the caller may read

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

409

The operation conflicts with the current state

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X POST '/api/v1/api/v1/objects/string/records/string/actions/convert' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "account": {
    "id": "string",
    "mode": "new",
    "name": "string"
  },
  "acknowledgedMatches": false,
  "contact": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "mode": "new"
  },
  "opportunity": {
    "amount": "string",
    "closeDate": "2019-08-24",
    "create": false,
    "name": "string",
    "stage": "01-商談見極め"
  }
}'

const response = await fetch("/api/v1/api/v1/objects/string/records/string/actions/convert", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"account\": {\n    \"id\": \"string\",\n    \"mode\": \"new\",\n    \"name\": \"string\"\n  },\n  \"acknowledgedMatches\": false,\n  \"contact\": {\n    \"firstName\": \"string\",\n    \"id\": \"string\",\n    \"lastName\": \"string\",\n    \"mode\": \"new\"\n  },\n  \"opportunity\": {\n    \"amount\": \"string\",\n    \"closeDate\": \"2019-08-24\",\n    \"create\": false,\n    \"name\": \"string\",\n    \"stage\": \"01-商談見極め\"\n  }\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/objects/string/records/string/actions/convert",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"account\": {\n    \"id\": \"string\",\n    \"mode\": \"new\",\n    \"name\": \"string\"\n  },\n  \"acknowledgedMatches\": false,\n  \"contact\": {\n    \"firstName\": \"string\",\n    \"id\": \"string\",\n    \"lastName\": \"string\",\n    \"mode\": \"new\"\n  },\n  \"opportunity\": {\n    \"amount\": \"string\",\n    \"closeDate\": \"2019-08-24\",\n    \"create\": false,\n    \"name\": \"string\",\n    \"stage\": \"01-商談見極め\"\n  }\n}",
)

レスポンス

{
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "unmapped": [
    "string"
  ]
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}