API reference › Handshakes

Save selected qualifications

POST /v1/handshakes/{id}/qualifications

Scope
handshakes:edit
Roles
admin, scheduler

Records which service type and provider type combinations the organization has chosen. These are imported onto the provider when the handshake completes.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Handshake ID.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
qualificationsarray of object
qualifications[].serviceTypeIdstring
qualifications[].serviceProviderTypeIdstring

Example

JSON
{
  "qualifications": [
    {
      "serviceTypeId": "string",
      "serviceProviderTypeId": "string"
    }
  ]
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/handshakes/{id}/qualifications" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"qualifications":[{"serviceTypeId":"string","serviceProviderTypeId":"string"}]}'

Try it

Responses

200 Qualifications saved successfully

Qualifications saved successfully.

JSON
{
  "success": true,
  "message": "Qualifications saved successfully.",
  "data": {
    "id": "HSK-4KQ2PA",
    "assignmentId": "ASG-SA2IVL",
    "serviceProviderId": "SPR-H6OUI3",
    "status": "offer_sent",
    "statusLabel": "Offer Sent",
    "rates": [
      {}
    ],
    "singleRates": [
      {}
    ],
    "messages": [
      {}
    ],
    "invitedAt": "string",
    "interestedAt": "string",
    "offerSentAt": "string",
    "acceptedAt": "string",
    "declinedAt": "string",
    "declinedBy": "organization",
    "declineReason": "string",
    "invitedByUserId": "USR-9WE3TK",
    "createdAt": "string"
  }
}
Response fields (20)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Qualifications saved successfully..

dataobject
data.idstring

Example HSK-4KQ2PA.

data.assignmentIdstring

Example ASG-SA2IVL.

data.serviceProviderIdstring

Example SPR-H6OUI3.

data.statusstring

Example offer_sent.

data.statusLabelstring

Example Offer Sent.

data.ratesarray of object

Negotiated rate rows as stored on the handshake.

data.singleRatesarray of object

Negotiated single-rate rows as stored on the handshake.

data.messagesarray of object

Message history on the handshake.

data.invitedAtstring (date-time) or null
data.interestedAtstring (date-time) or null
data.offerSentAtstring (date-time) or null
data.acceptedAtstring (date-time) or null
data.declinedAtstring (date-time) or null
data.declinedBystring or null

Example organization.

data.declineReasonstring or null
data.invitedByUserIdstring or null

Example USR-9WE3TK.

data.createdAtstring (date-time) or null
401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.